Skip to content

add some readme shortcuts for important sections #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 13, 2022
Merged

add some readme shortcuts for important sections #72

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,16 @@ Options:
--postmanCollection -p Will generate a postman collection (from the generated openAPI documentation), in json only, if passed in. Default postman.json
```

### README Highlighted Reading

#### Security Details
* [Security](#securityschemes)
* [Security on All Operations](#security-on-each-operation)
* [Security Per Operation](#security)
#### Model Details
* [Models](#models)
* [Notes on Schemas](#notes-on-schemas)

### OpenAPI Mapping

| OpenAPI field | Serverless field |
Expand Down Expand Up @@ -184,6 +194,7 @@ custom:
```

Name is required but `url` is optional and must be in the format of a url.

#### Extended Fields

You can also add extended fields to the documentation object:
Expand Down