common-workflow-language / cwl-v1.3

Apache License 2.0
4 stars 4 forks source link

parameter and step groups #35

Open tetron opened 1 month ago

tetron commented 1 month ago

Want to be able to apply annotations to groups of parameters or workflow steps. This would principally be metadata documentation -- need to decide if this should include features that affect runtime execution or not. The goal is to have a way to provide better documentation & user interface for tool use.

Syntax options:

inputs:
  parameter1: string
  parameter2: int
groups:
  group1:
    groupMembers: [parmeter1, parameter2]
    doc: "parameters related to the foobar feature"
inputs:
  parameter1:
    type: string
    groupMember: group1
  parameter2:
    type: int
    groupMember: group1
groups:
  group1:
    doc: "parameters related to the foobar feature"

Discussion points

tetron commented 1 month ago

Groups should have a field called "expanded" (default true) which indicates if the group is expanded in the UI by default.

Groups should be displayed after any non-grouped items.