Objective
Update the safe outputs schema reference documentation to cover the new issue fields support added to create-issue, update-issue, set-issue-field, and the discovery mechanism.
Context
The current reference documents create-issue without fields. After the implementation issues are completed, documentation must be updated. Tracked in #30846.
Approach
- Review the existing docs in
docs/ for safe outputs pages
- Update the
create-issue schema table to include the fields parameter (type, required, description, example)
- Update the
update-issue schema table similarly
- Add a new section for
set-issue-field with parameter descriptions and examples
- Add a section for the field discovery mechanism with usage examples
- Add a code example showing an end-to-end workflow that discovers fields and sets them during triage
Files to Modify
docs/ — safe outputs reference page(s)
- Add usage examples in workflow markdown format
Acceptance Criteria
Generated by Plan Command for issue #30846 · ● 3.1M · ◷
Objective
Update the safe outputs schema reference documentation to cover the new issue fields support added to
create-issue,update-issue,set-issue-field, and the discovery mechanism.Context
The current reference documents
create-issuewithout fields. After the implementation issues are completed, documentation must be updated. Tracked in #30846.Approach
docs/for safe outputs pagescreate-issueschema table to include thefieldsparameter (type, required, description, example)update-issueschema table similarlyset-issue-fieldwith parameter descriptions and examplesFiles to Modify
docs/— safe outputs reference page(s)Acceptance Criteria
create-issuereference includesfieldsparameter documentation with examplesupdate-issuereference includesfieldsparameter documentationset-issue-fieldreference section added with full parameter tableRelated to Implement Issue Fields Support in Safe Outputs #30846