Skip to content

Document JSON Schema inputs on the manual trigger #8049

Description

@nastasha-solomon

Summary

Workflow input docs still show the legacy workflow-level array form. Inputs now live on the manual trigger and are JSON Schema (including $ref to built-in Kibana definitions). That is not documented.

Requested by: Nastasha Solomon in #one-workflow so the docs match the 9.5 inputs move and versioning. JSON Schema / $ref also came up in this thread (built-in types discussion).

Current State

  • Manual triggers still says inputs are defined at the workflow level and only shows the array form
  • Anatomy notes 9.5+ trigger placement, but examples are still the array form; JSON Schema is a one-liner
  • Cheat sheet still shows top-level inputs: [ ... ]
  • No docs for JSON Schema inputs or $ref: '#/kibana/definitions/<id>'

Proposed Solution

Update the pages above (and any other hits) for 9.5+ / serverless:

  • Put inputs on the manual trigger, not the workflow root
  • Document JSON Schema as the current form; keep the array form as legacy / 9.4
  • Document $ref: '#/kibana/definitions/<id>' (e.g. alertingV2NotificationGroup)
  • Use version tabs where the syntax changed

Example of the current shape:

triggers:
  - type: manual
    inputs:
      type: object
      properties:
        environment:
          type: string
          default: staging
        notificationGroup:
          $ref: '#/kibana/definitions/alertingV2NotificationGroup'
      required: [environment]

Out of Scope (for now)

  • Event typing on manual triggers (security-team#19006)
  • Product work for the inputs move itself

Metadata

Metadata

Assignees

No one assigned

    Labels

    Team:SKIIssues owned by the SKI Docs Team

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions