Fixes for Example object
MODIFY
versions/3.0.md
versions/3.0.md
@@ -765,7 +765,7 @@ Field Name | Type | Description
<a name="parameterExplode"></a>explode | `boolean` | When this is true, parameter values of type `array` or `object` generate seperate parameters for each value of the array, or key-value-pair of the map. For other types of parameters this property has no effect. When [`style`](#parameterStyle) is `form`, the default value is `true`. For all other styles, the default value is `false`.
<a name="parameterAllowReserved"></a>allowReserved | `boolean` | Determines whether the parameter value should allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. This property only applies to parameters with an `in` value of `query`. The default value is `false`.
<a name="parameterSchema"></a>schema | [Schema Object](#schemaObject) | The schema defining the type used for the parameter.
-<a name="parameterExamples"></a>examples | [Examples Array](#examplesArray) | Examples of the content type. Each example in the Examples Array must be in the correct format as specified parameter encoding. The `examples` object is mutually exclusive to the `example` object. Furthermore, if referencing a `schema` which contains an example, the `examples` value will _override_ the example provided by the schema.
+<a name="parameterExamples"></a>examples | [[Example Object](#exampleObject)] | Examples of the content type. Each example in the Examples Array must be in the correct format as specified parameter encoding. The `examples` object is mutually exclusive to the `example` object. Furthermore, if referencing a `schema` which contains an example, the `examples` value will _override_ the example provided by the schema.
<a name="parameterExample"></a>example | [Example Object](#exampleObject) | Example of the content type. The example object _must_ be in the correct format as specified in the parameter encoding. The `example` object is mutually exclusive to the `examples` object. Furthermore, if referencing a `schema` which contains an example, the `example` value will _override_ the example provided by the the schema.
For more complex scenarios a `content` object can be used to define the media-type
@@ -1646,21 +1646,15 @@ X-Rate-Limit-Reset:
type: integer
```
-#### <a name="examplesObject"></a>Examples Object
+#### <a name="exampleObject"></a>Example Object
Allows sharing examples for operation requests and responses.
-##### Patterned Fields
-Field Pattern | Type | Description
----|:---:|---
-<a name="exampleMediaType"></a>{[media type](#mediaTypes)} | Any | The name of the property MUST be one of the Operation `produces` values (either implicit or inherited). The value SHOULD be an example of what such a response would look like.
-
-##### Examples Array Example
+##### Example Example
Example representation for application/json media type of a Pet data type:
```json
-[
{
"name": "Puma",
"type": "Dog",
@@ -1668,16 +1662,16 @@ Example representation for application/json media type of a Pet data type:
"gender": "Female",
"breed": "Mixed"
}
-]
```
```yaml
--
+
name: Puma
type: Dog
color: Black
gender: Female
breed: Mixed
+
```
#### <a name="linksObject"></a>Links Object

Fixes for Example object