class Amazonite::ApiGateway::GetDocumentationPartsRequest

• Amazonite::ApiGateway::GetDocumentationPartsRequest
• Reference
• Object

Overview

Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).

Included Modules

• JSON::Serializable

Defined in:

api_gateway/get_documentation_parts_request.cr

Constructors

• .new(pull : JSON::PullParser)
• .new(rest_api_id : String, type : DocumentationPartType | Nil = nil, name_query : String | Nil = nil, path : String | Nil = nil, position : String | Nil = nil, limit : Int32 | Nil = nil, location_status : LocationStatusType | Nil = nil)
• .new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance Method Summary

• #==(other : self)

  Returns true if this reference is the same as other.

• #hash(hasher)

  See Object#hash(hasher)

• #limit : Int32 | Nil

  The maximum number of returned results per page.

• #limit=(limit : Int32 | Nil)

  The maximum number of returned results per page.

• #location_status : LocationStatusType | Nil

  The status of the API documentation parts to retrieve.

• #location_status=(location_status : LocationStatusType | Nil)

  The status of the API documentation parts to retrieve.

• #name_query : String | Nil

  The name of API entities of the to-be-retrieved documentation parts.

• #name_query=(name_query : String | Nil)

  The name of API entities of the to-be-retrieved documentation parts.

• #path : String | Nil

  The path of API entities of the to-be-retrieved documentation parts.

• #path=(path : String | Nil)

  The path of API entities of the to-be-retrieved documentation parts.

• #position : String | Nil

  The current pagination position in the paged result set.

• #position=(position : String | Nil)

  The current pagination position in the paged result set.

• #rest_api_id : String

  The string identifier of the associated RestApi.

• #rest_api_id=(rest_api_id : String)

  The string identifier of the associated RestApi.

• #type : DocumentationPartType | Nil

  The type of API entities of the to-be-retrieved documentation parts.

• #type=(type : DocumentationPartType | Nil)

  The type of API entities of the to-be-retrieved documentation parts.

• #validate! : Nil

Constructor Detail

Instance Method Detail