Attributes
Members list
Type members
Classlikes
The Schema Object allows the definition of input and output data types.
The Schema Object allows the definition of input and output data types.
Marked as writeOnly. This means that it MAY be sent as part of a request but SHOULD NOT be sent as part of the response. If the property is in the required list, the required will take effect on the request only.
Attributes
- deprecated
Specifies that a schema is deprecated and SHOULD be transitioned out of usage.
- discriminator
Adds support for polymorphism. The discriminator is an object name that is used to differentiate between other schemas which may satisfy the payload description.
- example
A free-form property to include an example of an instance for this schema.
- externalDocs
Additional external documentation for this schema.
- nullable
A true value adds "null" to the allowed type specified by the type keyword, only if type is explicitly defined within the same Schema Object. Other Schema Object constraints retain their defined behavior, and therefore may disallow the use of null as a value. A false value leaves the specified or default type unmodified.
- xml
This MAY be used only on properties schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property.
- Graph
- Supertypes
- trait Serializabletrait Producttrait Equalstrait Definitiontrait Schematrait SchemaOrReferenceclass Objecttrait Matchableclass Any
The Schema Object allows the definition of input and output data types.
The Schema Object allows the definition of input and output data types.
Marked as readOnly. This means that it MAY be sent as part of a response but SHOULD NOT be sent as part of the request. If the property is in the required list, the required will take effect on the response only.
Attributes
- deprecated
Specifies that a schema is deprecated and SHOULD be transitioned out of usage.
- discriminator
Adds support for polymorphism. The discriminator is an object name that is used to differentiate between other schemas which may satisfy the payload description.
- example
A free-form property to include an example of an instance for this schema.
- externalDocs
Additional external documentation for this schema.
- nullable
A true value adds "null" to the allowed type specified by the type keyword, only if type is explicitly defined within the same Schema Object. Other Schema Object constraints retain their defined behavior, and therefore may disallow the use of null as a value. A false value leaves the specified or default type unmodified.
- xml
This MAY be used only on properties schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property.
- Graph
- Supertypes
- trait Serializabletrait Producttrait Equalstrait Definitiontrait Schematrait SchemaOrReferenceclass Objecttrait Matchableclass Any
Inherited types
The names of the product elements
The name of the type