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

Add accepts_flags to the browsers schema as an optional hint #11286

Merged
merged 2 commits into from
Aug 17, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions browsers/samsunginternet_android.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"browsers": {
"samsunginternet_android": {
"name": "Samsung Internet",
"accepts_flags": false,
"releases": {
"1.0": {
"release_date": "2013-04-27",
Expand Down
1 change: 1 addition & 0 deletions browsers/webview_android.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"browsers": {
"webview_android": {
"name": "WebView Android",
"accepts_flags": false,
"releases": {
"1": {
"release_date": "2008-09-23",
Expand Down
8 changes: 8 additions & 0 deletions schemas/browsers-schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,10 @@ Underneath, there is a `releases` object which will hold the various releases of

The `name` string is a required property which should use the browser brand name and avoid English words if possible, for example `"Firefox"`, `"Firefox Android"`, `"Safari"`, `"iOS Safari"`, etc.

### `accepts_flags`

An optional boolean indicating whether the browser supports flags. This is a hint to data contributors and tools. A `true` value does not mean that there exists any flag data for the browser and a `false` value does not guarantee a lack of flag data for the browser.

### `pref_url`

An optional string containing the URL of the page where feature flags can be changed (e.g. `"about:config"` for Firefox or `"chrome://flags"` for Chrome).
Expand All @@ -62,6 +66,10 @@ The release objects consist of the following properties:

- An optional `release_notes` property which points to release notes. It needs to be a valid URL.

- An optional `accepts_flags` boolean property indicating whether the release supports flags.

This is a hint to data contributors and tools. A `true` value does not mean that there exists any flag data for the release and a `false` value does not guarantee a lack of flag data for the release.

- An optional `engine` property which is the name of the browser's engine.

- An optional `engine_version` property which is the version of the browser's engine. This may or may not differ from the browser version.
Expand Down
8 changes: 8 additions & 0 deletions schemas/browsers.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@
"type": "string",
"description": "Browser name, avoid using unnecessary English (e.g. prefer 'Chrome Android' over 'Chrome for Android')."
},
"accepts_flags": {
"type": "boolean",
"description": "Whether the browser supports flags."
},
"pref_url": {
"type": "string",
"description": "URL of the page where feature flags can be changed (e.g. 'about:config' or 'chrome://flags')."
Expand All @@ -56,6 +60,10 @@
"format": "uri",
"description": "A link to the release notes or changelog for a given release."
},
"accepts_flags": {
"type": "boolean",
"description": "Whether the release supports flags."
},
"engine": {
"type": "string",
"enum": ["Blink", "EdgeHTML", "Gecko", "Presto", "Trident", "WebKit", "V8"],
Expand Down