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

Allow shortName in w3c.json? #78

Open
foolip opened this issue Dec 16, 2019 · 5 comments
Open

Allow shortName in w3c.json? #78

foolip opened this issue Dec 16, 2019 · 5 comments

Comments

@foolip
Copy link
Member

foolip commented Dec 16, 2019

A bunch of repos already have shortName in w3c.json:
https://github.com/immersive-web/webxr/blob/master/w3c.json
https://github.com/immersive-web/webxr-ar-module/blob/master/w3c.json
https://github.com/immersive-web/webxr-gamepads-module/blob/master/w3c.json
https://github.com/w3c/accelerometer/blob/master/w3c.json
https://github.com/w3c/alt-techniques/blob/gh-pages/w3c.json
https://github.com/w3c/ambient-light/blob/gh-pages/w3c.json
https://github.com/w3c/battery/blob/gh-pages/w3c.json
https://github.com/w3c/beacon/blob/gh-pages/w3c.json
https://github.com/w3c/clipboard-apis/blob/master/w3c.json
https://github.com/w3c/danmaku/blob/master/w3c.json
https://github.com/w3c/device-memory/blob/master/w3c.json
https://github.com/w3c/deviceorientation/blob/master/w3c.json
https://github.com/w3c/did-core/blob/master/w3c.json
https://github.com/w3c/did-rubric/blob/master/w3c.json
https://github.com/w3c/did-test-suite/blob/master/w3c.json
https://github.com/w3c/did-use-cases/blob/master/w3c.json
https://github.com/w3c/DOM-Parsing/blob/gh-pages/w3c.json
https://github.com/w3c/dpub-pwp-arch/blob/gh-pages/w3c.json
https://github.com/w3c/dpub-pwp-loc/blob/gh-pages/w3c.json
https://github.com/w3c/dpub-pwp-ucr/blob/gh-pages/w3c.json
https://github.com/w3c/EasyChecks/blob/master/w3c.json
https://github.com/w3c/editing/blob/gh-pages/w3c.json
https://github.com/w3c/epub4/blob/master/w3c.json
https://github.com/w3c/FileAPI/blob/master/w3c.json
https://github.com/w3c/gamepad/blob/gh-pages/w3c.json
https://github.com/w3c/gyroscope/blob/master/w3c.json
https://github.com/w3c/hr-time/blob/gh-pages/w3c.json
https://github.com/w3c/html-aam/blob/gh-pages/w3c.json
https://github.com/w3c/html-aria/blob/gh-pages/w3c.json
https://github.com/w3c/html-extensions/blob/gh-pages/w3c.json
https://github.com/w3c/image-resource/blob/master/w3c.json
https://github.com/w3c/input-events/blob/gh-pages/w3c.json
https://github.com/w3c/IntersectionObserver/blob/master/w3c.json
https://github.com/w3c/json-ld-syntax/blob/master/w3c.json
https://github.com/w3c/longtasks/blob/master/w3c.json
https://github.com/w3c/low-vision-a11y-tf/blob/gh-pages/w3c.json
https://github.com/w3c/low-vision-SC/blob/master/w3c.json
https://github.com/w3c/magnetometer/blob/master/w3c.json
https://github.com/w3c/manifest/blob/gh-pages/w3c.json
https://github.com/w3c/me-cloud-browser/blob/gh-pages/w3c.json
https://github.com/w3c/me-media-timed-events/blob/master/w3c.json
https://github.com/w3c/media-and-entertainment/blob/master/w3c.json
https://github.com/w3c/mediacapture-depth/blob/gh-pages/w3c.json
https://github.com/w3c/mediacapture-fromelement/blob/gh-pages/w3c.json
https://github.com/w3c/mediacapture-image/blob/master/w3c.json
https://github.com/w3c/mediacapture-main/blob/master/w3c.json
https://github.com/w3c/mediacapture-output/blob/master/w3c.json
https://github.com/w3c/mediacapture-record/blob/master/w3c.json
https://github.com/w3c/mediacapture-screen-share/blob/gh-pages/w3c.json
https://github.com/w3c/mixedreality/blob/master/w3c.json
https://github.com/w3c/Mobile-A11y-TF-Note/blob/gh-pages/w3c.json
https://github.com/w3c/navigation-timing/blob/gh-pages/w3c.json
https://github.com/w3c/network-error-logging/blob/gh-pages/w3c.json
https://github.com/w3c/orientation-sensor/blob/master/w3c.json
https://github.com/w3c/page-visibility/blob/gh-pages/w3c.json
https://github.com/w3c/paint-timing/blob/master/w3c.json
https://github.com/w3c/payment-method-credit-transfer/blob/gh-pages/w3c.json
https://github.com/w3c/performance-timeline/blob/gh-pages/w3c.json
https://github.com/w3c/permissions/blob/master/w3c.json
https://github.com/w3c/pointerevents/blob/gh-pages/w3c.json
https://github.com/w3c/pointerlock/blob/gh-pages/w3c.json
https://github.com/w3c/preload/blob/gh-pages/w3c.json
https://github.com/w3c/presentation-api/blob/gh-pages/w3c.json
https://github.com/w3c/proximity/blob/gh-pages/w3c.json
https://github.com/w3c/push-api/blob/gh-pages/w3c.json
https://github.com/w3c/remote-playback/blob/gh-pages/w3c.json
https://github.com/w3c/reporting/blob/master/w3c.json
https://github.com/w3c/requestidlecallback/blob/gh-pages/w3c.json
https://github.com/w3c/resource-hints/blob/gh-pages/w3c.json
https://github.com/w3c/resource-timing/blob/gh-pages/w3c.json
https://github.com/w3c/screen-orientation/blob/gh-pages/w3c.json
https://github.com/w3c/selection-api/blob/gh-pages/w3c.json
https://github.com/w3c/sensors/blob/master/w3c.json
https://github.com/w3c/server-timing/blob/gh-pages/w3c.json
https://github.com/w3c/svgwg/blob/master/w3c.json
https://github.com/w3c/tv-ggie/blob/master/w3c.json
https://github.com/w3c/UAAG/blob/gh-pages/w3c.json
https://github.com/w3c/uievents/blob/gh-pages/w3c.json
https://github.com/w3c/uievents-code/blob/gh-pages/w3c.json
https://github.com/w3c/uievents-key/blob/gh-pages/w3c.json
https://github.com/w3c/user-timing/blob/gh-pages/w3c.json
https://github.com/w3c/using-aria/blob/gh-pages/w3c.json
https://github.com/w3c/vc-data-model/blob/gh-pages/w3c.json
https://github.com/w3c/vc-imp-guide/blob/gh-pages/w3c.json
https://github.com/w3c/vc-test-suite/blob/gh-pages/w3c.json
https://github.com/w3c/vc-use-cases/blob/gh-pages/w3c.json
https://github.com/w3c/voiceinteraction/blob/master/w3c.json
https://github.com/w3c/wai-accessibility-principles/blob/master/w3c.json
https://github.com/w3c/wai-bcase/blob/master/w3c.json
https://github.com/w3c/wai-contacting-orgs/blob/master/w3c.json
https://github.com/w3c/wai-develop-training/blob/master/w3c.json
https://github.com/w3c/wai-eval-report-templates/blob/master/w3c.json
https://github.com/w3c/wai-first-aid/blob/master/w3c.json
https://github.com/w3c/wai-inclusion/blob/gh-pages/w3c.json
https://github.com/w3c/wai-intro-accessibility/blob/gh-pages/w3c.json
https://github.com/w3c/wai-InvolveUsersAll/blob/master/w3c.json
https://github.com/w3c/wai-InvolveUsersEval/blob/master/w3c.json
https://github.com/w3c/wai-mobile/blob/master/w3c.json
https://github.com/w3c/wai-org-policies/blob/master/w3c.json
https://github.com/w3c/wai-people-use-web/blob/master/w3c.json
https://github.com/w3c/wai-presentations2all/blob/master/w3c.json
https://github.com/w3c/wai-quick-start/blob/master/w3c.json
https://github.com/w3c/wai-selecting-eval-tools/blob/master/w3c.json
https://github.com/w3c/wai-shared-experiences/blob/master/w3c.json
https://github.com/w3c/wai-std-harmonization/blob/master/w3c.json
https://github.com/w3c/wai-tutorial-images/blob/master/w3c.json
https://github.com/w3c/wai-wcag-mob-overlap/blob/master/w3c.json
https://github.com/w3c/wake-lock/blob/gh-pages/w3c.json
https://github.com/w3c/web-share/blob/master/w3c.json
https://github.com/w3c/web-thing-protocol/blob/master/w3c.json
https://github.com/w3c/webappsec-clear-site-data/blob/master/w3c.json
https://github.com/w3c/webappsec-cowl/blob/master/w3c.json
https://github.com/w3c/webappsec-credential-management/blob/master/w3c.json
https://github.com/w3c/webappsec-csp/blob/master/w3c.json
https://github.com/w3c/webappsec-mixed-content/blob/master/w3c.json
https://github.com/w3c/webappsec-referrer-policy/blob/master/w3c.json
https://github.com/w3c/webappsec-secure-contexts/blob/master/w3c.json
https://github.com/w3c/webappsec-trusted-types/blob/master/w3c.json
https://github.com/w3c/webappsec-uisecurity/blob/master/w3c.json
https://github.com/w3c/webappsec-upgrade-insecure-requests/blob/master/w3c.json
https://github.com/w3c/webauthn/blob/master/w3c.json
https://github.com/w3c/webcomponents/blob/gh-pages/w3c.json
https://github.com/w3c/webcrypto/blob/master/w3c.json
https://github.com/w3c/webdriver/blob/master/w3c.json
https://github.com/w3c/webpayments/blob/gh-pages/w3c.json
https://github.com/w3c/webpayments-flows/blob/gh-pages/w3c.json
https://github.com/w3c/webpayments-http-messages/blob/gh-pages/w3c.json
https://github.com/w3c/webpayments-methods-tokenization/blob/gh-pages/w3c.json
https://github.com/w3c/webpayments-overview/blob/gh-pages/w3c.json
https://github.com/w3c/webrtc-pc/blob/master/w3c.json
https://github.com/w3c/webrtc-stats/blob/master/w3c.json
https://github.com/w3c/webvtt/blob/gh-pages/w3c.json
https://github.com/w3c/wot-architecture/blob/master/w3c.json
https://github.com/w3c/wot-binding-templates/blob/master/w3c.json
https://github.com/w3c/wot-profile/blob/master/w3c.json
https://github.com/w3c/wot-scripting-api/blob/master/w3c.json
https://github.com/w3c/wot-security/blob/master/w3c.json
https://github.com/w3c/wot-security-best-practices/blob/master/w3c.json
https://github.com/w3c/wot-security-testing-plan/blob/master/w3c.json
https://github.com/w3c/wot-thing-description/blob/master/w3c.json
https://github.com/w3c/xinclude/blob/master/w3c.json
https://github.com/WICG/BackgroundSync/blob/master/w3c.json
https://github.com/WICG/cors-rfc1918/blob/master/w3c.json
https://github.com/WICG/encrypted-media/blob/master/w3c.json
https://github.com/WICG/entries-api/blob/master/w3c.json
https://github.com/WICG/focus-visible/blob/master/w3c.json
https://github.com/WICG/get-installed-related-apps/blob/master/w3c.json
https://github.com/WICG/InputDeviceCapabilities/blob/gh-pages/w3c.json
https://github.com/WICG/interventions/blob/master/w3c.json
https://github.com/WICG/netinfo/blob/gh-pages/w3c.json
https://github.com/WICG/origin-policy/blob/master/w3c.json
https://github.com/WICG/overscroll-scrollend-events/blob/gh-pages/w3c.json
https://github.com/WICG/ResizeObserver/blob/master/w3c.json
https://github.com/WICG/scroll-animations/blob/master/w3c.json
https://github.com/WICG/web-share-target/blob/master/w3c.json
https://github.com/WICG/webusb/blob/master/w3c.json

This should be documented in https://w3c.github.io/w3c.json.html.

@foolip
Copy link
Member Author

foolip commented Dec 16, 2019

@plehegar who would be the right person to fix/review this?

@plehegar
Copy link
Member

so, we used to recommend it but we never used it. Consequently, a lot of the w3c.json still have them. Unless we do find an actual use for them, I wouldn't document them. Or at most, I put that under "unused". If you do decide to use them, then I agree we should document them properly.

@foolip
Copy link
Member Author

foolip commented Dec 18, 2019

I just noticed because I tried writing a schema for w3c.json and validating against it. I don't want to use the properties myself, but it would be a bit of work to remove them from all of those files.

@plehegar
Copy link
Member

we never meant to be restrictive in the w3c.json, just require a minimum instead. Not sure what schema language you're using but hopefully there is a way to express that it is extensible.

@foolip
Copy link
Member Author

foolip commented Dec 19, 2019

I'm using vanilla JSON schema, so I'll just not use the additionalProperties: false bit, which is what I added to notice this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants