Remove Examples Object
MODIFY
versions/3.0.1.md
versions/3.0.1.md
@@ -2183,68 +2183,6 @@ name: pet
description: Pets operations
```
-#### <a name="examplesObject"></a>Examples Object
-
-In an `example`, a JSON Reference MAY be used, with the
-explicit restriction that examples having a JSON format with object named
-`$ref` are not allowed. Therefore, that `example`, structurally, can be
-either a string primitive or an object, similar to `additionalProperties`.
-
-In all cases, the payload is expected to be compatible with the type schema
-for the associated value. Tooling implementations MAY choose to
-validate compatibility automatically, and reject the example value(s) if they
-are incompatible.
-
-```yaml
-# in a model
-schemas:
- properties:
- name:
- type: string
- example:
- $ref: http://foo.bar#/examples/name-example
-
-# in a request body, note the plural `examples`
- requestBody:
- content:
- 'application/json':
- schema:
- $ref: '#/components/schemas/Address'
- examples:
- foo:
- value: {"foo": "bar"}
- bar:
- value: {"bar": "baz"}
- 'application/xml':
- examples:
- xml:
- externalValue: 'http://foo.bar/examples/address-example.xml'
- 'text/plain':
- examples:
- text:
- externalValue: 'http://foo.bar/examples/address-example.txt'
-
-# in a parameter
- parameters:
- - name: 'zipCode'
- in: 'query'
- schema:
- type: 'string'
- format: 'zip-code'
- example:
- $ref: 'http://foo.bar#/examples/zip-example'
-
-# in a response, note the singular `example`:
- responses:
- '200':
- description: your car appointment has been booked
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SuccessResponse'
- example:
- $ref: http://foo.bar#/examples/address-example.json
-```
#### <a name="referenceObject"></a>Reference Object

Remove Examples Object