microsoft / microsoft/api-guidelines
how to identify canonical URIs (section 7.3)
Open
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 23.3k
- Forks
- 2.7k
- PR merge metrics
- No merged PRs in 30d
Description
what about recommending that resources specifying canonical URIs should do so using the "canonical" link relation type as specified in https://tools.ietf.org/html/rfc6596? that would help to make those canonical links more easily discoverable across APIs.
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 section 7.3 of the API guidelines and compare its canonical URI guidance with RFC 6596. Done means deciding whether to recommend the "canonical" link relation type and updating that section to state the guidance clearly if accepted.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 38/100