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 |
Synopsis
- data DocumentationPart = DocumentationPart' {}
- newDocumentationPart :: DocumentationPart
- documentationPart_id :: Lens' DocumentationPart (Maybe Text)
- documentationPart_location :: Lens' DocumentationPart (Maybe DocumentationPartLocation)
- documentationPart_properties :: Lens' DocumentationPart (Maybe Text)
Documentation
data DocumentationPart Source #
A documentation part for a targeted API entity.
See: newDocumentationPart
smart constructor.
DocumentationPart' | |
|
Instances
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
.
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
.