class Amazonite::ApiGateway::ImportDocumentationPartsRequest

Overview

Import documentation parts from an external (e.g., OpenAPI) definition file.

Included Modules

Defined in:

api_gateway/import_documentation_parts_request.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(rest_api_id : String, body : String, mode : PutMode | Nil = nil, fail_on_warnings : Bool | Nil = nil) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def body : String #

Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.


[View source]
def body=(body : String) #

Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.


[View source]
def fail_on_warnings : Bool | Nil #

A query parameter to specify whether to rollback the documentation importation (true) or not (false) when a warning is encountered. The default value is false.


[View source]
def fail_on_warnings=(fail_on_warnings : Bool | Nil) #

A query parameter to specify whether to rollback the documentation importation (true) or not (false) when a warning is encountered. The default value is false.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def mode : PutMode | Nil #

A query parameter to indicate whether to overwrite (overwrite) any existing DocumentationParts definition or to merge (merge) the new definition into the existing one. The default value is merge.


[View source]
def mode=(mode : PutMode | Nil) #

A query parameter to indicate whether to overwrite (overwrite) any existing DocumentationParts definition or to merge (merge) the new definition into the existing one. The default value is merge.


[View source]
def rest_api_id : String #

The string identifier of the associated RestApi.


[View source]
def rest_api_id=(rest_api_id : String) #

The string identifier of the associated RestApi.


[View source]
def validate! : Nil #

[View source]