Update X-Stamp docs #65
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
r-n-o
reviewed
Nov 29, 2023
docs/api-design/intro.md
Outdated
| 3. Create a JSON-encoded string with the appropriate properties depending on authenticator type: | ||
| - If using an API Key, make a JSON-encoded string with public key, signature, and signature scheme | ||
| - If using a WebAuthn Credential, make a JSON-encoded string with the authenticator data, client data, credential ID and signature | ||
| 4. Base64url encode this string |
There was a problem hiding this comment.
Unfortunately this isn't consistent right now. Webauthn stamps aren't base64url encoded, but API key stamps are.
docs/api-design/intro.md
Outdated
| - If using an API Key, make a JSON-encoded string with public key, signature, and signature scheme | ||
| - If using a WebAuthn Credential, make a JSON-encoded string with the authenticator data, client data, credential ID and signature | ||
| 4. Base64url encode this string | ||
| 5. Add this string to your request as an X-Stamp header |
There was a problem hiding this comment.
We should mention the difference in naming: webauthn stamp should be passed as X-Stamp-Webauthn header values, whereas API key stamps should be under X-Stamp.
oliviathet
force-pushed
the
olivia/update-stamp-links
branch
from
89efca2 to
d4ca992
Compare
|
lol @r-n-o that was fast! was just about to write a comment. thank you for all the helpful comments, helped w my own understanding too :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Noticed that #39 is stuck in a non-mergeable state. Closed that PR and added changes to this branch along with some fixes to Github links and wording.