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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates a documentation part.

Synopsis

data UpdateDocumentationPart = UpdateDocumentationPart' {
- patchOperations :: Maybe [PatchOperation]
- restApiId :: Text
- documentationPartId :: Text
}
newUpdateDocumentationPart :: Text -> Text -> UpdateDocumentationPart
updateDocumentationPart_patchOperations :: Lens' UpdateDocumentationPart (Maybe [PatchOperation])
updateDocumentationPart_restApiId :: Lens' UpdateDocumentationPart Text
updateDocumentationPart_documentationPartId :: Lens' UpdateDocumentationPart Text
data DocumentationPart = DocumentationPart' {
- id :: Maybe Text
- location :: Maybe DocumentationPartLocation
- properties :: Maybe Text
}
newDocumentationPart :: DocumentationPart
documentationPart_id :: Lens' DocumentationPart (Maybe Text)
documentationPart_location :: Lens' DocumentationPart (Maybe DocumentationPartLocation)
documentationPart_properties :: Lens' DocumentationPart (Maybe Text)

Creating a Request

data UpdateDocumentationPart Source #

Updates an existing documentation part of a given API.

See: newUpdateDocumentationPart smart constructor.

Constructors

UpdateDocumentationPart'
Fields patchOperations :: Maybe [PatchOperation] For more information about supported patch operations, see Patch Operations. restApiId :: Text The string identifier of the associated RestApi. documentationPartId :: Text The identifier of the to-be-updated documentation part.

Instances

Instances details

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

newUpdateDocumentationPart Source #

Arguments

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

Create a value of UpdateDocumentationPart 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:patchOperations:UpdateDocumentationPart', updateDocumentationPart_patchOperations - For more information about supported patch operations, see Patch Operations.

UpdateDocumentationPart, updateDocumentationPart_restApiId - The string identifier of the associated RestApi.

$sel:documentationPartId:UpdateDocumentationPart', updateDocumentationPart_documentationPartId - The identifier of the to-be-updated documentation part.

Request Lenses

updateDocumentationPart_patchOperations :: Lens' UpdateDocumentationPart (Maybe [PatchOperation]) Source #

For more information about supported patch operations, see Patch Operations.

updateDocumentationPart_restApiId :: Lens' UpdateDocumentationPart Text Source #

The string identifier of the associated RestApi.

updateDocumentationPart_documentationPartId :: Lens' UpdateDocumentationPart Text Source #

The identifier of the to-be-updated documentation part.

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.