SwaggerSchema interface
A swagger séma.
Tulajdonságok
| additional |
A további tulajdonságok. |
| all |
Azok a sémák, amelyeknek érvényesnek kell lenniük a séma használatakor. |
| discriminator | A diszkriminatív. |
| dynamic |
A dinamikus lista. |
| dynamic |
A dinamikus sémakonfiguráció. |
| dynamic |
A dinamikus sémakonfiguráció. |
| dynamic |
A dinamikus értékek fakonfigurációja. |
| example | A példaérték. |
| external |
A külső dokumentáció. |
| items | Az elemek sémája. |
| max |
Az engedélyezett tulajdonságok maximális száma. |
| min |
Az engedélyezett tulajdonságok minimális száma. |
| notification |
Az értesítés URL-bővítményét jelzi. Ha ez be van állítva, a tulajdonság értékének egy webhook visszahívási URL-címének kell lennie. |
| properties | Az objektum tulajdonságai |
| read |
Azt jelzi, hogy a tulajdonságnak szerepelnie kell-e a kérelemben. |
| ref | A hivatkozás. |
| required | Az objektum szükséges tulajdonságai. |
| title | A cím. |
| type | A típus |
| xml | Egy tulajdonság xml-reprezentációs formátuma. |
Tulajdonság adatai
additionalProperties
A további tulajdonságok.
additionalProperties?: any
Tulajdonság értéke
any
allOf
Azok a sémák, amelyeknek érvényesnek kell lenniük a séma használatakor.
allOf?: SwaggerSchema[]
Tulajdonság értéke
discriminator
A diszkriminatív.
discriminator?: string
Tulajdonság értéke
string
dynamicListNew
A dinamikus lista.
dynamicListNew?: SwaggerCustomDynamicList
Tulajdonság értéke
dynamicSchemaNew
A dinamikus sémakonfiguráció.
dynamicSchemaNew?: SwaggerCustomDynamicProperties
Tulajdonság értéke
dynamicSchemaOld
A dinamikus sémakonfiguráció.
dynamicSchemaOld?: SwaggerCustomDynamicSchema
Tulajdonság értéke
dynamicTree
A dinamikus értékek fakonfigurációja.
dynamicTree?: SwaggerCustomDynamicTree
Tulajdonság értéke
example
A példaérték.
example?: any
Tulajdonság értéke
any
externalDocs
A külső dokumentáció.
externalDocs?: SwaggerExternalDocumentation
Tulajdonság értéke
items
maxProperties
Az engedélyezett tulajdonságok maximális száma.
maxProperties?: number
Tulajdonság értéke
number
minProperties
Az engedélyezett tulajdonságok minimális száma.
minProperties?: number
Tulajdonság értéke
number
notificationUrlExtension
Az értesítés URL-bővítményét jelzi. Ha ez be van állítva, a tulajdonság értékének egy webhook visszahívási URL-címének kell lennie.
notificationUrlExtension?: boolean
Tulajdonság értéke
boolean
properties
Az objektum tulajdonságai
properties?: {[propertyName: string]: SwaggerSchema}
Tulajdonság értéke
{[propertyName: string]: SwaggerSchema}
readOnly
Azt jelzi, hogy a tulajdonságnak szerepelnie kell-e a kérelemben.
readOnly?: boolean
Tulajdonság értéke
boolean
ref
A hivatkozás.
ref?: string
Tulajdonság értéke
string
required
Az objektum szükséges tulajdonságai.
required?: string[]
Tulajdonság értéke
string[]
title
A cím.
title?: string
Tulajdonság értéke
string
type
A típus
type?: string
Tulajdonság értéke
string