ScenarioResp

Full scenario — returned by GET /scenarios/{key}, POST /scenarios, and PUT /scenarios/{key}. The optimistic-locking handle is returned in the ETag response header (RFC 7232) — capture it from the response and pass it back as If-Match on the next PUT / DELETE.

  • createdAt
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • metadata
    Type: object
    required

    Identity fields for a scenario — key plus human-facing descriptors. Same shape as ResourceIdentity but without version (scenarios have no draft/published lifecycle).

    • key
      Type: string
      required

      Scenario key (snake_case, customer-supplied; stable across updates).

    • name
      Type: string
      required

      Display name.

    • description
      Type: string

      Optional description.

    • labels
      Type: object

      Free-form labels for filtering / organization.

  • spec
    Type: object
    required

    Scenario content — the entity data this scenario carries.

    • entities
      Type: array object[] · ScenarioEntity[]
      required

      Scenario entity data — keyed by entity key, holds the test data used when previewing or rendering this scenario.

  • updatedAt
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z