Amazonka.APIGateway.Types.DocumentationPart

Documentation

data DocumentationPart

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

FromJSON DocumentationPart

Defined in Amazonka.APIGateway.Types.DocumentationPart

Methods

parseJSON :: Value -> Parser DocumentationPart

parseJSONList :: Value -> Parser [DocumentationPart]

Generic DocumentationPart

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

Defined in Amazonka.APIGateway.Types.DocumentationPart

Methods

readsPrec :: Int -> ReadS DocumentationPart

readList :: ReadS [DocumentationPart]

readPrec :: ReadPrec DocumentationPart

readListPrec :: ReadPrec [DocumentationPart]

Show DocumentationPart

Defined in Amazonka.APIGateway.Types.DocumentationPart

Methods

showsPrec :: Int -> DocumentationPart -> ShowS

show :: DocumentationPart -> String

showList :: [DocumentationPart] -> ShowS

NFData DocumentationPart

Defined in Amazonka.APIGateway.Types.DocumentationPart

Methods

rnf :: DocumentationPart -> ()

Eq DocumentationPart

Defined in Amazonka.APIGateway.Types.DocumentationPart

Methods

(==) :: DocumentationPart -> DocumentationPart -> Bool

(/=) :: DocumentationPart -> DocumentationPart -> Bool

Hashable DocumentationPart

Defined in Amazonka.APIGateway.Types.DocumentationPart

Methods

hashWithSalt :: Int -> DocumentationPart -> Int

hash :: DocumentationPart -> Int

type Rep DocumentationPart

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

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.

documentationPart_id :: Lens' DocumentationPart (Maybe Text)

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

documentationPart_location :: Lens' DocumentationPart (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.

documentationPart_properties :: Lens' DocumentationPart (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.