vocabulary: "1.0.0"

info:
  provider: Test Cases
  description: Vocabulary and taxonomy for test case management covering test design, execution, and reporting concepts.
  created: "2026-05-03"
  modified: "2026-05-03"

operational:
  resources:
    - name: test-cases
      description: Individual test scenarios defining inputs, steps, and expected outcomes.
      actions: [create, read, update, delete, list, execute, clone]
    - name: test-steps
      description: Individual executable steps within a test case.
      actions: [create, read, update, delete, list]
    - name: test-results
      description: Outcomes recorded after executing a test case.
      actions: [create, read, list]
    - name: test-suites
      description: Collections of related test cases grouped for organization and execution.
      actions: [create, read, update, delete, list, execute]

  actions:
    - name: create
      description: Create a new test case, step, result, or suite.
      http_methods: [POST]
      pattern: write
    - name: read
      description: Retrieve a specific test case, step, result, or suite by identifier.
      http_methods: [GET]
      pattern: read
    - name: update
      description: Update an existing test case or suite.
      http_methods: [PUT, PATCH]
      pattern: write
    - name: delete
      description: Remove a test case or suite.
      http_methods: [DELETE]
      pattern: destructive
    - name: list
      description: Retrieve a filtered list of test cases, results, or suites.
      http_methods: [GET]
      pattern: read
    - name: execute
      description: Trigger execution of a test case or test suite.
      http_methods: [POST]
      pattern: write
    - name: clone
      description: Create a copy of an existing test case.
      http_methods: [POST]
      pattern: write

  schemas:
    core:
      - name: TestCase
        description: Complete test case entity with steps and metadata.
        key_properties: [id, title, status, priority, type, steps, expected_result]
      - name: TestStep
        description: Single executable step within a test case.
        key_properties: [step_number, action, expected_result, status]
      - name: TestResult
        description: Recorded outcome of a test case execution.
        key_properties: [id, test_case_id, status, executed_at, duration_ms]
      - name: TestSuite
        description: Collection of related test cases.
        key_properties: [id, name, test_case_ids, total_test_cases]

  enums:
    status:
      - draft
      - active
      - deprecated
      - archived
    execution_status:
      - not-executed
      - passed
      - failed
      - blocked
      - skipped
      - error
    priority:
      - critical
      - high
      - medium
      - low
    test_type:
      - functional
      - regression
      - smoke
      - acceptance
      - integration
      - performance
      - security
      - usability
    automation_status:
      - manual
      - automated
      - to-be-automated

  parameters:
    identifiers:
      - name: id
        description: Unique identifier for a test entity.
        type: string
      - name: test_case_id
        description: Reference to a specific test case.
        type: string
      - name: suite_id
        description: Reference to a test suite.
        type: string
    filters:
      - name: status
        description: Filter by lifecycle status.
        type: string
      - name: priority
        description: Filter by priority level.
        type: string
      - name: type
        description: Filter by test type category.
        type: string
      - name: tags
        description: Filter by tags.
        type: array
    pagination:
      - name: limit
        description: Maximum number of results per page.
        type: integer
      - name: offset
        description: Number of results to skip.
        type: integer

  authentication:
    schemes:
      - type: apikey
        description: API key authentication via header or query parameter.
      - type: bearer
        description: Bearer token authentication via Authorization header.

capability:
  workflows: []
  personas:
    - id: qa-engineer
      name: QA Engineer
      description: Quality assurance engineer responsible for designing and executing test cases.
    - id: developer
      name: Developer
      description: Software developer writing automated test cases as part of TDD or CI/CD workflows.
    - id: test-manager
      name: Test Manager
      description: Manager responsible for planning, organizing, and reporting on test case coverage.
  domains:
    - name: Test Design
      description: Creating and structuring test cases with steps and expected outcomes.
    - name: Test Execution
      description: Running test cases manually or automatically and recording results.
    - name: Test Reporting
      description: Analyzing test results, coverage, and quality metrics.
  namespaces: []
  binds: []

crossReference:
  - resource: test-cases
    operations: [create, read, update, delete, list, execute, clone]
    workflows: []
    personas: [qa-engineer, developer, test-manager]
  - resource: test-results
    operations: [create, read, list]
    workflows: []
    personas: [qa-engineer, developer, test-manager]
  - resource: test-suites
    operations: [create, read, update, delete, list, execute]
    workflows: []
    personas: [qa-engineer, test-manager]