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

GetDocumentationPartsRequest

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

Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).

interface GetDocumentationPartsRequest {
limit?: number | null;
locationStatus?: LocationStatusType | null;
nameQuery?: string | null;
path?: string | null;
position?: string | null;
restApiId: string;
type?: DocumentationPartType | null;
}

§Properties

§
limit?: number | null
[src]

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

§
locationStatus?: LocationStatusType | null
[src]

The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving "DocumentationPart" resources with content and UNDOCUMENTED for "DocumentationPart" resources without content.

§
nameQuery?: string | null
[src]

The name of API entities of the to-be-retrieved documentation parts.

§
path?: string | null
[src]

The path of API entities of the to-be-retrieved documentation parts.

§
position?: string | null
[src]

The current pagination position in the paged result set.

§
restApiId: string
[src]

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

§
type?: DocumentationPartType | null
[src]

The type of API entities of the to-be-retrieved documentation parts.