class Amazonite::ApiGateway::DocumentationPart

Overview

A documentation part for a targeted API entity.

Included Modules

Defined in:

api_gateway/documentation_part.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(id : String | Nil = nil, location : DocumentationPartLocation | Nil = nil, properties : String | Nil = nil) #

[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 hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def id : String | Nil #

The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.


[View source]
def id=(id : String | Nil) #

The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.


[View source]
def location : DocumentationPartLocation | Nil #

The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.


[View source]
def location=(location : DocumentationPartLocation | Nil) #

The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.


[View source]
def properties : String | Nil #

A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.


[View source]
def properties=(properties : String | Nil) #

A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.


[View source]
def validate! : Nil #

[View source]