Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.APIGateway.GetDocumentationPart

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a documentation part.

Creating a Request

data GetDocumentationPart Source #

Gets a specified documentation part of a given API.

See: newGetDocumentationPart smart constructor.

Constructors

GetDocumentationPart'
Fields restApiId :: Text The string identifier of the associated RestApi. documentationPartId :: Text The string identifier of the associated RestApi.

Instances

Instances details

ToHeaders GetDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationPart Methods toHeaders :: GetDocumentationPart -> [Header] #
ToPath GetDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationPart Methods toPath :: GetDocumentationPart -> ByteString #
ToQuery GetDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationPart Methods toQuery :: GetDocumentationPart -> QueryString #
AWSRequest GetDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationPart Associated Types type AWSResponse GetDocumentationPart # Methods request :: (Service -> Service) -> GetDocumentationPart -> Request GetDocumentationPart # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetDocumentationPart -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDocumentationPart))) #
Generic GetDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationPart Associated Types type Rep GetDocumentationPart :: Type -> Type # Methods from :: GetDocumentationPart -> Rep GetDocumentationPart x # to :: Rep GetDocumentationPart x -> GetDocumentationPart #
Read GetDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationPart Methods readsPrec :: Int -> ReadS GetDocumentationPart # readList :: ReadS [GetDocumentationPart] # readPrec :: ReadPrec GetDocumentationPart # readListPrec :: ReadPrec [GetDocumentationPart] #
Show GetDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationPart Methods showsPrec :: Int -> GetDocumentationPart -> ShowS # show :: GetDocumentationPart -> String # showList :: [GetDocumentationPart] -> ShowS #
NFData GetDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationPart Methods rnf :: GetDocumentationPart -> () #
Eq GetDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationPart Methods (==) :: GetDocumentationPart -> GetDocumentationPart -> Bool # (/=) :: GetDocumentationPart -> GetDocumentationPart -> Bool #
Hashable GetDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationPart Methods hashWithSalt :: Int -> GetDocumentationPart -> Int # hash :: GetDocumentationPart -> Int #
type AWSResponse GetDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationPart type AWSResponse GetDocumentationPart = DocumentationPart
type Rep GetDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationPart type Rep GetDocumentationPart = D1 ('MetaData "GetDocumentationPart" "Amazonka.APIGateway.GetDocumentationPart" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetDocumentationPart'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "documentationPartId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetDocumentationPart Source #

Arguments

:: Text	`GetDocumentationPart`
-> Text	`$sel:documentationPartId:GetDocumentationPart'`
-> GetDocumentationPart

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:

GetDocumentationPart, getDocumentationPart_restApiId - The string identifier of the associated RestApi.

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

Request Lenses

getDocumentationPart_restApiId :: Lens' GetDocumentationPart Text Source #

The string identifier of the associated RestApi.

getDocumentationPart_documentationPartId :: Lens' GetDocumentationPart Text Source #

The string identifier of the associated RestApi.

Destructuring the Response

data DocumentationPart Source #

A documentation part for a targeted API entity.

See: newDocumentationPart smart constructor.

Constructors

DocumentationPart'

Fields

id :: Maybe Text
The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.
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.
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

FromJSON DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Methods parseJSON :: Value -> Parser DocumentationPart # parseJSONList :: Value -> Parser [DocumentationPart] #
Generic DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Associated Types type Rep DocumentationPart :: Type -> Type # Methods from :: DocumentationPart -> Rep DocumentationPart x # to :: Rep DocumentationPart x -> DocumentationPart #
Read DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Methods readsPrec :: Int -> ReadS DocumentationPart # readList :: ReadS [DocumentationPart] # readPrec :: ReadPrec DocumentationPart # readListPrec :: ReadPrec [DocumentationPart] #
Show DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Methods showsPrec :: Int -> DocumentationPart -> ShowS # show :: DocumentationPart -> String # showList :: [DocumentationPart] -> ShowS #
NFData DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Methods rnf :: DocumentationPart -> () #
Eq DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Methods (==) :: DocumentationPart -> DocumentationPart -> Bool # (/=) :: DocumentationPart -> DocumentationPart -> Bool #
Hashable DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Methods hashWithSalt :: Int -> DocumentationPart -> Int # hash :: DocumentationPart -> Int #
type Rep DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart type Rep DocumentationPart = D1 ('MetaData "DocumentationPart" "Amazonka.APIGateway.Types.DocumentationPart" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DocumentationPart'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentationPartLocation)) :: 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:id:DocumentationPart', documentationPart_id - The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

$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: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_id :: Lens' DocumentationPart (Maybe Text) Source #

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

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_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.