PutRestApiRequest
import type { PutRestApiRequest } from "https://aws-api.deno.dev/v0.3/services/apigateway.ts?docs=full";A PUT request to update an existing API, with external API definitions specified as the request body.
interface PutRestApiRequest {
body: Uint8Array | string;
failOnWarnings?: boolean | null;
mode?: PutMode | null;
parameters?: {} | null;
[key: string]: string | null | undefined;
restApiId: string;
}§Properties
§
body: Uint8Array | string
[src][Required] The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.
§
failOnWarnings?: boolean | null
[src]A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered.
The default value is false.
§
parameters?: {} | null
[src][key: string]: string | null | undefined;
Custom header parameters as part of the request.
For example, to exclude "DocumentationParts" from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.