Add keys to reporting API feature #2601
Open
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
github-actions
bot
added
the
feature definition
| @@ -1,7 +1,39 @@ | |||
| name: Reporting API | |||
| description: The Reporting API makes consistent reports about Content Security Policy violations, Permissions-Policy violations, deprecated feature usage, crashes, and other web platform features available to your server endpoints. | |||
| spec: https://w3c.github.io/reporting/ | |||
| description: The `Reporting-Endpoints` HTTP header specifies URLs to receive reports of Content Security Policy (CSP) violations, Permissions-Policy violations, deprecated feature usage, and crashes, while the `ReportingObsever()` API dispatches reports to a callback function. | |||
There was a problem hiding this comment.
I know we usually try to mention entry points first in the description, but reversing the order of things makes it clearer to me. Up to you which one you prefer:
Suggested change
| description: The `Reporting-Endpoints` HTTP header specifies URLs to receive reports of Content Security Policy (CSP) violations, Permissions-Policy violations, deprecated feature usage, and crashes, while the `ReportingObsever()` API dispatches reports to a callback function. | |
| description: Content Security Policy (CSP) violations, Permissions-Policy violations, deprecated feature usage, and crashes can be sent to server endpoints by using the `Reporting-Endpoints` HTTP header, and to JavavaScript callback functions by using the `ReportingObserver()` API |
There was a problem hiding this comment.
I'm realizing that the description doesn't mention browser interventions. If I'm correct, there are 5 types of reports: csp, deprecation, crashes, permissions, and interventions. If we list the first 4, we should add the 5th to the list.
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 brings many more keys under the umbrella of the reporting API feature.
I lightly revised the description to match how handle other features, by naming the entry points.
The discussion on #2397 notwithstanding, the description of the feature included the whole kitchen sink, so I moved all the keys for the reporting API here, including the CSP-related keys.