Skip to content

Commit 4cdcab3

Browse files
committed
Add description to the Example Object
1 parent 02df675 commit 4cdcab3

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

versions/3.0.4.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1997,6 +1997,10 @@ transactionCallback:
19971997
```
19981998

19991999
#### <a name="exampleObject"></a>Example Object
2000+
An object grouping an internal or external example value with basic `summary` and `description` metadata.
2001+
This object is typically used in properties named `examples` (plural), and is a [referenceable](#referenceObject) alternative to older `example` (singular) fields that do not support referencing or metadata.
2002+
2003+
Allows sharing an example to demonstrate the usage of properties, parameters and objects within OpenAPI.
20002004

20012005
##### Fixed Fields
20022006
Field Name | Type | Description

0 commit comments

Comments
 (0)