Skip to content

Commit 23bfa2f

Browse files
authored
Merge pull request #63 from dret/patch-1
minor fixes
2 parents efc90bc + 20f5f15 commit 23bfa2f

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

specification/docs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Besides machine-readable descriptions, an OpenAPI Description (OAD) can also inc
1111

1212
This page shows how to take full advantage of special documentation capabilities in OpenAPI like markdown syntax or example objects.
1313

14-
## The Documentation Fields
14+
## The Description Field
1515

1616
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.
1717

@@ -142,7 +142,7 @@ A fenced code block
142142
![Alt text](Image URL)
143143
```
144144

145-
## The Example Object
145+
## Adding Examples
146146

147147
Finally, some OpenAPI objects can list examples explicitly instead of having them embedded in the `description` field, enabling automated processing by tools.
148148

0 commit comments

Comments
 (0)