Skip to content
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

Jump to bottom

Add example for getting map of all header values as parameter #338

Open
wants to merge 1 commit into
base: wordpress
Choose a base branch
from
Open

Add example for getting map of all header values as parameter #338

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
16 changes: 16 additions & 0 deletions docs/spec-explained/parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,22 @@ paths:
required: true
```

Or, you would get all headers within a map as follows:

```
paths:
/ping:
get:
summary: Checks if the server is alive.
parameters:
- in: header
name: headers
schema:
type: object
additionalProperties:
type: string
```

In a similar way, you can define [custom response headers](#header-parameters).

**Note:** Swagger specification has special keywords for some headers:
Expand Down