SwaggerSchema Class

Definition

The swagger schema.

public final class SwaggerSchema
Inheritance
java.lang.Object
SwaggerSchema

Inherited Members

java.lang.Object.clone() java.lang.Object.equals(java.lang.Object) java.lang.Object.finalize() java.lang.Object.getClass() java.lang.Object.hashCode() java.lang.Object.notify() java.lang.Object.notifyAll() java.lang.Object.toString() java.lang.Object.wait() java.lang.Object.wait(long) java.lang.Object.wait(long,int)

Constructors

SwaggerSchema()

Methods

additionalProperties()

Get the additionalProperties property: The additional properties.

allOf()

Get the allOf property: The schemas which must pass validation when this schema is used.

discriminator()

Get the discriminator property: The discriminator.

dynamicListNew()

Get the dynamicListNew property: The dynamic list.

dynamicSchemaNew()

Get the dynamicSchemaNew property: The dynamic schema configuration.

dynamicSchemaOld()

Get the dynamicSchemaOld property: The dynamic schema configuration.

dynamicTree()

Get the dynamicTree property: The dynamic values tree configuration.

example()

Get the example property: The example value.

externalDocs()

Get the externalDocs property: The external documentation.

items()

Get the items property: The items schema.

maxProperties()

Get the maxProperties property: The maximum number of allowed properties.

minProperties()

Get the minProperties property: The minimum number of allowed properties.

notificationUrlExtension()

Get the notificationUrlExtension property: Indicates the notification url extension. If this is set, the property's value should be a callback url for a webhook.

properties()

Get the properties property: The object properties.

readOnly()

Get the readOnly property: Indicates whether this property must be present in the a request.

ref()

Get the ref property: The reference.

required()

Get the required property: The object required properties.

title()

Get the title property: The title.

type()

Get the type property: The type.

validate()

Validates the instance.

withAdditionalProperties(Object additionalProperties)

Set the additionalProperties property: The additional properties.

withAllOf(List<SwaggerSchema> allOf)

Set the allOf property: The schemas which must pass validation when this schema is used.

withDiscriminator(String discriminator)

Set the discriminator property: The discriminator.

withDynamicListNew(SwaggerCustomDynamicList dynamicListNew)

Set the dynamicListNew property: The dynamic list.

withDynamicSchemaNew(SwaggerCustomDynamicProperties dynamicSchemaNew)

Set the dynamicSchemaNew property: The dynamic schema configuration.

withDynamicSchemaOld(SwaggerCustomDynamicSchema dynamicSchemaOld)

Set the dynamicSchemaOld property: The dynamic schema configuration.

withDynamicTree(SwaggerCustomDynamicTree dynamicTree)

Set the dynamicTree property: The dynamic values tree configuration.

withExample(Object example)

Set the example property: The example value.

withExternalDocs(SwaggerExternalDocumentation externalDocs)

Set the externalDocs property: The external documentation.

withItems(SwaggerSchema items)

Set the items property: The items schema.

withMaxProperties(Integer maxProperties)

Set the maxProperties property: The maximum number of allowed properties.

withMinProperties(Integer minProperties)

Set the minProperties property: The minimum number of allowed properties.

withNotificationUrlExtension(Boolean notificationUrlExtension)

Set the notificationUrlExtension property: Indicates the notification url extension. If this is set, the property's value should be a callback url for a webhook.

withProperties(Map<String,SwaggerSchema> properties)

Set the properties property: The object properties.

withReadOnly(Boolean readOnly)

Set the readOnly property: Indicates whether this property must be present in the a request.

withRef(String ref)

Set the ref property: The reference.

withRequired(List<String> required)

Set the required property: The object required properties.

withTitle(String title)

Set the title property: The title.

withType(SwaggerSchemaType type)

Set the type property: The type.

withXml(SwaggerXml xml)

Set the xml property: The xml representation format for a property.

xml()

Get the xml property: The xml representation format for a property.

Applies to