Network.AWS.APIGateway.UpdateDocumentationPart

Undocumented operation.

Creating a Request

updateDocumentationPart

Arguments

:: Text

udpRestAPIId

-> Text

udpDocumentationPartId

-> UpdateDocumentationPart

Creates a value of UpdateDocumentationPart with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• udpPatchOperations - A list of update operations to be applied to the specified resource and in the order specified in this list.
• udpRestAPIId - [Required] The identifier of an API of the to-be-updated documentation part.
• udpDocumentationPartId - [Required] The identifier of the to-be-updated documentation part.

data UpdateDocumentationPart

Updates an existing documentation part of a given API.

See: updateDocumentationPart smart constructor.

Instances

Eq UpdateDocumentationPart

Methods

(==) :: UpdateDocumentationPart -> UpdateDocumentationPart -> Bool

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

Data UpdateDocumentationPart

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateDocumentationPart -> c UpdateDocumentationPart

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateDocumentationPart

toConstr :: UpdateDocumentationPart -> Constr

dataTypeOf :: UpdateDocumentationPart -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateDocumentationPart)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateDocumentationPart)

gmapT :: (forall b. Data b => b -> b) -> UpdateDocumentationPart -> UpdateDocumentationPart

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateDocumentationPart -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateDocumentationPart -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateDocumentationPart -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateDocumentationPart -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateDocumentationPart -> m UpdateDocumentationPart

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateDocumentationPart -> m UpdateDocumentationPart

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateDocumentationPart -> m UpdateDocumentationPart

Read UpdateDocumentationPart

Methods

readsPrec :: Int -> ReadS UpdateDocumentationPart

readList :: ReadS [UpdateDocumentationPart]

readPrec :: ReadPrec UpdateDocumentationPart

readListPrec :: ReadPrec [UpdateDocumentationPart]

Show UpdateDocumentationPart

Methods

showsPrec :: Int -> UpdateDocumentationPart -> ShowS

show :: UpdateDocumentationPart -> String

showList :: [UpdateDocumentationPart] -> ShowS

Generic UpdateDocumentationPart

Associated Types

type Rep UpdateDocumentationPart :: * -> *

Methods

from :: UpdateDocumentationPart -> Rep UpdateDocumentationPart x

to :: Rep UpdateDocumentationPart x -> UpdateDocumentationPart

Hashable UpdateDocumentationPart

Methods

hashWithSalt :: Int -> UpdateDocumentationPart -> Int

hash :: UpdateDocumentationPart -> Int

ToJSON UpdateDocumentationPart

Methods

toJSON :: UpdateDocumentationPart -> Value

toEncoding :: UpdateDocumentationPart -> Encoding

toJSONList :: [UpdateDocumentationPart] -> Value

toEncodingList :: [UpdateDocumentationPart] -> Encoding

NFData UpdateDocumentationPart

Methods

rnf :: UpdateDocumentationPart -> ()

AWSRequest UpdateDocumentationPart

Associated Types

type Rs UpdateDocumentationPart :: *

Methods

request :: UpdateDocumentationPart -> Request UpdateDocumentationPart

response :: MonadResource m => Logger -> Service -> Proxy * UpdateDocumentationPart -> ClientResponse -> m (Response UpdateDocumentationPart)

ToPath UpdateDocumentationPart

Methods

toPath :: UpdateDocumentationPart -> ByteString

ToHeaders UpdateDocumentationPart

Methods

toHeaders :: UpdateDocumentationPart -> [Header]

ToQuery UpdateDocumentationPart

Methods

toQuery :: UpdateDocumentationPart -> QueryString

type Rep UpdateDocumentationPart

type Rep UpdateDocumentationPart = D1 (MetaData "UpdateDocumentationPart" "Network.AWS.APIGateway.UpdateDocumentationPart" "amazonka-apigateway-1.4.5-BIK2fycuXdJFBbWQ9Hqf16" False) (C1 (MetaCons "UpdateDocumentationPart'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_udpPatchOperations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [PatchOperation]))) ((:*:) (S1 (MetaSel (Just Symbol "_udpRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_udpDocumentationPartId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs UpdateDocumentationPart

type Rs UpdateDocumentationPart = DocumentationPart

Request Lenses

udpPatchOperations :: Lens' UpdateDocumentationPart [PatchOperation]

A list of update operations to be applied to the specified resource and in the order specified in this list.

udpRestAPIId :: Lens' UpdateDocumentationPart Text

Required

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

udpDocumentationPartId :: Lens' UpdateDocumentationPart Text

Required

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

Destructuring the Response

documentationPart :: DocumentationPart

Creates a value of DocumentationPart with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dpLocation - 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.
• dpId - The DocumentationPart identifier, generated by Amazon API Gateway when the DocumentationPart is created.
• dpProperties - 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 Swagger-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 Swagger extension of x-amazon-apigateway-documentation .

data DocumentationPart

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 Swagger-compliant documentation fields will be injected into the associated API entity definition in the exported Swagger definition file.

Documenting an API , DocumentationParts

See: documentationPart smart constructor.

Instances

Eq DocumentationPart

Methods

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

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

Data DocumentationPart

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DocumentationPart -> c DocumentationPart

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DocumentationPart

toConstr :: DocumentationPart -> Constr

dataTypeOf :: DocumentationPart -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DocumentationPart)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DocumentationPart)

gmapT :: (forall b. Data b => b -> b) -> DocumentationPart -> DocumentationPart

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DocumentationPart -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DocumentationPart -> r

gmapQ :: (forall d. Data d => d -> u) -> DocumentationPart -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DocumentationPart -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DocumentationPart -> m DocumentationPart

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DocumentationPart -> m DocumentationPart

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DocumentationPart -> m DocumentationPart

Read DocumentationPart

Methods

readsPrec :: Int -> ReadS DocumentationPart

readList :: ReadS [DocumentationPart]

readPrec :: ReadPrec DocumentationPart

readListPrec :: ReadPrec [DocumentationPart]

Show DocumentationPart

Methods

showsPrec :: Int -> DocumentationPart -> ShowS

show :: DocumentationPart -> String

showList :: [DocumentationPart] -> ShowS

Generic DocumentationPart

Associated Types

type Rep DocumentationPart :: * -> *

Methods

from :: DocumentationPart -> Rep DocumentationPart x

to :: Rep DocumentationPart x -> DocumentationPart

Hashable DocumentationPart

Methods

hashWithSalt :: Int -> DocumentationPart -> Int

hash :: DocumentationPart -> Int

FromJSON DocumentationPart

Methods

parseJSON :: Value -> Parser DocumentationPart

parseJSONList :: Value -> Parser [DocumentationPart]

NFData DocumentationPart

Methods

rnf :: DocumentationPart -> ()

type Rep DocumentationPart

type Rep DocumentationPart = D1 (MetaData "DocumentationPart" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.5-BIK2fycuXdJFBbWQ9Hqf16" False) (C1 (MetaCons "DocumentationPart'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dpLocation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DocumentationPartLocation))) ((:*:) (S1 (MetaSel (Just Symbol "_dpId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dpProperties") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

Response Lenses

dpLocation :: 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.

dpId :: Lens' DocumentationPart (Maybe Text)

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

dpProperties :: 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 Swagger-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 Swagger extension of x-amazon-apigateway-documentation .