libZSservicesZSamazonka-apigatewayZSamazonka-apigateway
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.APIGateway.GetDocumentationPart

Description

  • - | Undocumented operation.
Synopsis

Creating a Request

data GetDocumentationPart Source #

Gets a specified documentation part of a given API.

See: newGetDocumentationPart smart constructor.

Constructors

GetDocumentationPart' 

Fields

Instances

Instances details
Eq GetDocumentationPart Source # 
Instance details

Defined in Amazonka.APIGateway.GetDocumentationPart

Read GetDocumentationPart Source # 
Instance details

Defined in Amazonka.APIGateway.GetDocumentationPart

Show GetDocumentationPart Source # 
Instance details

Defined in Amazonka.APIGateway.GetDocumentationPart

Generic GetDocumentationPart Source # 
Instance details

Defined in Amazonka.APIGateway.GetDocumentationPart

Associated Types

type Rep GetDocumentationPart :: Type -> Type #

NFData GetDocumentationPart Source # 
Instance details

Defined in Amazonka.APIGateway.GetDocumentationPart

Methods

rnf :: GetDocumentationPart -> () #

Hashable GetDocumentationPart Source # 
Instance details

Defined in Amazonka.APIGateway.GetDocumentationPart

AWSRequest GetDocumentationPart Source # 
Instance details

Defined in Amazonka.APIGateway.GetDocumentationPart

Associated Types

type AWSResponse GetDocumentationPart #

ToHeaders GetDocumentationPart Source # 
Instance details

Defined in Amazonka.APIGateway.GetDocumentationPart

ToPath GetDocumentationPart Source # 
Instance details

Defined in Amazonka.APIGateway.GetDocumentationPart

ToQuery GetDocumentationPart Source # 
Instance details

Defined in Amazonka.APIGateway.GetDocumentationPart

type Rep GetDocumentationPart Source # 
Instance details

Defined in Amazonka.APIGateway.GetDocumentationPart

type Rep GetDocumentationPart = D1 ('MetaData "GetDocumentationPart" "Amazonka.APIGateway.GetDocumentationPart" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "GetDocumentationPart'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "documentationPartId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetDocumentationPart Source # 
Instance details

Defined in Amazonka.APIGateway.GetDocumentationPart

newGetDocumentationPart Source #

Create a value of GetDocumentationPart with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:restApiId:GetDocumentationPart', getDocumentationPart_restApiId - [Required] The string identifier of the associated RestApi.

$sel:documentationPartId:GetDocumentationPart', getDocumentationPart_documentationPartId - [Required] The string identifier of the associated RestApi.

Request Lenses

getDocumentationPart_restApiId :: Lens' GetDocumentationPart Text Source #

Required
The string identifier of the associated RestApi.

getDocumentationPart_documentationPartId :: Lens' GetDocumentationPart Text Source #

Required
The string identifier of the associated RestApi.

Destructuring the Response

data DocumentationPart Source #

A documentation part for a targeted API entity.

A documentation part consists of a content map (properties) and a target (location). The target specifies an API entity to which the documentation content applies. The supported API entity types are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Valid location fields depend on the API entity type. All valid fields are not required.

The content map is a JSON string of API-specific key-value pairs. Although an API can use any shape for the content map, only the OpenAPI-compliant documentation fields will be injected into the associated API entity definition in the exported OpenAPI definition file.

Documenting an API, DocumentationParts

See: newDocumentationPart smart constructor.

Constructors

DocumentationPart' 

Fields

  • location :: Maybe DocumentationPartLocation

    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.

  • id :: Maybe Text

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

  • properties :: Maybe Text

    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.

Instances

Instances details
Eq DocumentationPart Source # 
Instance details

Defined in Amazonka.APIGateway.Types.DocumentationPart

Read DocumentationPart Source # 
Instance details

Defined in Amazonka.APIGateway.Types.DocumentationPart

Show DocumentationPart Source # 
Instance details

Defined in Amazonka.APIGateway.Types.DocumentationPart

Generic DocumentationPart Source # 
Instance details

Defined in Amazonka.APIGateway.Types.DocumentationPart

Associated Types

type Rep DocumentationPart :: Type -> Type #

NFData DocumentationPart Source # 
Instance details

Defined in Amazonka.APIGateway.Types.DocumentationPart

Methods

rnf :: DocumentationPart -> () #

Hashable DocumentationPart Source # 
Instance details

Defined in Amazonka.APIGateway.Types.DocumentationPart

FromJSON DocumentationPart Source # 
Instance details

Defined in Amazonka.APIGateway.Types.DocumentationPart

type Rep DocumentationPart Source # 
Instance details

Defined in Amazonka.APIGateway.Types.DocumentationPart

type Rep DocumentationPart = D1 ('MetaData "DocumentationPart" "Amazonka.APIGateway.Types.DocumentationPart" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "DocumentationPart'" 'PrefixI 'True) (S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentationPartLocation)) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "properties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDocumentationPart :: DocumentationPart Source #

Create a value of DocumentationPart with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:location:DocumentationPart', documentationPart_location - 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.

$sel:id:DocumentationPart', documentationPart_id - The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

$sel:properties:DocumentationPart', documentationPart_properties - 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.

Response Lenses

documentationPart_location :: Lens' DocumentationPart (Maybe DocumentationPartLocation) Source #

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.

documentationPart_id :: Lens' DocumentationPart (Maybe Text) Source #

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

documentationPart_properties :: Lens' DocumentationPart (Maybe Text) Source #

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.