Skip to content

Commit 761027b

Browse files
committed
doc: Update schema README to drop rules.dataset_metadata
1 parent 2bfc0e9 commit 761027b

1 file changed

Lines changed: 8 additions & 6 deletions

File tree

src/schema/README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -873,9 +873,9 @@ meg_meg_common:
873873
description: optional
874874
```
875875

876-
### Sidecar and tabular data rules
876+
### JSON and tabular data rules
877877

878-
Tabular data and JSON sidecar files follow a similar pattern:
878+
Tabular data and JSON files follow a similar pattern:
879879

880880
| | Name | Value |
881881
| ---- | ------------- | ------------- |
@@ -937,7 +937,7 @@ rule is applied.
937937

938938
#### Valid fields for definitions
939939

940-
1. `rules.sidecars.*`
940+
1. `rules.sidecars.*` and `rules.json.*`
941941

942942
| Field | Description |
943943
| ----------- | -------------------------------------------------------------------------------------------------------- |
@@ -984,6 +984,11 @@ MRIFuncVolumeTiming:
984984
An additional check will be required to assert that both are not present,
985985
but these tables may be combined for rendering purposes.
986986
987+
`rules.json.*` and `rules.sidecars.*` are essentially identical,
988+
except `rules.json` rules describe the contents of individual JSON files,
989+
while `rules.sidecars` rules describe the contents of sidecar files,
990+
accumulated by the inheritance principle.
991+
987992
Here we present an example rule in `rules.tabular_data.eeg`:
988993

989994
```YAML
@@ -1058,9 +1063,6 @@ EventsMissing:
10581063
| ----------- | ------------------------------------- |
10591064
| `datatypes` | List of datatypes mapping to modality |
10601065

1061-
- `rules.dataset_metadata` - These are similar to `rules.sidecars.*`, for JSON files at the root level.
1062-
This is likely to go away in favor of other approaches.
1063-
10641066
- `rules.errors` - This file describes errors that cannot be expressed in the schema. This provides common
10651067
codes and language that implementing validators can use to ensure the same problems are reported to
10661068
users in the same way.

0 commit comments

Comments
 (0)