SwaggerSchema interface

Package:

@azure/arm-logic

The swagger schema.

Properties

additionalProperties	The additional properties.
allOf	The schemas which must pass validation when this schema is used.
discriminator	The discriminator.
dynamicListNew	The dynamic list.
dynamicSchemaNew	The dynamic schema configuration.
dynamicSchemaOld	The dynamic schema configuration.
dynamicTree	The dynamic values tree configuration.
example	The example value.
externalDocs	The external documentation.
items	The items schema.
maxProperties	The maximum number of allowed properties.
minProperties	The minimum number of allowed properties.
notificationUrlExtension	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
readOnly	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?: any

Property Value

any

allOf

The schemas which must pass validation when this schema is used.

allOf?: SwaggerSchema[]

Property Value

SwaggerSchema[]

discriminator

The discriminator.

discriminator?: string

Property Value

string

dynamicListNew

The dynamic list.

dynamicListNew?: SwaggerCustomDynamicList

Property Value

SwaggerCustomDynamicList

dynamicSchemaNew

The dynamic schema configuration.

dynamicSchemaNew?: SwaggerCustomDynamicProperties

Property Value

SwaggerCustomDynamicProperties

dynamicSchemaOld

The dynamic schema configuration.

dynamicSchemaOld?: SwaggerCustomDynamicSchema

Property Value

SwaggerCustomDynamicSchema

dynamicTree

The dynamic values tree configuration.

dynamicTree?: SwaggerCustomDynamicTree

Property Value

SwaggerCustomDynamicTree

example

The example value.

example?: any

Property Value

any

externalDocs

The external documentation.

externalDocs?: SwaggerExternalDocumentation

Property Value

SwaggerExternalDocumentation

items

The items schema.

items?: SwaggerSchema

Property Value

SwaggerSchema

maxProperties

The maximum number of allowed properties.

maxProperties?: number

Property Value

number

minProperties

The minimum number of allowed properties.

minProperties?: number

Property 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?: boolean

Property 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?: boolean

Property Value

boolean

ref

The reference.

ref?: string

Property Value

string

required

The object required properties.

required?: string[]

Property Value

string[]

title

The title.

title?: string

Property Value

string

type

The type

type?: string

Property Value

string

xml

The xml representation format for a property.

xml?: SwaggerXml

Property Value

SwaggerXml