swagger-api / swagger-api/swagger.io-docs
Invalid syntax in example for `response` property under Reusing Responses section
Nobody has claimed this yet.
- Dominant language
- Astro
- Stars
- 1.6k
- Forks
- 407
- Avg merge
- 2m
- Merged PRs (30d)
- 2
Description
The response property I believe should be responses under the Reusing Responses section of the documentation page for Describing Responses. I've included a snippet of the portion of the example spec below for reference.
paths:
/users:
get:
summary: Gets a list of users.
response:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayOfUsers'
'401':
$ref: '#/components/responses/Unauthorized' # <-----
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 Describing Responses documentation page and inspect the Reusing Responses section, especially the example spec shown in the issue. Verify the property name against the surrounding response examples and OpenAPI syntax. Done means the example uses the correct property name and remains valid and consistent with the documented reusable response reference.
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
- 50/100