swagger-api / swagger-api/swagger.io-docs
Misuse of "URI" in definition of $ref
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/v3_0/using-ref/ says
the $ref string value (JSON Reference) should contain a URI,
but the examples given show that it is not actually a URI. It seems like the correct term here would be "URI reference."
From https://www.ietf.org/rfc/rfc3986.txt -
A URI-reference is either a URI or a relative reference.
URI-reference = URI / relative-ref
Most of the examples are relative references.
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
Start with the linked using-$ref documentation page and compare its wording and examples with RFC 3986, especially the URI-reference definition. Update the terminology so it accurately describes relative references as well as URIs, then verify that the examples and surrounding explanation remain consistent.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 72/100