Imports documentation parts
Request Syntax
PUT /restapis/restapi_id/documentation/parts?failonwarnings=failOnWarnings&mode=mode HTTP/1.1
bodyURI Request Parameters
The request uses the following URI parameters.
- failOnWarnings
-
A query parameter to specify whether to rollback the documentation importation (
true) or not (false) when a warning is encountered. The default value isfalse. - mode
-
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 ismerge.Valid Values:
merge | overwrite - restapi_id
-
The string identifier of the associated RestApi.
Required: Yes
Request Body
The request accepts the following binary data.
- body
-
Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ids": [ "string" ],
"warnings": [ "string" ]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
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:
