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.
- importDocumentationParts :: Text -> ByteString -> ImportDocumentationParts
- data ImportDocumentationParts
- idpMode :: Lens' ImportDocumentationParts (Maybe PutMode)
- idpFailOnWarnings :: Lens' ImportDocumentationParts (Maybe Bool)
- idpRestAPIId :: Lens' ImportDocumentationParts Text
- idpBody :: Lens' ImportDocumentationParts ByteString
- importDocumentationPartsResponse :: Int -> ImportDocumentationPartsResponse
- data ImportDocumentationPartsResponse
- idprsIds :: Lens' ImportDocumentationPartsResponse [Text]
- idprsWarnings :: Lens' ImportDocumentationPartsResponse [Text]
- idprsResponseStatus :: Lens' ImportDocumentationPartsResponse Int
Creating a Request
importDocumentationParts Source #
Creates a value of ImportDocumentationParts
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
idpMode
- A query parameter to indicate whether to overwrite (OVERWRITE
) any existingDocumentationParts
definition or to merge (MERGE
) the new definition into the existing one. The default value isMERGE
.idpFailOnWarnings
- A query parameter to specify whether to rollback the documentation importation (true
) or not (false
) when a warning is encountered. The default value isfalse
.idpRestAPIId
- [Required] The string identifier of the associatedRestApi
.idpBody
- [Required] Raw byte array representing the to-be-imported documentation parts. To import from a Swagger file, this is a JSON object.
data ImportDocumentationParts Source #
Import documentation parts from an external (e.g., Swagger) definition file.
See: importDocumentationParts
smart constructor.
Request Lenses
idpMode :: Lens' ImportDocumentationParts (Maybe PutMode) Source #
A query parameter to indicate whether to overwrite (OVERWRITE
) any existing DocumentationParts
definition or to merge (MERGE
) the new definition into the existing one. The default value is MERGE
.
idpFailOnWarnings :: Lens' ImportDocumentationParts (Maybe Bool) Source #
A query parameter to specify whether to rollback the documentation importation (true
) or not (false
) when a warning is encountered. The default value is false
.
idpRestAPIId :: Lens' ImportDocumentationParts Text Source #
- Required
- The string identifier of the associated
RestApi
.
idpBody :: Lens' ImportDocumentationParts ByteString Source #
- Required
- Raw byte array representing the to-be-imported documentation parts. To import from a Swagger file, this is a JSON object.
Destructuring the Response
importDocumentationPartsResponse Source #
Creates a value of ImportDocumentationPartsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
idprsIds
- A list of the returned documentation part identifiers.idprsWarnings
- A list of warning messages reported during import of documentation parts.idprsResponseStatus
- -- | The response status code.
data ImportDocumentationPartsResponse Source #
A collection of the imported DocumentationPart
identifiers.
This is used to return the result when documentation parts in an external (e.g., Swagger) file are imported into API GatewayDocumenting an API , documentationpart:import , DocumentationPart
See: importDocumentationPartsResponse
smart constructor.
Response Lenses
idprsIds :: Lens' ImportDocumentationPartsResponse [Text] Source #
A list of the returned documentation part identifiers.
idprsWarnings :: Lens' ImportDocumentationPartsResponse [Text] Source #
A list of warning messages reported during import of documentation parts.
idprsResponseStatus :: Lens' ImportDocumentationPartsResponse Int Source #
- - | The response status code.