Document the k6/experimental/webcrypto module #1119
Merged
Conversation
This file contains hidden or 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
|
There's a version of the docs published here: https://mdr-ci.staging.k6.io/docs/refs/pull/1119/merge It will be deleted automatically in 30 days. |
codebien
requested changes
Apr 7, 2023
src/data/markdown/docs/02 javascript api/07 k6-experimental/06 webcrypto/02 SubtleCrypto.md
Outdated
Show resolved
Hide resolved
src/data/markdown/docs/02 javascript api/07 k6-experimental/06 webcrypto/02 SubtleCrypto.md
Show resolved
Hide resolved
src/data/markdown/docs/02 javascript api/07 k6-experimental/06 webcrypto.md
Outdated
Show resolved
Hide resolved
src/data/markdown/docs/02 javascript api/07 k6-experimental/06 webcrypto.md
Outdated
Show resolved
Hide resolved
MattDodsonEnglish
approved these changes
Apr 11, 2023
...kdown/docs/02 javascript api/07 k6-experimental/06 webcrypto/01 Crypto/01 getRandomValues.md
Outdated
Show resolved
Hide resolved
...a/markdown/docs/02 javascript api/07 k6-experimental/06 webcrypto/01 Crypto/02 randomUUID.md
Outdated
Show resolved
Hide resolved
src/data/markdown/docs/02 javascript api/07 k6-experimental/06 webcrypto/02 SubtleCrypto.md
Outdated
Show resolved
Hide resolved
src/data/markdown/docs/02 javascript api/07 k6-experimental/06 webcrypto/02 SubtleCrypto.md
Outdated
Show resolved
Hide resolved
...arkdown/docs/02 javascript api/07 k6-experimental/06 webcrypto/02 SubtleCrypto/01 decrypt.md
Outdated
Show resolved
Hide resolved
...kdown/docs/02 javascript api/07 k6-experimental/06 webcrypto/01 Crypto/01 getRandomValues.md
Outdated
Show resolved
Hide resolved
...markdown/docs/02 javascript api/07 k6-experimental/06 webcrypto/02 SubtleCrypto/02 digest.md
Outdated
Show resolved
Hide resolved
...arkdown/docs/02 javascript api/07 k6-experimental/06 webcrypto/02 SubtleCrypto/03 encrypt.md
Outdated
Show resolved
Hide resolved
...own/docs/02 javascript api/07 k6-experimental/06 webcrypto/02 SubtleCrypto/05 generateKey.md
Outdated
Show resolved
Hide resolved
...kdown/docs/02 javascript api/07 k6-experimental/06 webcrypto/02 SubtleCrypto/06 importKey.md
Outdated
Show resolved
Hide resolved
|
Just a reminder that this should get merged after we start releasing the docs for v0.44 as this is a new API |
… webcrypto.md Co-authored-by: Matt Dodson <47385188+MattDodsonEnglish@users.noreply.github.com>
… webcrypto.md Co-authored-by: Matt Dodson <47385188+MattDodsonEnglish@users.noreply.github.com>
… webcrypto/01 Crypto/01 getRandomValues.md Co-authored-by: Matt Dodson <47385188+MattDodsonEnglish@users.noreply.github.com>
… webcrypto/01 Crypto/02 randomUUID.md Co-authored-by: Matt Dodson <47385188+MattDodsonEnglish@users.noreply.github.com>
… webcrypto/02 SubtleCrypto.md Co-authored-by: Matt Dodson <47385188+MattDodsonEnglish@users.noreply.github.com>
… webcrypto/02 SubtleCrypto/01 decrypt.md Co-authored-by: Matt Dodson <47385188+MattDodsonEnglish@users.noreply.github.com>
… webcrypto/01 Crypto/01 getRandomValues.md Co-authored-by: Matt Dodson <47385188+MattDodsonEnglish@users.noreply.github.com>
… webcrypto/02 SubtleCrypto/01 decrypt.md Co-authored-by: Matt Dodson <47385188+MattDodsonEnglish@users.noreply.github.com>
… webcrypto.md Co-authored-by: Matt Dodson <47385188+MattDodsonEnglish@users.noreply.github.com>
Co-authored-by: Ivan <2103732+codebien@users.noreply.github.com> Co-authored-by: Matt Dodson <47385188+MattDodsonEnglish@users.noreply.github.com>
codebien
approved these changes
Apr 14, 2023
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.
This PR adds a dedicated documentation section for the newly introduced
k6/experimental/webcryptomodule.This was a long-haul batch of work and is probably riddled with mistakes and forgotten information. Please don't hesitate to poke and provide feedback and requests for corrections.
Although the module is not 100% on par with the specification yet, I described only the supported methods and algorithms without outlining what was missing. If you think we should write it in a clearer way somewhere, please let me know.
PS: I took a lot of inspiration from the wording used on MDN, I'd like to credit them, but then I'd need to do it everywhere. What would be the canonical way to do that?