docs(spec): fix section 6.9 formatting and add credential examples#1869
docs(spec): fix section 6.9 formatting and add credential examples#1869evan-cohen wants to merge 9 commits into
Conversation
Steps 2 and 3 in section 6.9 were using `<h3>` elements, causing them to incorrectly appear as direct children of section 6.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the formatting in docs/specification.md by changing the headers for Step 2 and Step 3 to bold text. A review comment suggests adding a trailing colon to the Step 3 label to maintain consistency with other similar labels in the documentation.
|
|
||
| ### Step 2: Client obtains credentials (out-of-band OAuth 2.0 flow) | ||
| **Step 2: Client obtains credentials (out-of-band OAuth 2.0 flow):** | ||
|
|
There was a problem hiding this comment.
Nice work! For Step 2, I feel we are missing some info.
Can you check ?
There was a problem hiding this comment.
Not sure I'm following. I'm only changing the formatting here to remove the steps from the sidebar.
I'd imagine this section doesn't have a corresponding code block because this example isn't opinionated on a certain OAuth2 grant type. I've added a client credentials grant example, but please let me know if this isn't what you intended.
Added example HTTP request and response for obtaining credentials using OAuth2 client credentials grant;.
| ```http | ||
| POST /token HTTP/1.1 | ||
| Host: authorization-server.example.com | ||
| Authorization: Basic dXNlcjpwYXNz |
There was a problem hiding this comment.
| Authorization: Basic dXNlcjpwYXNz | |
| Authorization: Bearer token |
There was a problem hiding this comment.
I don't understand this suggestion. This HTTP request represents an OAuth2 client credentials grant using basic auth against the token endpoint of an authorization server. The "dXNlcjpwYXNz" magic string is the base64-encoded representation of "user:pass". Is there an alternate placeholder you'd prefer?
|
|
||
| ```json | ||
| { | ||
| "access_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", |
There was a problem hiding this comment.
| "access_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", | |
| "access_token": "...", |
There was a problem hiding this comment.
I used this partial JWT to be consistent with section 3.6.1, but I can deviate from that if you'd prefer.
|
@evan-cohen Please joing next A2A meeting to share and drive this effort. Discord & Meeting Details are in Governence.md file of this repo. |
msampathkumar
changed the title
msampathkumar
changed the title
|
I tried to apply the feedback from your suggestions. Please let me know if you had a different idea in mind. |
2 participants
Steps 2 and 3 in section 6.9 were using
<h3>elements, causing them to incorrectly appear as direct children of section 6.https://a2a-protocol.org/latest/specification/#69-fetching-authenticated-extended-agent-card