Updated Schema Object
MODIFY
versions/3.0.md
versions/3.0.md
@@ -2260,18 +2260,14 @@ $ref: 'definitions.yaml#/Pet'
The Schema Object allows the definition of input and output data types.
These types can be objects, but also primitives and arrays.
-This object is based on the [JSON Schema Specification Draft 4](http://json-schema.org/) and uses a predefined subset of it.
-On top of this subset, there are extensions provided by this specification to allow for more complete documentation.
+This object is an extended subset of the [JSON Schema Specification Draft 4](http://json-schema.org/).
Further information about the properties can be found in [JSON Schema Core](http://json-schema.org/latest/json-schema-core.html) and [JSON Schema Validation](http://json-schema.org/latest/json-schema-validation.html).
Unless stated otherwise, the property definitions follow the JSON Schema specification as referenced here.
The following properties are taken directly from the JSON Schema definition and follow the same specifications:
-- $ref - As a [JSON Reference](https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03)
-- format (See [Data Type Formats](#dataTypeFormat) for further details)
+
- title
-- description ([CommonMark syntax](http://spec.commonmark.org/) can be used for rich text representation)
-- default (Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object)
- multipleOf
- maximum
- exclusiveMaximum
@@ -2287,25 +2283,32 @@ The following properties are taken directly from the JSON Schema definition and
- minProperties
- required
- enum
-- type
The following properties are taken from the JSON Schema definition but their definitions were adjusted to the OpenAPI Specification.
-Their definition is the same as the one from JSON Schema, only where the original definition references the JSON Schema definition, the [Schema Object](#schemaObject) definition is used instead.
-- items
-- allOf
-- oneOf
-- anyOf
-- not
-- properties
-- additionalProperties
+- type - Value MUST be a string. Multiple types via an array are not supported.
+- allOf - Inline or referenced schema MUST be of a [Schema Object](#schemaObject) and not a standard JSON Schema.
+- oneOf - Inline or referenced schema MUST be of a [Schema Object](#schemaObject) and not a standard JSON Schema.
+- anyOf - Inline or referenced schema MUST be of a [Schema Object](#schemaObject) and not a standard JSON Schema.
+- not - Inline or referenced schema MUST be of a [Schema Object](#schemaObject) and not a standard JSON Schema.
+- items - Value MUST be an object and not an array. Inline or referenced schema MUST be of a [Schema Object](#schemaObject) and not a standard JSON Schema. `items` MUST be present of the `type` is `array`.
+- properties - Property definitions MUST be a [Schema Object](#schemaObject) and not a standard JSON Schema (inline or referenced).
+- additionalProperties - Value can be boolean or object. If object, definition MUST be a [Schema Object](#schemaObject) and not a standard JSON Schema (inline or referenced).
+- $ref - As a [Reference Object](#referenceObject).
+- description ([CommonMark syntax](http://spec.commonmark.org/) can be used for rich text representation).
+- format - See [Data Type Formats](#dataTypeFormat) for further details. While relying on JSON Schema's defined formats, the OAS offers a few additional predefined formats.
+- default - Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.
+
+Additional properties defined by the JSON Schema specification that are not mentioned here are strictly unsupported.
Other than the JSON Schema subset fields, the following fields may be used for further schema documentation.
##### Fixed Fields
Field Name | Type | Description
---|:---:|---
-<a name="schemaDiscriminator"></a>discriminator | `string` | Adds support for polymorphism. The discriminator is the schema property name that is used to differentiate between other schema that inherit this schema. The property name used MUST be defined at this schema and it MUST be in the `required` property list. When used, the value MUST be the name of this schema or any schema that inherits it.
-<a name="schemaReadOnly"></a>readOnly | `boolean` | Relevant only for Schema `"properties"` definitions. Declares the property as "read only". This means that it MAY be sent as part of a response but MUST NOT be sent as part of the request. Properties marked as `readOnly` being `true` SHOULD NOT be in the `required` list of the defined schema. Default value is `false`.
+<a name="schemaNullable"></a>nullable | `boolean` | Allows sending a `null` value for the defined schema. Default value is `false`.
+<a name="schemaDiscriminator"></a>discriminator | `string` | Adds support for polymorphism. The discriminator is the schema property name that is used to differentiate between other schema that inherit this schema. The property name used MUST be defined at this schema and it MUST be in the `required` property list. When used, the value MUST be the name of this schema or any schema that inherits it. See [Composition and Inheritance](#schemaComposition) for more details.
+<a name="schemaReadOnly"></a>readOnly | `boolean` | Relevant only for Schema `"properties"` definitions. Declares the property as "read only". This means that it MAY be sent as part of a response but MUST NOT be sent as part of the request. If property is marked as `readOnly` being `true` and is in the `required` list, the `required` will take effect on the response only. A property MUST NOT be marked as both `readOnly` and `writeOnly` being `true`. Default value is `false`.
+<a name="schemaWriteOnly"></a>writeOnly | `boolean` | Relevant only for Schema `"properties"` definitions. Declares the property as "write only". This means that it MAY be sent as part of a request but MUST NOT be sent as part of the response. If property is marked as `writeOnly` being `true` and is in the `required` list, the `required` will take effect on the request only. A property MUST NOT be marked as both `readOnly` and `writeOnly` being `true`. Default value is `false`.
<a name="schemaXml"></a>xml | [XML Object](#xmlObject) | This MAY be used only on properties schemas. It has no effect on root schemas. Adds Additional metadata to describe the XML representation format of this property.
<a name="schemaExternalDocs"></a>externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation for this schema.
<a name="schemaExample"></a>example | Any | A free-form property to include an example of an instance for this schema.
@@ -2314,7 +2317,7 @@ Field Name | Type | Description
This object can be extended with [Specification Extensions](#specificationExtensions).
-###### Composition and Inheritance (Polymorphism)
+###### <a name="schemaComposition"></a>Composition and Inheritance (Polymorphism)
The OpenAPI Specification allows combining and extending model definitions using the `allOf` property of JSON Schema, in effect offering model composition.
`allOf` takes in an array of object definitions that are validated *independently* but together compose a single object.
@@ -2323,7 +2326,9 @@ While composition offers model extensibility, it does not imply a hierarchy betw
To support polymorphism, OpenAPI Specification adds the support of the `discriminator` field.
When used, the `discriminator` will be the name of the property used to decide which schema definition is used to validate the structure of the model.
As such, the `discriminator` field MUST be a required field.
-The value of the chosen property has to be the friendly name given to the model under the `definitions` property.
+There are are two ways to define the value of a discriminator for an inheriting instance.
+- Use the definition's name.
+- Override the definition's name by overriding the property with a new value. If exists, this takes precedence over the definition's name.
As such, inline schema definitions, which do not have a given id, *cannot* be used in polymorphism.
###### XML Modeling
@@ -2335,8 +2340,6 @@ The [XML Object](#xmlObject) contains additional information about the available
###### Primitive Sample
-Unlike previous versions of Swagger, OpenAPI Schema definitions can be used to describe primitive and arrays as well.
-
```json
{
"type": "string",
@@ -2362,7 +2365,7 @@ format: email
"type": "string"
},
"address": {
- "$ref": "#/definitions/Address"
+ "$ref": "#/components/definitions/Address"
},
"age": {
"type": "integer",
@@ -2381,7 +2384,7 @@ properties:
name:
type: string
address:
- $ref: '#/definitions/Address'
+ $ref: '#/components/definitions/Address'
age:
type: integer
format: int32
@@ -2413,7 +2416,7 @@ For a string to model mapping:
{
"type": "object",
"additionalProperties": {
- "$ref": "#/definitions/ComplexModel"
+ "$ref": "#/components/definitions/ComplexModel"
}
}
```
@@ -2421,7 +2424,7 @@ For a string to model mapping:
```yaml
type: object
additionalProperties:
- $ref: '#/definitions/ComplexModel'
+ $ref: '#/components/definitions/ComplexModel'
```
###### Model with Example
@@ -2599,7 +2602,7 @@ definitions:
]
},
"Cat": {
- "description": "A representation of a cat",
+ "description": "A representation of a cat. Note that `Cat` will be used as the discriminator value.",
"allOf": [
{
"$ref": "#/definitions/Pet"
@@ -2626,7 +2629,7 @@ definitions:
]
},
"Dog": {
- "description": "A representation of a dog",
+ "description": "A representation of a dog. Note that `Dog` will be used as the discriminator value.",
"allOf": [
{
"$ref": "#/definitions/Pet"
@@ -2665,7 +2668,7 @@ definitions:
required:
- name
- petType
- Cat:
+ Cat: ## "Cat" will be used as the discriminator value
description: A representation of a cat
allOf:
- $ref: '#/definitions/Pet'
@@ -2682,7 +2685,7 @@ definitions:
- aggressive
required:
- huntingSkill
- Dog:
+ Dog: ## "Dog" will be used as the discriminator value
description: A representation of a dog
allOf:
- $ref: '#/definitions/Pet'

Updated Schema Object