OpenSpecJsonSchema

@tsed/openspec

Usage

import { OpenSpecJsonSchema } from "@tsed/openspec";

See /packages/specs/openspec/src/common/OpenSpecJsonSchema.ts.

Overview

interface OpenSpecJsonSchema<Schema = any> extends OpenSpecBaseJsonSchema {
    items?: Schema | OpenSpecRef;
    required?: string[];
    additionalProperties?: Schema | boolean;
    properties?: OpenSpecHash<Schema>;
    allOf?: (Schema | OpenSpecRef)[];
    example?: any;
}

items

items?: Schema | OpenSpecRef;

Required if type is "array". Describes the type of items in the array.

required

required?: string[];

A free-form property to include an example of an instance for this schema.

additionalProperties

additionalProperties?: Schema | boolean;

Value can be boolean or object. Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.

properties

properties?: OpenSpecHash<Schema>;

Property definitions MUST be a Schema Object and not a standard JSON Schema (inline or referenced).

allOf:

allOf?: (Schema | OpenSpecRef)[];

Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.

example

example?: any;

Additional external documentation for this schema.