amazonka-apigateway-1.4.5: Amazon API Gateway SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.APIGateway.CreateDocumentationPart

Contents

Description

Undocumented operation.

Synopsis

Creating a Request

createDocumentationPart #

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

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

  • cdpRestAPIId - [Required] The identifier of an API of the to-be-created documentation part.
  • cdpLocation - [Required] The location of the targeted API entity of the to-be-created documentation part.
  • cdpProperties - [Required] The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only Swagger-compliant key-value pairs can be exported and, hence, published.

data CreateDocumentationPart #

Creates a new documentation part of a given API.

See: createDocumentationPart smart constructor.

Instances

Eq CreateDocumentationPart # 
Data CreateDocumentationPart # 

Methods

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

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

toConstr :: CreateDocumentationPart -> Constr #

dataTypeOf :: CreateDocumentationPart -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> CreateDocumentationPart -> CreateDocumentationPart #

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

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

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

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

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

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

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

Read CreateDocumentationPart # 
Show CreateDocumentationPart # 
Generic CreateDocumentationPart # 
Hashable CreateDocumentationPart # 
ToJSON CreateDocumentationPart # 
NFData CreateDocumentationPart # 

Methods

rnf :: CreateDocumentationPart -> () #

AWSRequest CreateDocumentationPart # 
ToQuery CreateDocumentationPart # 
ToPath CreateDocumentationPart # 
ToHeaders CreateDocumentationPart # 
type Rep CreateDocumentationPart # 
type Rep CreateDocumentationPart = D1 (MetaData "CreateDocumentationPart" "Network.AWS.APIGateway.CreateDocumentationPart" "amazonka-apigateway-1.4.5-5OCToOwmZjEH3FMiU9Yogu" False) (C1 (MetaCons "CreateDocumentationPart'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_cdpRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_cdpLocation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 DocumentationPartLocation)) (S1 (MetaSel (Just Symbol "_cdpProperties") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs CreateDocumentationPart # 

Request Lenses

cdpRestAPIId :: Lens' CreateDocumentationPart Text #

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

cdpLocation :: Lens' CreateDocumentationPart DocumentationPartLocation #

Required
The location of the targeted API entity of the to-be-created documentation part.

cdpProperties :: Lens' CreateDocumentationPart Text #

Required
The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only Swagger-compliant key-value pairs can be exported and, hence, published.

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 # 
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 # 
Show DocumentationPart # 
Generic DocumentationPart # 
Hashable DocumentationPart # 
FromJSON 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-5OCToOwmZjEH3FMiU9Yogu" 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 .