otto-de / otto-de/api-guidelines
[define] evaluate proposed w3c standard "Content Negotiation by Profile"
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 50
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
Description
(i) This issue has been manually transferred from a former internal repository, as a private repository issue cannot be transferred to a public repository.
Context
W3C proposed a standard to use profiles in content negotiation: https://w3c.github.io/dx-connegp/connegp/
It differs from the way we use profiles. Instead of using the profile as a media type parameter, it is used as a separate header Accept-Profile and Content-Profile in content negotiation.
Depending on the outcome of https://github.com/w3c/dx-connegp/issues/41, we should evaluate if it makes sense to adapt to the w3c proposal.
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 by reading the linked W3C Content Negotiation by Profile proposal and the outcome of w3c/dx-connegp#41. Compare its Accept-Profile and Content-Profile headers with the project's current use of profiles as media type parameters; done means documenting whether adaptation makes sense.
Written by the indexing model from the issue text.
Assessment
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100