Interface ContractSchemas

The JSON Schemas of a contract's bodies.

interface ContractSchemas {
    error?: JsonSchema;
    errorType?: string;
    list?(item: JsonSchema): JsonSchema;
    success?(data: JsonSchema): JsonSchema;
}

Index

Properties

error? errorType?

Methods

Properties

`Optional`error

error?: JsonSchema

An error body.

`Optional`errorType

errorType?: string

The error body's media type. Default application/json.

Methods

`Optional`list

list?(item: JsonSchema): JsonSchema
The body of list(c, page), given the schema of an item.
Parameters
- item: JsonSchema
Returns JsonSchema
- Defined in packages/web-kit/src/contract.ts:111

`Optional`success

success?(data: JsonSchema): JsonSchema
The body of ok(c, data), given the schema of data.
Parameters
- data: JsonSchema
Returns JsonSchema
- Defined in packages/web-kit/src/contract.ts:109