Compartilhar via


SwaggerSchema interface

O esquema swagger.

Propriedades

additionalProperties

As propriedades adicionais.

allOf

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

discriminator

O discriminador.

dynamicListNew

A lista dinâmica.

dynamicSchemaNew

A configuração de esquema dinâmico.

dynamicSchemaOld

A configuração de 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 da URL de notificação. Se isso for definido, o valor da propriedade deverá ser uma URL de retorno de chamada para um webhook.

properties

As propriedades do objeto

readOnly

Indica se essa propriedade deve estar presente na 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 de uma propriedade.

Detalhes da propriedade

additionalProperties

As propriedades adicionais.

additionalProperties?: any

Valor da propriedade

any

allOf

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

allOf?: SwaggerSchema[]

Valor da propriedade

discriminator

O discriminador.

discriminator?: string

Valor da propriedade

string

dynamicListNew

A lista dinâmica.

dynamicListNew?: SwaggerCustomDynamicList

Valor da propriedade

dynamicSchemaNew

A configuração de esquema dinâmico.

dynamicSchemaNew?: SwaggerCustomDynamicProperties

Valor da propriedade

dynamicSchemaOld

A configuração de esquema dinâmico.

dynamicSchemaOld?: SwaggerCustomDynamicSchema

Valor da propriedade

dynamicTree

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

dynamicTree?: SwaggerCustomDynamicTree

Valor da propriedade

example

O valor de exemplo.

example?: any

Valor da propriedade

any

externalDocs

A documentação externa.

externalDocs?: SwaggerExternalDocumentation

Valor da propriedade

items

O esquema de itens.

items?: SwaggerSchema

Valor da propriedade

maxProperties

O número máximo de propriedades permitidas.

maxProperties?: number

Valor da propriedade

number

minProperties

O número mínimo de propriedades permitidas.

minProperties?: number

Valor da propriedade

number

notificationUrlExtension

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

notificationUrlExtension?: boolean

Valor da propriedade

boolean

properties

As propriedades do objeto

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

Valor da propriedade

{[propertyName: string]: SwaggerSchema}

readOnly

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

readOnly?: boolean

Valor da propriedade

boolean

ref

A referência.

ref?: string

Valor da propriedade

string

required

As propriedades necessárias do objeto.

required?: string[]

Valor da propriedade

string[]

title

O título.

title?: string

Valor da propriedade

string

type

O tipo

type?: string

Valor da propriedade

string

xml

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

xml?: SwaggerXml

Valor da propriedade