Partilhar via


SwaggerSchema interface

O esquema swagger.

Propriedades

additionalProperties

As propriedades adicionais.

allOf

Os esquemas que devem passar pela validação quando este esquema é usado.

discriminator

O discriminador.

dynamicListNew

A lista dinâmica.

dynamicSchemaNew

A configuração do esquema dinâmico.

dynamicSchemaOld

A configuração do esquema dinâmico.

dynamicTree

A configuração da árvore de valores dinâmicos.

example

O valor de exemplo.

externalDocs

A documentação externa.

items

O esquema de itens.

maxProperties

O número máximo de propriedades permitidas.

minProperties

O número mínimo de propriedades permitidas.

notificationUrlExtension

Indica a extensão url de notificação. Se isso for definido, o valor da propriedade deve ser uma url de retorno de chamada para um webhook.

properties

As propriedades do objeto

readOnly

Indica se essa propriedade deve estar presente em uma solicitação.

ref

A referência.

required

As propriedades necessárias do objeto.

title

O título.

type

O tipo

xml

O formato de representação xml para uma propriedade.

Detalhes de Propriedade

additionalProperties

As propriedades adicionais.

additionalProperties?: any

Valor de Propriedade

any

allOf

Os esquemas que devem passar pela validação quando este esquema é usado.

allOf?: SwaggerSchema[]

Valor de Propriedade

discriminator

O discriminador.

discriminator?: string

Valor de Propriedade

string

dynamicListNew

A lista dinâmica.

dynamicListNew?: SwaggerCustomDynamicList

Valor de Propriedade

dynamicSchemaNew

A configuração do esquema dinâmico.

dynamicSchemaNew?: SwaggerCustomDynamicProperties

Valor de Propriedade

dynamicSchemaOld

A configuração do esquema dinâmico.

dynamicSchemaOld?: SwaggerCustomDynamicSchema

Valor de Propriedade

dynamicTree

A configuração da árvore de valores dinâmicos.

dynamicTree?: SwaggerCustomDynamicTree

Valor de Propriedade

example

O valor de exemplo.

example?: any

Valor de Propriedade

any

externalDocs

A documentação externa.

externalDocs?: SwaggerExternalDocumentation

Valor de Propriedade

items

O esquema de itens.

items?: SwaggerSchema

Valor de Propriedade

maxProperties

O número máximo de propriedades permitidas.

maxProperties?: number

Valor de Propriedade

number

minProperties

O número mínimo de propriedades permitidas.

minProperties?: number

Valor de Propriedade

number

notificationUrlExtension

Indica a extensão url de notificação. Se isso for definido, o valor da propriedade deve ser uma url de retorno de chamada para um webhook.

notificationUrlExtension?: boolean

Valor de Propriedade

boolean

properties

As propriedades do objeto

properties?: {[propertyName: string]: SwaggerSchema}

Valor de Propriedade

{[propertyName: string]: SwaggerSchema}

readOnly

Indica se essa propriedade deve estar presente em uma solicitação.

readOnly?: boolean

Valor de Propriedade

boolean

ref

A referência.

ref?: string

Valor de Propriedade

string

required

As propriedades necessárias do objeto.

required?: string[]

Valor de Propriedade

string[]

title

O título.

title?: string

Valor de Propriedade

string

type

O tipo

type?: string

Valor de Propriedade

string

xml

O formato de representação xml para uma propriedade.

xml?: SwaggerXml

Valor de Propriedade