Interface GetSchemaResponse

The GET request schema response.

interface GetSchemaResponse {
    _links?: GetSchemaResponseLinks;
    errors?: Error[];
    payload?: { [key: string]: object };
}

Index

Properties

_links? errors? payload?

Properties

`Optional`_links

_links?: GetSchemaResponseLinks

`Optional`errors

errors?: Error[]

A list of error responses returned when a request is unsuccessful.

`Optional`payload

payload?: { [key: string]: object }

A JSON schema document describing the expected payload of the action. This object can be validated against http://json-schema.org/draft-04/schema.