Well-known URI building rules
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 125
- Forks
- 41
- PR merge metrics
- No merged PRs in 30d
Description
VCI currently has the following text:
The Credential Issuer's configuration can be retrieved using the Credential Issuer Identifier.Credential Issuers publishing metadata MUST make a JSON document available at the path formed by inserting the string /.well-known/openid-credential-issuer into the Credential Issuer Identifier between the host component and the path component, if any.
For example, the metadata for the Credential Issuer Identifier https://issuer.example.com/tenant would be retrieved from https://issuer.example.com/.well-known/openid-credential-issuer/tenant. The metadata for the Credential Issuer Identifier https://tenant.issuer.example.com would be retrieved from https://tenant.issuer.example.com/.well-known/openid-credential-issuer.
Practically, https://tenant.issuer.example.com is the same as https://tenant.issuer.example.com/. Following the text in the first paragraph, the metadata for the URL with the trailing slash should reside at https://tenant.issuer.example.com/.well-known/openid-credential-issuer/ (note the trailing slash) and not at https://tenant.issuer.example.com/.well-known/openid-credential-issuer (without the trailing slash).
Since it is very common to omit the trailing slash in URLs without paths, I think that one of the following choices should be made by VCI:
- allow both forms for cases where the issuer URL does not contain a path component (
https://example.comandhttps://example.com/), or - RECOMMEND to use and accept the trail-less well-known URL in such cases.
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 quoted VCI well-known URI building rules and compare the behavior for issuer identifiers with and without a trailing slash. Review the surrounding specification text, then update the rules to explicitly choose whether both forms are accepted or whether the trail-less URL is recommended; done means the two examples and resulting retrieval paths are unambiguous.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100