vocabulary: "1.0.0"

info:
  provider: Test Plans
  description: Vocabulary and taxonomy for test planning covering test plans, test cycles, milestones, and quality management concepts.
  created: "2026-05-03"
  modified: "2026-05-03"

operational:
  resources:
    - name: test-plans
      description: Structured documents defining testing objectives, scope, approach, and schedule.
      actions: [create, read, update, delete, list, activate, complete]
    - name: test-cycles
      description: Time-boxed execution cycles within test plans.
      actions: [create, read, update, delete, list, start, complete]
    - name: milestones
      description: Key checkpoints in test plans tracking completion of testing phases.
      actions: [create, read, update, delete, list, complete]

  actions:
    - name: create
      description: Create a new test plan, cycle, or milestone.
      http_methods: [POST]
      pattern: write
    - name: read
      description: Retrieve a specific test plan, cycle, or milestone.
      http_methods: [GET]
      pattern: read
    - name: update
      description: Update a test plan, cycle, or milestone.
      http_methods: [PUT, PATCH]
      pattern: write
    - name: delete
      description: Remove a test plan, cycle, or milestone.
      http_methods: [DELETE]
      pattern: destructive
    - name: list
      description: List test plans, cycles, or milestones with filtering.
      http_methods: [GET]
      pattern: read
    - name: activate
      description: Move a test plan from draft to active status.
      http_methods: [POST]
      pattern: write
    - name: complete
      description: Mark a test plan, cycle, or milestone as completed.
      http_methods: [POST]
      pattern: write
    - name: start
      description: Begin execution of a test cycle.
      http_methods: [POST]
      pattern: write

  schemas:
    core:
      - name: TestPlan
        description: Comprehensive test planning document with scope, schedule, and criteria.
        key_properties: [id, name, status, objectives, scope, entry_criteria, exit_criteria, start_date, end_date]
      - name: TestCycle
        description: Execution cycle grouping test cases for a release or sprint.
        key_properties: [id, name, test_plan_id, status, environment, build_version, total_tests, passed, failed]
      - name: TestMilestone
        description: Key checkpoint in the test plan with completion criteria.
        key_properties: [id, name, due_date, status, criteria, completed_date]

  enums:
    plan_status:
      - draft
      - active
      - completed
      - archived
    cycle_status:
      - planned
      - in-progress
      - completed
      - abandoned
    milestone_status:
      - pending
      - in-progress
      - completed
      - at-risk
      - missed
    test_types:
      - functional
      - regression
      - performance
      - security
      - usability
      - integration
      - acceptance
      - smoke

  parameters:
    identifiers:
      - name: id
        description: Unique identifier for the test plan entity.
        type: string
      - name: test_plan_id
        description: Reference to a parent test plan.
        type: string
      - name: project_id
        description: Reference to the project being tested.
        type: string
    filters:
      - name: status
        description: Filter by status.
        type: string
      - name: environment
        description: Filter test cycles by environment.
        type: string
      - name: owner
        description: Filter by plan or cycle owner.
        type: string
    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: bearer
        description: Bearer token for test management platform APIs.
      - type: apikey
        description: API key authentication for test management tools.

capability:
  workflows: []
  personas:
    - id: test-manager
      name: Test Manager
      description: Manager responsible for creating and maintaining test plans and coordinating testing efforts.
    - id: qa-lead
      name: QA Lead
      description: Quality assurance lead managing test cycles and tracking milestone progress.
    - id: release-manager
      name: Release Manager
      description: Release manager using test plans to determine release readiness.
    - id: business-analyst
      name: Business Analyst
      description: Business analyst reviewing test plans to ensure acceptance criteria coverage.
  domains:
    - name: Test Planning
      description: Defining testing strategy, scope, and approach for a project or release.
    - name: Execution Management
      description: Organizing and tracking test execution within cycles.
    - name: Milestone Tracking
      description: Monitoring progress against key testing checkpoints.
    - name: Quality Reporting
      description: Aggregating test results to assess release readiness.
  namespaces: []
  binds: []

crossReference:
  - resource: test-plans
    operations: [create, read, update, delete, list, activate, complete]
    workflows: []
    personas: [test-manager, qa-lead, release-manager]
  - resource: test-cycles
    operations: [create, read, update, delete, list, start, complete]
    workflows: []
    personas: [qa-lead, test-manager]
  - resource: milestones
    operations: [create, read, update, delete, list, complete]
    workflows: []
    personas: [test-manager, release-manager, business-analyst]