Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix issue 33356: Document integrity properly #34406

Closed
wants to merge 4 commits into from

Conversation

wbamberg
Copy link
Collaborator

Fixes #33356.

@wbamberg wbamberg requested a review from a team as a code owner June 25, 2024 18:03
@wbamberg wbamberg requested review from sideshowbarker and removed request for a team June 25, 2024 18:03
@github-actions github-actions bot added Content:WebAPI Web API docs size/s [PR only] 6-50 LoC changed labels Jun 25, 2024
Copy link
Contributor

github-actions bot commented Jun 25, 2024

Preview URLs

(comment last updated: 2024-06-26 08:23:19)

@Josh-Cena
Copy link
Member

I'm not sure if this page is the right place to document it as it's a simple reflector of the internal state of the request. It should probably be on the Request() and/or fetch() page (before we merge them, that is), and a brief mention can be put here.

@wbamberg
Copy link
Collaborator Author

I'm not sure if this page is the right place to document it as it's a simple reflector of the internal state of the request. It should probably be on the Request() and/or fetch() page (before we merge them, that is), and a brief mention can be put here.

I did think about this, and the reason I went with here is that we have a whole page to talk about it here, and it's nice to be able to use that space. If we document it in the constructor or fetch() (or even RequestInit) we'd only have one page to cover all the options, and it would get huge. We do something similar in (for example) https://developer.mozilla.org/en-US/docs/Web/API/Request/cache.

Alternative I suppose would be to create subpages for RequestInit, although we usually don't, for dictionaries.

@Josh-Cena
Copy link
Member

We can either make a tree for RequestInit, or alternatively just have fetch/integrity, fetch/cache, etc. Not easy to design 😅

I don't have strong opinions against this either. The WebAPI information is really all over the place (especially HTML element stuff).

@wbamberg
Copy link
Collaborator Author

I think the best alternative is inline in RequestInit, and I'm happy to try that when it exists.

Copy link
Member

@estelle estelle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! 🎉

@Josh-Cena
Copy link
Member

@wbamberg Do you want to merge this or to move the content to RequestInit instead?

@wbamberg
Copy link
Collaborator Author

I put all the relevant stuff in the other PR: https://pr34437.content.dev.mdn.mozit.cloud/en-US/docs/Web/API/RequestInit#integrity so think we can close this PR without merging.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:WebAPI Web API docs size/s [PR only] 6-50 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Subresource Integrity check on Request instance with integrity property
3 participants