SwaggerSchema interface
The swagger schema.
Properties
| additional |
The additional properties. |
| all |
The schemas which must pass validation when this schema is used. |
| discriminator | The discriminator. |
| dynamic |
The dynamic list. |
| dynamic |
The dynamic schema configuration. |
| dynamic |
The dynamic schema configuration. |
| dynamic |
The dynamic values tree configuration. |
| example | The example value. |
| external |
The external documentation. |
| items | The items schema. |
| max |
The maximum number of allowed properties. |
| min |
The minimum number of allowed properties. |
| notification |
Indicates the notification url extension. If this is set, the property's value should be a callback url for a webhook. |
| properties | The object properties |
| read |
Indicates whether this property must be present in the a request. |
| ref | The reference. |
| required | The object required properties. |
| title | The title. |
| type | The type |
| xml | The xml representation format for a property. |
Property Details
additionalProperties
The additional properties.
additionalProperties?: anyProperty Value
any
allOf
The schemas which must pass validation when this schema is used.
allOf?: SwaggerSchema[]Property Value
discriminator
The discriminator.
discriminator?: stringProperty Value
string
dynamicListNew
dynamicSchemaNew
The dynamic schema configuration.
dynamicSchemaNew?: SwaggerCustomDynamicPropertiesProperty Value
dynamicSchemaOld
The dynamic schema configuration.
dynamicSchemaOld?: SwaggerCustomDynamicSchemaProperty Value
dynamicTree
The dynamic values tree configuration.
dynamicTree?: SwaggerCustomDynamicTreeProperty Value
example
The example value.
example?: anyProperty Value
any
externalDocs
The external documentation.
externalDocs?: SwaggerExternalDocumentationProperty Value
items
maxProperties
The maximum number of allowed properties.
maxProperties?: numberProperty Value
number
minProperties
The minimum number of allowed properties.
minProperties?: numberProperty Value
number
notificationUrlExtension
Indicates the notification url extension. If this is set, the property's value should be a callback url for a webhook.
notificationUrlExtension?: booleanProperty Value
boolean
properties
The object properties
properties?: {[propertyName: string]: SwaggerSchema}Property Value
{[propertyName: string]: SwaggerSchema}
readOnly
Indicates whether this property must be present in the a request.
readOnly?: booleanProperty Value
boolean
ref
The reference.
ref?: stringProperty Value
string
required
The object required properties.
required?: string[]Property Value
string[]
title
The title.
title?: stringProperty Value
string
type
The type
type?: stringProperty Value
string