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.Types.DocumentationVersion

Description

Documentation

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 createdDate :: Maybe POSIX The date when the API documentation snapshot is created. version :: Maybe Text The version identifier of the API documentation snapshot. description :: Maybe Text The description of the API documentation snapshot.

Instances

Instances details

Eq DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods (==) :: DocumentationVersion -> DocumentationVersion -> Bool # (/=) :: DocumentationVersion -> DocumentationVersion -> Bool #
Read DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods readsPrec :: Int -> ReadS DocumentationVersion # readList :: ReadS [DocumentationVersion] # readPrec :: ReadPrec DocumentationVersion # readListPrec :: ReadPrec [DocumentationVersion] #
Show DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods showsPrec :: Int -> DocumentationVersion -> ShowS # show :: DocumentationVersion -> String # showList :: [DocumentationVersion] -> ShowS #
Generic DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Associated Types type Rep DocumentationVersion :: Type -> Type # Methods from :: DocumentationVersion -> Rep DocumentationVersion x # to :: Rep DocumentationVersion x -> DocumentationVersion #
NFData DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods rnf :: DocumentationVersion -> () #
Hashable DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods hashWithSalt :: Int -> DocumentationVersion -> Int # hash :: DocumentationVersion -> Int #
FromJSON DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods parseJSON :: Value -> Parser DocumentationVersion # parseJSONList :: Value -> Parser [DocumentationVersion] #
type Rep DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion type Rep DocumentationVersion = D1 ('MetaData "DocumentationVersion" "Amazonka.APIGateway.Types.DocumentationVersion" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "DocumentationVersion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

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.

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.