swagger-api / swagger-api/swagger.io-docs

"Describing parameters" says "Accept" is part of the response when it is not

Open Beginner friendly
#307 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Astro
Stars
1.6k
Forks
407
Avg merge
2m
Merged PRs (30d)
2

Description

https://swagger.io/docs/specification/describing-parameters/ check under "Header Parameters" and the table, where it says "Accept". It says it is part of responses.<code>.content.<media-type> and the link in the last column also links to response.

But Accept is part of a request.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the linked Describing Parameters documentation and inspect the Header Parameters table, especially the Accept row and its final-column link. Correct the references so the page consistently describes Accept as a request parameter, then verify the table and links no longer describe it as part of a response.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
76/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.