swagger-api / swagger-api/swagger.io-docs
Description not correct in example - runtime-expressions
Open
Beginner friendly
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/links/#runtime-expressions
$response.body#/foo/bar | A portion of the request body specified by a JSON Pointer.
It should say response instead of request
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the runtime-expressions documentation at the linked swagger.io page and search for the example containing "$response.body#/foo/bar". Change the description so it refers to a response body rather than a request body, then verify the rendered example uses the corrected wording.
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
- 65/100