Network.AWS.APIGateway.GetDocumentationPart

Undocumented operation.

Creating a Request

getDocumentationPart

Arguments

:: Text

getRestAPIId

-> Text

getDocumentationPartId

-> GetDocumentationPart

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

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

• getRestAPIId - [Required] The string identifier of the associated RestApi .
• getDocumentationPartId - [Required] The string identifier of the associated RestApi .

data GetDocumentationPart

Gets a specified documentation part of a given API.

See: getDocumentationPart smart constructor.

Instances

Eq GetDocumentationPart

Methods

(==) :: GetDocumentationPart -> GetDocumentationPart -> Bool

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

Data GetDocumentationPart

Methods

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

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

toConstr :: GetDocumentationPart -> Constr

dataTypeOf :: GetDocumentationPart -> DataType

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

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

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

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

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

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

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

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

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

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

Read GetDocumentationPart

Methods

readsPrec :: Int -> ReadS GetDocumentationPart

readList :: ReadS [GetDocumentationPart]

readPrec :: ReadPrec GetDocumentationPart

readListPrec :: ReadPrec [GetDocumentationPart]

Show GetDocumentationPart

Methods

showsPrec :: Int -> GetDocumentationPart -> ShowS

show :: GetDocumentationPart -> String

showList :: [GetDocumentationPart] -> ShowS

Generic GetDocumentationPart

Associated Types

type Rep GetDocumentationPart :: * -> *

Methods

from :: GetDocumentationPart -> Rep GetDocumentationPart x

to :: Rep GetDocumentationPart x -> GetDocumentationPart

Hashable GetDocumentationPart

Methods

hashWithSalt :: Int -> GetDocumentationPart -> Int

hash :: GetDocumentationPart -> Int

NFData GetDocumentationPart

Methods

rnf :: GetDocumentationPart -> ()

AWSRequest GetDocumentationPart

Associated Types

type Rs GetDocumentationPart :: *

Methods

request :: GetDocumentationPart -> Request GetDocumentationPart

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

ToQuery GetDocumentationPart

Methods

toQuery :: GetDocumentationPart -> QueryString

ToPath GetDocumentationPart

Methods

toPath :: GetDocumentationPart -> ByteString

ToHeaders GetDocumentationPart

Methods

toHeaders :: GetDocumentationPart -> [Header]

type Rep GetDocumentationPart

type Rep GetDocumentationPart = D1 (MetaData "GetDocumentationPart" "Network.AWS.APIGateway.GetDocumentationPart" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "GetDocumentationPart'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_getRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_getDocumentationPartId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs GetDocumentationPart

type Rs GetDocumentationPart = DocumentationPart

Request Lenses

getRestAPIId :: Lens' GetDocumentationPart Text

Required

The string identifier of the associated RestApi .

getDocumentationPartId :: Lens' GetDocumentationPart Text

Required

The string identifier of the associated RestApi .

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.5.0-3jDq4KKltGt78uikPpOCEJ" 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 .