Copyright | (c) 2013-2021 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 |
Amazonka.APIGateway.UpdateDocumentationVersion
Description
- - | Undocumented operation.
Synopsis
- data UpdateDocumentationVersion = UpdateDocumentationVersion' {}
- newUpdateDocumentationVersion :: Text -> Text -> UpdateDocumentationVersion
- updateDocumentationVersion_patchOperations :: Lens' UpdateDocumentationVersion (Maybe [PatchOperation])
- updateDocumentationVersion_restApiId :: Lens' UpdateDocumentationVersion Text
- updateDocumentationVersion_documentationVersion :: Lens' UpdateDocumentationVersion Text
- data DocumentationVersion = DocumentationVersion' {
- createdDate :: Maybe POSIX
- version :: Maybe Text
- description :: Maybe Text
- newDocumentationVersion :: DocumentationVersion
- documentationVersion_createdDate :: Lens' DocumentationVersion (Maybe UTCTime)
- documentationVersion_version :: Lens' DocumentationVersion (Maybe Text)
- documentationVersion_description :: Lens' DocumentationVersion (Maybe Text)
Creating a Request
data UpdateDocumentationVersion Source #
Updates an existing documentation version of an API.
See: newUpdateDocumentationVersion
smart constructor.
Constructors
UpdateDocumentationVersion' | |
Fields
|
Instances
newUpdateDocumentationVersion Source #
Arguments
:: Text | |
-> Text | |
-> UpdateDocumentationVersion |
Create a value of UpdateDocumentationVersion
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:patchOperations:UpdateDocumentationVersion'
, updateDocumentationVersion_patchOperations
- A list of update operations to be applied to the specified resource and
in the order specified in this list.
$sel:restApiId:UpdateDocumentationVersion'
, updateDocumentationVersion_restApiId
- [Required] The string identifier of the associated RestApi..
$sel:documentationVersion:UpdateDocumentationVersion'
, updateDocumentationVersion_documentationVersion
- [Required] The version identifier of the to-be-updated documentation
version.
Request Lenses
updateDocumentationVersion_patchOperations :: Lens' UpdateDocumentationVersion (Maybe [PatchOperation]) Source #
A list of update operations to be applied to the specified resource and in the order specified in this list.
updateDocumentationVersion_restApiId :: Lens' UpdateDocumentationVersion Text Source #
- Required
- The string identifier of the associated RestApi..
updateDocumentationVersion_documentationVersion :: Lens' UpdateDocumentationVersion Text Source #
- Required
- The version identifier of the to-be-updated documentation version.
Destructuring the Response
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., OpenAPI) file.
Documenting an API, DocumentationPart, DocumentationVersions
See: newDocumentationVersion
smart constructor.
Constructors
DocumentationVersion' | |
Fields
|
Instances
newDocumentationVersion :: DocumentationVersion Source #
Create a value of DocumentationVersion
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdDate:DocumentationVersion'
, documentationVersion_createdDate
- The date when the API documentation snapshot is created.
$sel:version:DocumentationVersion'
, documentationVersion_version
- The version identifier of the API documentation snapshot.
$sel:description:DocumentationVersion'
, documentationVersion_description
- The description of the API documentation snapshot.
Response Lenses
documentationVersion_createdDate :: Lens' DocumentationVersion (Maybe UTCTime) Source #
The date when the API documentation snapshot is created.
documentationVersion_version :: Lens' DocumentationVersion (Maybe Text) Source #
The version identifier of the API documentation snapshot.
documentationVersion_description :: Lens' DocumentationVersion (Maybe Text) Source #
The description of the API documentation snapshot.