CreateDocumentationVersion
Creates a documentation version
Request Syntax
POST /restapis/restapi_id/documentation/versions HTTP/1.1
Content-type: application/json
{
"description": "string",
"documentationVersion": "string",
"stageName": "string"
}URI Request Parameters
The request uses the following URI parameters.
- restapi_id
-
The string identifier of the associated RestApi.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- description
-
A description about the new documentation snapshot.
Type: String
Required: No
- documentationVersion
-
The version identifier of the new snapshot.
Type: String
Required: Yes
- stageName
-
The stage name to be associated with the new documentation snapshot.
Type: String
Required: No
Response Syntax
HTTP/1.1 201
Content-type: application/json
{
"createdDate": number,
"description": "string",
"version": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
- createdDate
-
The date when the API documentation snapshot is created.
Type: Timestamp
- description
-
The description of the API documentation snapshot.
Type: String
- version
-
The version identifier of the API documentation snapshot.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
HTTP Status Code: 400
- ConflictException
-
The request configuration has conflicts. For details, see the accompanying error message.
HTTP Status Code: 409
- LimitExceededException
-
The request exceeded the rate limit. Retry after the specified time period.
HTTP Status Code: 429
- NotFoundException
-
The requested resource is not found. Make sure that the request URI is correct.
HTTP Status Code: 404
- TooManyRequestsException
-
The request has reached its throttling limit. Retry after the specified time period.
HTTP Status Code: 429
- UnauthorizedException
-
The request is denied because the caller has insufficient permissions.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
