Skip to content

Commit 0068ccc

Browse files
author
Ron
authored
Merge pull request OAI#1183 from krishahn/example-object
edit Example Object
2 parents a29f910 + 8078093 commit 0068ccc

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

versions/3.0.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1804,15 +1804,14 @@ Field Name | Type | Description
18041804
---|:---:|---
18051805
<a name="exampleSummary"></a>summary | `string` | Short description for the example.
18061806
<a name="exampleDescription"></a>description | `string` | Long description for the example. [CommonMark syntax](http://spec.commonmark.org/) can be used for rich text representation.
1807-
<a name="exampleValue"></a>value | Any | Embedded literal example. The `value` field and `externalValue` field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.
1808-
<a name="exampleExternalValue"></a>externalValue | `string` | A URL that points to the literal example. This provides the ability to reference examples that cannot easily be included in JSON or YAML documents. The `value` field and `externalValue` field are mutually exclusive.
1807+
<a name="exampleValue"></a>value | Any | Embedded literal example. The `value` field and `externalValue` field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary.
1808+
<a name="exampleExternalValue"></a>externalValue | `string` | A URL that points to the literal example. This provides the capability to reference examples that cannot easily be included in JSON or YAML documents. The `value` field and `externalValue` field are mutually exclusive.
18091809

18101810
This object can be extended with [Specification Extensions](#specificationExtensions).
18111811

18121812
In all cases, the example value is expected to be compatible with the type schema
1813-
for the value that it is accompanying. Tooling implementations MAY choose to
1814-
validate compatibility automatically, and reject the example value(s) if they
1815-
are not compatible.
1813+
of its associated value. Tooling implementations MAY choose to
1814+
validate compatibility automatically, and reject the example value(s) if incompatible.
18161815

18171816
##### Example Object Example
18181817

0 commit comments

Comments
 (0)