# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Tricentis Requirements API
  version: 1.0.0
extends: openapi/tricentis-requirements-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: 5
- target: $.paths['/requirements'].get
  update:
    x-apievangelist-phrasing:
      intent: List requirements in the analytics feed
      effect: read
      questions:
      - Which requirements are in the test analytics data?
      - Can I search analytics requirements by phrase?
      instructions:
      - text: List analytics requirements.
      - text: List analytics requirements matching {filter}.
        slots:
          filter: query.$filter
      - text: Search analytics requirements for {search}.
        slots:
          search: query.$search
      method: generated
      generated: '2026-10-01'
- target: $.paths['/requirements({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an analytics requirement by key
      effect: read
      questions:
      - Is there a way to read one requirement record from the analytics feed?
      - Can I limit fields returned for one analytics requirement?
      instructions:
      - text: Get analytics requirement {id}.
        slots:
          id: path.id
      - text: Show only {select} of analytics requirement {id}.
        slots:
          select: query.$select
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{project-key}/test-cases/requirements'].post
  update:
    x-apievangelist-phrasing:
      intent: Create Jira requirements
      effect: write
      questions:
      - How do I create requirement issues in a Jira project?
      - What issue type does a new requirement get if I leave it out?
      instructions:
      - text: Create requirements in project {project}.
        slots:
          project: path.project-key
      - text: Add new requirement issues to Jira project {project}.
        slots:
          project: path.project-key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{project-key}/test-cases/{key}/requirements'].post
  update:
    x-apievangelist-phrasing:
      intent: Create requirements for a test case
      effect: write
      questions:
      - Can I create a new requirement and link it to a test case in one step?
      - How do I add a fresh requirement directly under a given test?
      instructions:
      - text: Create a requirement linked to test case {key} in project {project}.
        slots:
          key: path.key
          project: path.project-key
      - text: Add a new requirement and attach it to test {key}.
        slots:
          key: path.key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{project-key}/test-cases/{key}/requirement/link'].post
  update:
    x-apievangelist-phrasing:
      intent: Link existing requirements to a test case
      effect: write
      questions:
      - Can I link a requirement issue that already exists to a test case?
      - What links existing Jira requirements to a test?
      instructions:
      - text: Link existing requirements to test case {key} in project {project}.
        slots:
          key: path.key
          project: path.project-key
      - text: Connect an existing requirement issue to test {key}.
        slots:
          key: path.key
      method: generated
      generated: '2026-10-01'