Up to date source for a data dictionary

[jsheunis]

Hi everyone

(@surchs I'm reposting here just to have the issue provenance, in case someone has a similar question in the future)

I am working with some tools to generate user forms from schemas, and specifically want to see if I can generate a "Neurobagel data dictionary editor" (see for context: https://hub.datalad.org/datalink/tools/issues/2). For that I'd like to know whether this is the correct, updated and maintained version of the data dictionary schema: https://raw.githubusercontent.com/neurobagel/annotation_tool/refs/heads/main/assets/neurobagel_data_dictionary.schema.json?

[surchs]

Hey @jsheunis, apologies for the sluggish response to your original issue - just landed from a trip to Cali that messed up my schedule more than anticipated.

For that I'd like to know whether this is the correct, updated and maintained version of the data dictionary schema:

The short answer is yes.

The long answer is: yes, but for reasons we don't love. The model is specified here: https://github.com/neurobagel/bagel-cli/blob/ac4b2c7049e0d8601769c4a93f7974e47a64dc5a/bagel/dictionary_models.py but we haven't automated the JSON serialization and once we do, it'd probably be in a dedicated repo, maybe also with a transition to LinkML. Currently the jsonschema you linked is up to date.

[jsheunis]

No worries, thanks for following up. Good to know I've been working with the correct schema 👍

[github-actions]

We want to keep our issues up to date and active. This issue hasn't seen any activity in the last 75 days.
We have applied the _flag:stale label to indicate that this issue should be reviewed again.
When you review, please reread the spec and then apply one of these three options:

• prioritize: apply the flag:schedule label to suggest moving this issue into the backlog now
• close: if the issue is no longer relevant, explain why (give others a chance to reply) and then close.
• archive: sometimes an issue has important information or ideas but we won't work on it soon. In this case
  apply the someday label to show that this won't be prioritized. The stalebot will ignore issues with this
  label in the future. Use sparingly!