# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for qTest Manager API Version 3.0 Requirement API
  version: 1.0.0
extends: openapi/tricentis-requirement-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 13
- target: $.paths['/api/v3/projects/{projectId}/requirements'].get
  update:
    x-apievangelist-phrasing:
      intent: List requirements in a project or module
      effect: read
      questions:
      - What requirements are in my qTest project?
      - Can I list only the requirements inside one module?
      instructions:
      - text: List all requirements in project {project}.
        slots:
          project: path.projectId
      - text: List requirements under module {module} in project {project}.
        slots:
          project: path.projectId
          module: query.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/requirements'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a requirement
      effect: write
      questions:
      - How do I add a new requirement to a project?
      - Can I create a requirement inside a particular module?
      instructions:
      - text: Create a requirement named {name} in project {project}.
        slots:
          project: path.projectId
          name: requestBody.name
      - text: Add requirement {name} under module {module} in project {project}.
        slots:
          project: path.projectId
          name: requestBody.name
          module: query.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/requirements/trace-matrix-report'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the requirement traceability matrix
      effect: read
      questions:
      - Which test cases cover each of my requirements?
      - Can I get a traceability matrix limited to requirements modified in a date range?
      instructions:
      - text: Get the requirement traceability matrix for project {project}.
        slots:
          project: path.projectId
      - text: Show requirement-to-test-case coverage in project {project} for items modified from {from} to {to}.
        slots:
          project: path.projectId
          from: query.lastModifiedFrom
          to: query.lastModifiedTo
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/requirements/{idOrKey}/comments'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on a requirement
      effect: read
      questions:
      - What comments have been left on this requirement?
      - Can I read the discussion on a requirement?
      instructions:
      - text: Show all comments on requirement {requirement} in project {project}.
        slots:
          project: path.projectId
          requirement: path.idOrKey
      - text: List the discussion on requirement {requirement}.
        slots:
          requirement: path.idOrKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/requirements/{idOrKey}/comments'].post
  update:
    x-apievangelist-phrasing:
      intent: Comment on a requirement
      effect: write
      questions:
      - How do I add a comment to a requirement?
      - Can I post feedback on a requirement from a script?
      instructions:
      - text: Add the comment {content} to requirement {requirement} in project {project}.
        slots:
          project: path.projectId
          requirement: path.idOrKey
          content: requestBody.content
      - text: 'Post feedback on requirement {requirement}: {content}.'
        slots:
          requirement: path.idOrKey
          content: requestBody.content
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/requirements/{idOrKey}/comments/{commentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one comment on a requirement
      effect: read
      questions:
      - How do I fetch a single requirement comment?
      - Who wrote a specific comment on a requirement?
      instructions:
      - text: Get comment {comment} on requirement {requirement} in project {project}.
        slots:
          project: path.projectId
          requirement: path.idOrKey
          comment: path.commentId
      - text: Show requirement comment {comment} on {requirement}.
        slots:
          requirement: path.idOrKey
          comment: path.commentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/requirements/{idOrKey}/comments/{commentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a comment on a requirement
      effect: write
      questions:
      - Can I edit a comment I left on a requirement?
      - How do I update requirement feedback after the fact?
      instructions:
      - text: Change comment {comment} on requirement {requirement} in project {project} to {content}.
        slots:
          project: path.projectId
          requirement: path.idOrKey
          comment: path.commentId
          content: requestBody.content
      - text: Edit requirement comment {comment} on {requirement}.
        slots:
          requirement: path.idOrKey
          comment: path.commentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/requirements/{idOrKey}/comments/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment from a requirement
      effect: destructive
      questions:
      - How do I remove a comment from a requirement?
      - Can requirement comments be deleted?
      instructions:
      - text: Delete comment {comment} from requirement {requirement} in project {project}.
        slots:
          project: path.projectId
          requirement: path.idOrKey
          comment: path.commentId
      - text: Remove requirement comment {comment} on {requirement}.
        slots:
          requirement: path.idOrKey
          comment: path.commentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/requirements/{requirementId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a requirement
      effect: read
      questions:
      - How do I fetch a single requirement and its properties?
      - Can I include external properties from a linked tracker?
      instructions:
      - text: Get requirement {requirement} in project {project}.
        slots:
          project: path.projectId
          requirement: path.requirementId
      - text: Show requirement {requirement} with its external properties.
        slots:
          requirement: path.requirementId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/requirements/{requirementId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update or move a requirement
      effect: write
      questions:
      - How do I change a requirement's name or properties?
      - Can I move a requirement to a different module?
      instructions:
      - text: Rename requirement {requirement} in project {project} to {name}.
        slots:
          project: path.projectId
          requirement: path.requirementId
          name: requestBody.name
      - text: Move requirement {requirement} to module {module}.
        slots:
          requirement: path.requirementId
          module: query.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/requirements/{requirementId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a requirement
      effect: destructive
      questions:
      - How do I delete a requirement?
      - Can I remove an obsolete requirement from a project?
      instructions:
      - text: Delete requirement {requirement} from project {project}.
        slots:
          project: path.projectId
          requirement: path.requirementId
      - text: Remove the obsolete requirement {requirement}.
        slots:
          requirement: path.requirementId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/requirements/{requirementId}/defects'].get
  update:
    x-apievangelist-phrasing:
      intent: List defects linked to a requirement
      effect: read
      questions:
      - Which defects are tied to this requirement?
      - Are there open bugs against a given requirement?
      instructions:
      - text: List defects linked to requirement {requirement} in project {project}.
        slots:
          project: path.projectId
          requirement: path.requirementId
      - text: Show bugs reported against requirement {requirement}.
        slots:
          requirement: path.requirementId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/requirements/{requirementId}/test-runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List test runs covering a requirement
      effect: read
      questions:
      - Which test runs cover this requirement?
      - Can I see the latest execution log for each run tied to a requirement?
      instructions:
      - text: List test runs associated with requirement {requirement} in project {project}.
        slots:
          project: path.projectId
          requirement: path.requirementId
      - text: Show test runs for requirement {requirement} including each run's latest log.
        slots:
          requirement: path.requirementId
      method: generated
      generated: '2026-10-01'