Skip to content

Add type to alternatives in JSONSchema #2697

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.

Sign up for GitHub

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

Merged
ddbeck merged 2 commits into from
Feb 27, 2025
Merged

Add type to alternatives in JSONSchema #2697

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0422e14
Add type to `alternatives` in JSONSchema
jcscottiii Feb 24, 2025
9ebb280
Fix types generation
ddbeck Feb 27, 2025
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
4 changes: 3 additions & 1 deletion schemas/data.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,9 @@
},
"alternatives": {
"description": "IDs for features that substitute some or all of this feature's utility",
"items": {},
"items": {
"type": "string"
},
"type": "array"
}
},
Expand Down
6 changes: 5 additions & 1 deletion types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,11 @@ interface Discouraged {
/** Links to a formal discouragement notice, such as specification text, intent-to-unship, etc. */
according_to: string[];
/** IDs for features that substitute some or all of this feature's utility */
alternatives?: (keyof WebFeaturesData["features"])[];
alternatives?: string[];
// TODO: alternatives ought to be `(keyof WebFeaturesData["features"])[]`
// but ts-json-schema-generator seems to have long-standing unresolved bugs
// around this. Remove this when
// https://github.com/web-platform-dx/web-features/issues/2722 is resolved.
}

export interface GroupData {
Expand Down