{ "description": String, "type": String, "nullable": Boolean, "deprecated": Boolean, "readonly": Boolean, }
Field | Description |
---|---|
description | String General description of this type, should not contain any new lines. |
type | String Type of the property |
nullable | Boolean Indicates whether it is possible to use a null value |
deprecated | Boolean Indicates whether this type is deprecated |
readonly | Boolean Indicates whether this type is readonly |
{ "type": String, "items": BooleanType | NumberType | StringType | ReferenceType | GenericType | AnyType, "maxItems": Integer, "minItems": Integer, }
Field | Description |
---|---|
type | String |
items | BooleanType | NumberType | StringType | ReferenceType | GenericType | AnyType |
maxItems | Integer Positive integer value |
minItems | Integer Positive integer value |
{ "format": String, "enum": Array (String | Number), "default": String | Number | Boolean, }
Field | Description |
---|---|
format | String Describes the specific format of this type i.e. date-time or int64 |
enum | Array (String | Number) |
default | String | Number | Boolean |
{ "type": String, }
Field | Description |
---|---|
type | String |
{ "propertyName": String, "mapping": Map (String), }
Field | Description |
---|---|
propertyName | String The name of the property in the payload that will hold the discriminator value |
mapping | Map (String) An object to hold mappings between payload values and schema names or references |
{ "$generic": String, }
Field | Description |
---|---|
$generic | String |
{ "description": String, "allOf": Array (ReferenceType), }
Field | Description |
---|---|
description | String |
allOf | Array (ReferenceType) Contains an array of references. The reference must only point to a struct type |
{ "type": String, "additionalProperties": BooleanType | NumberType | StringType | ArrayType | UnionType | IntersectionType | ReferenceType | GenericType | AnyType, "maxProperties": Integer, "minProperties": Integer, }
Field | Description |
---|---|
type | String |
additionalProperties | BooleanType | NumberType | StringType | ArrayType | UnionType | IntersectionType | ReferenceType | GenericType | AnyType |
maxProperties | Integer Positive integer value |
minProperties | Integer Positive integer value |
{ "type": String, "multipleOf": Number, "maximum": Number, "exclusiveMaximum": Boolean, "minimum": Number, "exclusiveMinimum": Boolean, }
Field | Description |
---|---|
type | String |
multipleOf | Number |
maximum | Number |
exclusiveMaximum | Boolean |
minimum | Number |
exclusiveMinimum | Boolean |
{ "$ref": String, "$template": Map (String), }
Field | Description |
---|---|
$ref | String Reference to a type under the definitions map |
$template | Map (String) Optional concrete type definitions which replace generic template types |
{ "type": String, "maxLength": Integer, "minLength": Integer, "pattern": String, }
Field | Description |
---|---|
type | String |
maxLength | Integer Positive integer value |
minLength | Integer Positive integer value |
pattern | String |
{ "$final": Boolean, "$extends": String, "type": String, "properties": Map (MapType | ArrayType | BooleanType | NumberType | StringType | AnyType | IntersectionType | UnionType | ReferenceType | GenericType), "required": Array (String), }
Field | Description |
---|---|
$final | Boolean Indicates that a struct is final, this means it is not possible to extend this struct |
$extends | String Extends an existing type with the referenced type |
type | String |
properties | Map (MapType | ArrayType | BooleanType | NumberType | StringType | AnyType | IntersectionType | UnionType | ReferenceType | GenericType) |
required | Array (String) |
{ "$import": Map (String), "definitions": Map (StructType | MapType | ReferenceType), "$ref": String, }
Field | Description |
---|---|
$import | Map (String) Contains external definitions which are imported. The imported schemas can be used via the namespace i.e. 'my_namespace:my_type' |
definitions | Map (StructType | MapType | ReferenceType) |
$ref | String Reference to a root schema under the definitions key |
{ "description": String, "discriminator": Discriminator, "oneOf": Array (NumberType | StringType | BooleanType | ReferenceType), }
Field | Description |
---|---|
description | String |
discriminator | Discriminator |
oneOf | Array (NumberType | StringType | BooleanType | ReferenceType) Contains an array of references. The reference must only point to a struct type |