Udostępnij przez


SwaggerSchema interface

Schemat struktury Swagger.

Właściwości

additionalProperties

Dodatkowe właściwości.

allOf

Schematy, które muszą przejść walidację w przypadku użycia tego schematu.

discriminator

Dyskryminujące.

dynamicListNew

Lista dynamiczna.

dynamicSchemaNew

Konfiguracja schematu dynamicznego.

dynamicSchemaOld

Konfiguracja schematu dynamicznego.

dynamicTree

Konfiguracja drzewa wartości dynamicznych.

example

Przykładowa wartość.

externalDocs

Dokumentacja zewnętrzna.

items

Schemat elementów.

maxProperties

Maksymalna liczba dozwolonych właściwości.

minProperties

Minimalna liczba dozwolonych właściwości.

notificationUrlExtension

Wskazuje rozszerzenie adresu URL powiadomień. Jeśli ta wartość jest ustawiona, wartość właściwości powinna być adresem URL wywołania zwrotnego dla elementu webhook.

properties

Właściwości obiektu

readOnly

Wskazuje, czy ta właściwość musi być obecna w żądaniu.

ref

Odwołanie.

required

Obiekt wymaga właściwości.

title

Tytuł.

type

Typ

xml

Format reprezentacji xml dla właściwości.

Szczegóły właściwości

additionalProperties

Dodatkowe właściwości.

additionalProperties?: any

Wartość właściwości

any

allOf

Schematy, które muszą przejść walidację w przypadku użycia tego schematu.

allOf?: SwaggerSchema[]

Wartość właściwości

discriminator

Dyskryminujące.

discriminator?: string

Wartość właściwości

string

dynamicListNew

Lista dynamiczna.

dynamicListNew?: SwaggerCustomDynamicList

Wartość właściwości

dynamicSchemaNew

Konfiguracja schematu dynamicznego.

dynamicSchemaNew?: SwaggerCustomDynamicProperties

Wartość właściwości

dynamicSchemaOld

Konfiguracja schematu dynamicznego.

dynamicSchemaOld?: SwaggerCustomDynamicSchema

Wartość właściwości

dynamicTree

Konfiguracja drzewa wartości dynamicznych.

dynamicTree?: SwaggerCustomDynamicTree

Wartość właściwości

example

Przykładowa wartość.

example?: any

Wartość właściwości

any

externalDocs

Dokumentacja zewnętrzna.

externalDocs?: SwaggerExternalDocumentation

Wartość właściwości

items

Schemat elementów.

items?: SwaggerSchema

Wartość właściwości

maxProperties

Maksymalna liczba dozwolonych właściwości.

maxProperties?: number

Wartość właściwości

number

minProperties

Minimalna liczba dozwolonych właściwości.

minProperties?: number

Wartość właściwości

number

notificationUrlExtension

Wskazuje rozszerzenie adresu URL powiadomień. Jeśli ta wartość jest ustawiona, wartość właściwości powinna być adresem URL wywołania zwrotnego dla elementu webhook.

notificationUrlExtension?: boolean

Wartość właściwości

boolean

properties

Właściwości obiektu

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

Wartość właściwości

{[propertyName: string]: SwaggerSchema}

readOnly

Wskazuje, czy ta właściwość musi być obecna w żądaniu.

readOnly?: boolean

Wartość właściwości

boolean

ref

Odwołanie.

ref?: string

Wartość właściwości

string

required

Obiekt wymaga właściwości.

required?: string[]

Wartość właściwości

string[]

title

Tytuł.

title?: string

Wartość właściwości

string

type

Typ

type?: string

Wartość właściwości

string

xml

Format reprezentacji xml dla właściwości.

xml?: SwaggerXml

Wartość właściwości