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

src/schemas/json: fix spurious $id definitions #4074

Merged
merged 1 commit into from
Sep 22, 2024

Conversation

rogpeppe
Copy link
Contributor

This removes $id definitions from schemas where
those IDs are defining schemas outside of the schema URI itself.

The problem this is fixing is summarized in #4073.

Fixes #4073.

This removes `$id` definitions from schemas where
those IDs are defining schemas outside of the schema URI itself.

The problem this is fixing is summarized in SchemaStore#4073.

Fixes SchemaStore#4073.
@madskristensen
Copy link
Contributor

@hyperupcall thoughts?

@hyperupcall
Copy link
Member

Thanks! At a glance, this looks like a good improvement, similar in style to #3242. I am a little worried about this being a breaking change outside of SchemaStore Schemas. As you mention:

Although there is the possibility that external users are relying on these IDs, I suspect that they're unlikely to be, and if they are, then they should not be.

I somewhat agree, as many of these instances of $id are used either infrequent or inconsistently in schemas. And, the exceptions are in older schemas that haven't received updates in years. But some of the files have specific CODEOWNERS, so I'd like to get their approval before I merge.

cc @skoch13 @andrey-skl @zmaks (JetBrains YouTrack team) What do you think about these changes to youtrack-app.json? As I understand, these changes reduce instances in which $ids are declared outside of their schemas' namespace.

@skoch13
Copy link
Contributor

skoch13 commented Sep 17, 2024

@hyperupcall looks good to me. Initially these $ids were added in compliance with similar schemes, but they are redundant and can be safely omitted. Thank you!

@hyperupcall
Copy link
Member

Awesome, sounds great

@hyperupcall
Copy link
Member

@rogpeppe Thanks!

@hyperupcall hyperupcall merged commit 215d9f4 into SchemaStore:master Sep 22, 2024
4 checks passed
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

Successfully merging this pull request may close these issues.

schemas inappropriately declare IDs outside their namespace
4 participants