TestCaseStepSchema

Fields

Authored step shape; expected outcomes are optional by design.

3 fields

action · required: string
expected_result: string or null
step_number · required: integer

Raw schema (JSON)

{
  "description": "Authored step shape; expected outcomes are optional by design.",
  "properties": {
    "action": {
      "maxLength": 50000,
      "minLength": 1,
      "title": "Action",
      "type": "string"
    },
    "expected_result": {
      "anyOf": [
        {
          "maxLength": 50000,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Expected Result"
    },
    "step_number": {
      "minimum": 1,
      "title": "Step Number",
      "type": "integer"
    }
  },
  "required": [
    "step_number",
    "action"
  ],
  "title": "TestCaseStepSchema",
  "type": "object"
}

Used by endpoints

11 endpoints send or return this schema, on its own or inside another schema.

POST /api/v1/canonical-test-cases/{canonical_id}/promote — Promote Canonical Case
POST /api/v1/test-management/batches/{batch_id}/accept — Batch Accept
POST /api/v1/test-management/batches/{batch_id}/cases/{case_id}/accept — Accept Case
GET /api/v1/test-management/cases — List Test Cases
POST /api/v1/test-management/cases — Create Test Case
GET /api/v1/test-management/cases/{case_id} — Get Test Case
PATCH /api/v1/test-management/cases/{case_id} — Update Test Case
GET /api/v1/test-management/cases/{case_id}/history — Get Test Case History
POST /api/v1/test-management/cases/{case_id}/restore — Restore Test Case Version
POST /api/v1/test-management/cases/{case_id}/review-action — Review Action
POST /api/v1/test-management/cases/{case_id}/transition — Transition Test Case

Used by schemas

More details

Specification: OpenAPI JSON