Copyright | (c) 2013-2017 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Undocumented operation.
- getDocumentationParts :: Text -> GetDocumentationParts
- data GetDocumentationParts
- gdpPath :: Lens' GetDocumentationParts (Maybe Text)
- gdpNameQuery :: Lens' GetDocumentationParts (Maybe Text)
- gdpLimit :: Lens' GetDocumentationParts (Maybe Int)
- gdpType :: Lens' GetDocumentationParts (Maybe DocumentationPartType)
- gdpPosition :: Lens' GetDocumentationParts (Maybe Text)
- gdpRestAPIId :: Lens' GetDocumentationParts Text
- getDocumentationPartsResponse :: Int -> GetDocumentationPartsResponse
- data GetDocumentationPartsResponse
- gdprsItems :: Lens' GetDocumentationPartsResponse [DocumentationPart]
- gdprsPosition :: Lens' GetDocumentationPartsResponse (Maybe Text)
- gdprsResponseStatus :: Lens' GetDocumentationPartsResponse Int
Creating a Request
getDocumentationParts Source #
Creates a value of GetDocumentationParts
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gdpPath
- The path of API entities of the to-be-retrieved documentation parts.gdpNameQuery
- The name of API entities of the to-be-retrieved documentation parts.gdpLimit
- The maximum number of returned results per page.gdpType
- The type of API entities of the to-be-retrieved documentation parts.gdpPosition
- The current pagination position in the paged result set.gdpRestAPIId
- [Required] The string identifier of the associatedRestApi
.
data GetDocumentationParts Source #
Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).
See: getDocumentationParts
smart constructor.
Request Lenses
gdpPath :: Lens' GetDocumentationParts (Maybe Text) Source #
The path of API entities of the to-be-retrieved documentation parts.
gdpNameQuery :: Lens' GetDocumentationParts (Maybe Text) Source #
The name of API entities of the to-be-retrieved documentation parts.
gdpLimit :: Lens' GetDocumentationParts (Maybe Int) Source #
The maximum number of returned results per page.
gdpType :: Lens' GetDocumentationParts (Maybe DocumentationPartType) Source #
The type of API entities of the to-be-retrieved documentation parts.
gdpPosition :: Lens' GetDocumentationParts (Maybe Text) Source #
The current pagination position in the paged result set.
gdpRestAPIId :: Lens' GetDocumentationParts Text Source #
- Required
- The string identifier of the associated
RestApi
.
Destructuring the Response
getDocumentationPartsResponse Source #
Creates a value of GetDocumentationPartsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gdprsItems
- The current page of elements from this collection.gdprsPosition
- Undocumented member.gdprsResponseStatus
- -- | The response status code.
data GetDocumentationPartsResponse Source #
The collection of documentation parts of an API.
Documenting an API , DocumentationPart
See: getDocumentationPartsResponse
smart constructor.
Response Lenses
gdprsItems :: Lens' GetDocumentationPartsResponse [DocumentationPart] Source #
The current page of elements from this collection.
gdprsPosition :: Lens' GetDocumentationPartsResponse (Maybe Text) Source #
Undocumented member.
gdprsResponseStatus :: Lens' GetDocumentationPartsResponse Int Source #
- - | The response status code.