Model

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

Represents the data structure of a method's request or response payload.

A request model defines the data structure of the client-supplied request payload. A response model defines the data structure of the response payload returned by the back end. Although not required, models are useful for mapping payloads between the front end and back end.

A model is used for generating an API's SDK, validating the input request body, and creating a skeletal mapping template.

See also: "Method", "MethodResponse", Models and Mappings

interface Model {

contentType?: string | null;

description?: string | null;

id?: string | null;

name?: string | null;

schema?: string | null;

}

§Properties

contentType?: string | null

[src]

The content-type for the model.

description?: string | null

[src]

The description of the model.

id?: string | null

[src]

The identifier for the model resource.

name?: string | null

[src]

The name of the model. Must be an alphanumeric string.

schema?: string | null

[src]

The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "*/" characters in the description of any properties because such "*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.