Copyright | (c) 2013-2018 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.
- getDocumentationVersions :: Text -> GetDocumentationVersions
- data GetDocumentationVersions
- gdvLimit :: Lens' GetDocumentationVersions (Maybe Int)
- gdvPosition :: Lens' GetDocumentationVersions (Maybe Text)
- gdvRestAPIId :: Lens' GetDocumentationVersions Text
- getDocumentationVersionsResponse :: Int -> GetDocumentationVersionsResponse
- data GetDocumentationVersionsResponse
- gdvrsItems :: Lens' GetDocumentationVersionsResponse [DocumentationVersion]
- gdvrsPosition :: Lens' GetDocumentationVersionsResponse (Maybe Text)
- gdvrsResponseStatus :: Lens' GetDocumentationVersionsResponse Int
Creating a Request
getDocumentationVersions Source #
Creates a value of GetDocumentationVersions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gdvLimit
- The maximum number of returned results per page. The default value is 25 and the maximum value is 500.gdvPosition
- The current pagination position in the paged result set.gdvRestAPIId
- [Required] The string identifier of the associatedRestApi
.
data GetDocumentationVersions Source #
Gets the documentation versions of an API.
See: getDocumentationVersions
smart constructor.
Request Lenses
gdvLimit :: Lens' GetDocumentationVersions (Maybe Int) Source #
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
gdvPosition :: Lens' GetDocumentationVersions (Maybe Text) Source #
The current pagination position in the paged result set.
gdvRestAPIId :: Lens' GetDocumentationVersions Text Source #
- Required
- The string identifier of the associated
RestApi
.
Destructuring the Response
getDocumentationVersionsResponse Source #
Creates a value of GetDocumentationVersionsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gdvrsItems
- The current page of elements from this collection.gdvrsPosition
- Undocumented member.gdvrsResponseStatus
- -- | The response status code.
data GetDocumentationVersionsResponse Source #
The collection of documentation snapshots of an API.
Use the DocumentationVersions
to manage documentation snapshots associated with various API stages.
Documenting an API , DocumentationPart
, DocumentationVersion
See: getDocumentationVersionsResponse
smart constructor.
Response Lenses
gdvrsItems :: Lens' GetDocumentationVersionsResponse [DocumentationVersion] Source #
The current page of elements from this collection.
gdvrsPosition :: Lens' GetDocumentationVersionsResponse (Maybe Text) Source #
Undocumented member.
gdvrsResponseStatus :: Lens' GetDocumentationVersionsResponse Int Source #
- - | The response status code.