You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: specification/docs.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ Besides machine-readable descriptions, an OpenAPI Description (OAD) can also inc
11
11
12
12
This page shows how to take full advantage of special documentation capabilities in OpenAPI like markdown syntax or example objects.
13
13
14
-
## The Documentation Fields
14
+
## The Description Field
15
15
16
16
Almost every object in the OpenAPI Specification accepts a `description` field which can provide additional information for developers, beyond what can be automatically generated from the API descriptions.
17
17
@@ -142,7 +142,7 @@ A fenced code block
142
142

143
143
```
144
144
145
-
## The Example Object
145
+
## Adding Examples
146
146
147
147
Finally, some OpenAPI objects can list examples explicitly instead of having them embedded in the `description` field, enabling automated processing by tools.
0 commit comments