workflow_dispatch inputs: description, default and options are not documented #46299

Code of Conduct

• I have read and agree to the GitHub Docs project's Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#onworkflow_dispatchinputs

What part(s) of the article would you like to see updated?

The on.workflow_dispatch.inputs.<input_id> section documents only required and type. The description, default and options keys are not documented as headings, although the example on the same page uses all three (options for a choice input).

The workflow schema in actions/languageservices (workflow-parser/src/workflow-v1.0.json, at fb5c6e4) defines these keys for workflow_dispatch inputs:

• description: a string description of the input parameter.
• default: used when an input parameter isn't specified in a workflow file.
• options: a sequence of strings; the options of the dropdown list, if the type is choice.

Suggested change: add a short section for each of on.workflow_dispatch.inputs.<input_id>.description, .default and .options, with the options section stating that it applies only to choice inputs.

Additional information

The example in data/reusables/actions/workflow-dispatch-inputs-example.md already shows options with type: choice.