Skip to content

Commit fa5609e

Browse files
authored
Merge pull request #72 from JaredCE/readme-shortcuts
add some readme shortcuts for important sections
2 parents 861cac9 + 4263d80 commit fa5609e

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,16 @@ Options:
5252
--postmanCollection -p Will generate a postman collection (from the generated openAPI documentation), in json only, if passed in. Default postman.json
5353
```
5454

55+
### README Highlighted Reading
56+
57+
#### Security Details
58+
* [Security](#securityschemes)
59+
* [Security on All Operations](#security-on-each-operation)
60+
* [Security Per Operation](#security)
61+
#### Model Details
62+
* [Models](#models)
63+
* [Notes on Schemas](#notes-on-schemas)
64+
5565
### OpenAPI Mapping
5666

5767
| OpenAPI field | Serverless field |
@@ -184,6 +194,7 @@ custom:
184194
```
185195

186196
Name is required but `url` is optional and must be in the format of a url.
197+
187198
#### Extended Fields
188199

189200
You can also add extended fields to the documentation object:

0 commit comments

Comments
 (0)