Skip to content

Standardize meta mandatory key#242

Merged
arnaudbore merged 1 commit intonf-neuro:mainfrom
AlexVCaron:hotfix
Nov 20, 2025
Merged

Standardize meta mandatory key#242
arnaudbore merged 1 commit intonf-neuro:mainfrom
AlexVCaron:hotfix

Conversation

@AlexVCaron
Copy link
Contributor

Bug category

  • Critical (some functionalities is not working at all)
  • Major (something is not working as expected)
  • Minor (something but could be improved)
  • Trivial (documentation needs correcting and other non-functional issues)

Describe the bug

While working on #175, I mixed optional and mandatory fields between input and output definitions in the meta.yml. The metadata was still valid (optional: true equals mandatory: false), but the conversion scripts don't support switching between the two conventions, so the information was missing from the API on the website.

Describe the solution

I chose mandatory as the standard key for both input and output, and dropped optional completely. Modules were already configured as such, but not Subworkflows. While I know optional makes more sense when talking of outputs, having to switch when writing the meta error prone (I think I make a great example of it 😅). BTW, I have no opinion on this really, so if optional is preferable, I'll be happy to change. I do think we need to keep only one though.

@AlexVCaron AlexVCaron requested a review from a team November 20, 2025 15:36
Copy link
Contributor

@arnaudbore arnaudbore left a comment

Choose a reason for hiding this comment

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

GTG

@arnaudbore arnaudbore added this pull request to the merge queue Nov 20, 2025
Merged via the queue into nf-neuro:main with commit 00120a4 Nov 20, 2025
22 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.

2 participants

Comments