Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Undocumented operation.
- getDocumentationVersion :: Text -> Text -> GetDocumentationVersion
- data GetDocumentationVersion
- gdvdRestAPIId :: Lens' GetDocumentationVersion Text
- gdvdDocumentationVersion :: Lens' GetDocumentationVersion Text
- documentationVersion :: DocumentationVersion
- data DocumentationVersion
- dvCreatedDate :: Lens' DocumentationVersion (Maybe UTCTime)
- dvVersion :: Lens' DocumentationVersion (Maybe Text)
- dvDescription :: Lens' DocumentationVersion (Maybe Text)
Creating a Request
getDocumentationVersion Source #
Creates a value of GetDocumentationVersion
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gdvdRestAPIId
- [Required] The identifier of the API of the to-be-retrieved documentation snapshot.gdvdDocumentationVersion
- [Required] The version identifier of the to-be-retrieved documentation snapshot.
data GetDocumentationVersion Source #
Gets a documentation snapshot of an API.
See: getDocumentationVersion
smart constructor.
Request Lenses
gdvdRestAPIId :: Lens' GetDocumentationVersion Text Source #
- Required
- The identifier of the API of the to-be-retrieved documentation snapshot.
gdvdDocumentationVersion :: Lens' GetDocumentationVersion Text Source #
- Required
- The version identifier of the to-be-retrieved documentation snapshot.
Destructuring the Response
documentationVersion :: DocumentationVersion Source #
Creates a value of DocumentationVersion
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dvCreatedDate
- The date when the API documentation snapshot is created.dvVersion
- The version identifier of the API documentation snapshot.dvDescription
- The description of the API documentation snapshot.
data DocumentationVersion Source #
A snapshot of the documentation of an API.
Publishing API documentation involves creating a documentation version associated with an API stage and exporting the versioned documentation to an external (e.g., Swagger) file.
Documenting an API , DocumentationPart
, DocumentationVersions
See: documentationVersion
smart constructor.
Response Lenses
dvCreatedDate :: Lens' DocumentationVersion (Maybe UTCTime) Source #
The date when the API documentation snapshot is created.
dvVersion :: Lens' DocumentationVersion (Maybe Text) Source #
The version identifier of the API documentation snapshot.
dvDescription :: Lens' DocumentationVersion (Maybe Text) Source #
The description of the API documentation snapshot.