Skip to content

rf(schema): Consolidate rules.dataset_metadata under rules.json#2348

Open
effigies wants to merge 6 commits intobids-standard:masterfrom
effigies:schema/consolidate-json
Open

rf(schema): Consolidate rules.dataset_metadata under rules.json#2348
effigies wants to merge 6 commits intobids-standard:masterfrom
effigies:schema/consolidate-json

Conversation

@effigies
Copy link
Copy Markdown
Collaborator

This is a slight cleanup. rules.dataset_metadata and rules.json developed in parallel, but are ultimately the same thing. This makes it easier on schema users to find the rules that apply to any given JSON file by consolidating all under rules.json.

I did move the dataset_description_with_genetics rule to rules.json.genetics instead of rules.json.dataset, since those rules were introduced in the genetics BEP. It could also be argued that it should go under rules.json.dataset, since it directly impacts dataset_description.json. The location has no impact on validation, it's just a question of what's most intuitive.

@effigies effigies force-pushed the schema/consolidate-json branch from 9e82aee to 761027b Compare February 19, 2026 19:53
@effigies effigies marked this pull request as ready for review February 19, 2026 20:01
Copy link
Copy Markdown
Collaborator

@bendhouseart bendhouseart left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree, it's slightly more intuitive.

@effigies
Copy link
Copy Markdown
Collaborator Author

Tempting @yarikoptic into reviewing with a promise of a more consistent schema.

@effigies effigies requested a review from rwblair March 24, 2026 18:44
@effigies effigies force-pushed the schema/consolidate-json branch from 761027b to dbd4448 Compare March 24, 2026 18:44
@effigies effigies force-pushed the schema/consolidate-json branch from dbd4448 to d1b879f Compare April 10, 2026 14:43
@yarikoptic
Copy link
Copy Markdown
Collaborator

doesn't this change/break metaschema and thus requiring boost of https://github.com/bids-standard/bids-specification/blob/master/src/schema/SCHEMA_VERSION to 2.0.0-dev?

@effigies
Copy link
Copy Markdown
Collaborator Author

It seemed like a relatively small schema change, so I figured the minor version bump would be fine, but I have no objection to calling it major.

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.

3 participants