"Request URI Method post" and "Request URI Endpoint"
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 112
- Forks
- 38
- Avg merge
- 12d 19h
- Merged PRs (30d)
- 4
Description
For a fresh eye reader, these terms appear without being given an explicit definition/explanation.
What I inferred from this document is that "Request URI Endpoint" is an extended version of request_uri defined in RFC9101.
While the request_uri in RFC9101 only accepts GET to simply return the request object, this extended version allows wallet to send POST request with wallet metadata in the body so that the verifier can customize the request object to meet the wallet requirements.
Ideally, this should be stated clearly.
Also, the "Request URI Method post" seems to be a stub text in search of a better name. It appears only once in the main text.
So, I would like to propose a bit of restructuring to section 5.11. as follows.
5.11. Request URI Endpoint {#request_uri_endpoint}
This document extends request_uri defined in [@RFC9101] so that it can accept wallet metadata using the payload of HTTP POST method.
This extended request_uri is called Request URI Endpoint in this document.
Request URI Endpoint is an endpoint provided by the verifier to wallets.
Wallets MAY send their metadata to this endpoint to obtain the Request Object.
5.11.1. Request URI Endpoint Request
When sending the request, Wallets
- MUST use the HTTP POST method with the https scheme;
- MUST set the content type to application/oauth-authz-req+jwt; and
- MUST encode the names and values using UTF-8.
Wallets MAY include the following parameters in the request.
wallet_metadata:
: OPTIONAL. A String containing a JSON object containing metadata parameters as defined in (#as_metadata_parameters).
(..snip.. the text is good here)
5.11.2. Request URI Endpoint Response
(..snip..)
5.11.3. Request URI Endpoint Error Response
(..snip..)
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 at section 5.11 of the document and compare the existing headings and definitions with the proposed restructuring. Clarify the relationship to request_uri from RFC9101, define Request URI Endpoint and its POST request, and replace the unclear “Request URI Method post” wording. Done means the terminology and subsections are unambiguous and consistent with the existing text.
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
- Mostly clear
- Newbie friendliness
- 45/100