Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

ImportDocumentationPartsRequest

import type { ImportDocumentationPartsRequest } from "https://aws-api.deno.dev/v0.3/services/apigateway.ts?docs=full";

Import documentation parts from an external (e.g., OpenAPI) definition file.

interface ImportDocumentationPartsRequest {
body: Uint8Array | string;
failOnWarnings?: boolean | null;
mode?: PutMode | null;
restApiId: string;
}

§Properties

§
body: Uint8Array | string
[src]

[Required] Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.

§
failOnWarnings?: boolean | null
[src]

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.

§
mode?: PutMode | null
[src]

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.

§
restApiId: string
[src]

[Required] The string identifier of the associated "RestApi".