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.
- createDocumentationVersion :: Text -> Text -> CreateDocumentationVersion
- data CreateDocumentationVersion
- cdvStageName :: Lens' CreateDocumentationVersion (Maybe Text)
- cdvDescription :: Lens' CreateDocumentationVersion (Maybe Text)
- cdvRestAPIId :: Lens' CreateDocumentationVersion Text
- cdvDocumentationVersion :: Lens' CreateDocumentationVersion Text
- documentationVersion :: DocumentationVersion
- data DocumentationVersion
- dvCreatedDate :: Lens' DocumentationVersion (Maybe UTCTime)
- dvVersion :: Lens' DocumentationVersion (Maybe Text)
- dvDescription :: Lens' DocumentationVersion (Maybe Text)
Creating a Request
createDocumentationVersion Source #
Creates a value of CreateDocumentationVersion
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cdvStageName
- The stage name to be associated with the new documentation snapshot.cdvDescription
- A description about the new documentation snapshot.cdvRestAPIId
- [Required] Specifies the API identifier of the to-be-created documentation version.cdvDocumentationVersion
- [Required] The version identifier of the new snapshot.
data CreateDocumentationVersion Source #
Creates a new documentation version of a given API.
See: createDocumentationVersion
smart constructor.
Request Lenses
cdvStageName :: Lens' CreateDocumentationVersion (Maybe Text) Source #
The stage name to be associated with the new documentation snapshot.
cdvDescription :: Lens' CreateDocumentationVersion (Maybe Text) Source #
A description about the new documentation snapshot.
cdvRestAPIId :: Lens' CreateDocumentationVersion Text Source #
- Required
- Specifies the API identifier of the to-be-created documentation version.
cdvDocumentationVersion :: Lens' CreateDocumentationVersion Text Source #
- Required
- The version identifier of the new 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.