Skip to content

Document Cases workflow steps (cases.*)#5579

Draft
nastasha-solomon wants to merge 3 commits intomainfrom
docs/cases-workflow-steps
Draft

Document Cases workflow steps (cases.*)#5579
nastasha-solomon wants to merge 3 commits intomainfrom
docs/cases-workflow-steps

Conversation

@nastasha-solomon
Copy link
Contributor

Summary

Adds a dedicated reference page for Cases plugin workflow actions (cases.*): inputs, outputs, optional config, and error-state placeholders for each registered step (aligned with Kibana common schemas).

Also

  • Link from Kibana and Action steps workflow pages; add cases.md to the explore-analyze TOC.
  • Clarifies how cases.* steps relate to OpenAPI-generated kibana.createCaseDefaultSpace.
  • Omits cases.setCustomField while it remains disabled in product.

Context

Closes #5578

Made with Cursor

- New cases.md with per-step input/output/config from Kibana common schemas
- Link from kibana.md and action-steps.md; add to toc under workflow steps
- Omit cases.setCustomField while disabled per issue brief

Made-with: Cursor
@nastasha-solomon nastasha-solomon requested review from a team as code owners March 20, 2026 18:16
@nastasha-solomon nastasha-solomon marked this pull request as draft March 20, 2026 18:17
@github-actions
Copy link
Contributor

github-actions bot commented Mar 20, 2026

Vale Linting Results

Summary: 7 suggestions found

💡 Suggestions (7)
File Line Rule Message
explore-analyze/workflows/steps/cases.md 28 Elastic.Semicolons Use semicolons judiciously.
explore-analyze/workflows/steps/cases.md 126 Elastic.WordChoice Consider using 'select, press, visits' instead of 'hit', unless the term is in the UI.
explore-analyze/workflows/steps/cases.md 227 Elastic.WordChoice Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'See', unless the term is in the UI.
explore-analyze/workflows/steps/cases.md 625 Elastic.Semicolons Use semicolons judiciously.
explore-analyze/workflows/steps/cases.md 632 Elastic.WordChoice Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'See', unless the term is in the UI.
explore-analyze/workflows/steps/cases.md 674 Elastic.WordChoice Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'See', unless the term is in the UI.
explore-analyze/workflows/steps/cases.md 713 Elastic.WordChoice Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'See', unless the term is in the UI.

The Vale linter checks documentation changes against the Elastic Docs style guide.

To use Vale locally or report issues, refer to Elastic style guide for Vale.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 20, 2026

- Input tables: already Field/Type/Required/Default/Description (no Example column)
- Output, Config, Error states: rename Notes to Description; widen separators
- Add example accepted values / expressions to Output and Config cells where helpful

Made-with: Cursor
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.

[Internal]: Workflow step docs — Cases (Kibana PR #256922)

1 participant