swagger-api / swagger-api/swagger.io-docs
Possible issue with an example illustrating a point non-ideally
Nobody has claimed this yet.
- Dominant language
- Astro
- Stars
- 1.6k
- Forks
- 407
- Avg merge
- 2m
- Merged PRs (30d)
- 2
Description
In the example with the next cursor value Q1MjAwNz (on the Links page at https://swagger.io/docs/specification/links/), the limit value supplied in the query string is 100, but the count returned under the metadata is 10. It therefore seems odd to talk about a next cursor, unless it evaluates to something like NULL. Minor point, but if correct, then simply incrementing the count value may increase understandability. May I recommend 237?
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 Links page and inspect the example containing the next cursor value Q1MjAwNz. Verify whether the limit of 100 conflicts with the metadata count of 10, then update the example if appropriate and confirm that the revised values make the explanation understandable.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100