# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for TTM for Jira Test Cases API
  version: 1.0.0
extends: openapi/tricentis-test-cases-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: 11
- target: $.paths['/v1/projects/{project-key}/test-cases'].get
  update:
    x-apievangelist-phrasing:
      intent: Read test cases (deprecated paging)
      effect: read
      questions:
      - Is there an older offset-paged way to read a project's test cases?
      - Can I still read test cases with the deprecated endpoint that pages by offset?
      instructions:
      - text: Read test cases in project {project} using the deprecated offset endpoint.
        slots:
          project: path.project-key
      - text: Read test cases in {project} from offset {offset} with the legacy call.
        slots:
          project: path.project-key
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{project-key}/test-cases'].post
  update:
    x-apievangelist-phrasing:
      intent: Create test cases
      effect: write
      questions:
      - How do I create new test cases in a Jira project?
      - Can test cases be created in a specific folder path?
      - Could I get a callback when test case creation finishes?
      instructions:
      - text: Create test cases {tests} in project {project}.
        slots:
          tests: requestBody.tests
          project: path.project-key
      - text: Create test cases in {project} under folder {folder}.
        slots:
          project: path.project-key
          folder: requestBody.folder
      - text: Create test cases in {project} and notify {callback} when done.
        slots:
          project: path.project-key
          callback: requestBody.callbackUrl
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{project-key}/test-cases/bulk'].get
  update:
    x-apievangelist-phrasing:
      intent: Read test cases in bulk
      effect: read
      questions:
      - Which test cases are in a particular folder of my project?
      - Can I page through test cases with a next page token?
      instructions:
      - text: Read test cases in project {project} in bulk.
        slots:
          project: path.project-key
      - text: List test cases in folder {folder} of {project}.
        slots:
          folder: query.folderPath
          project: path.project-key
      - text: Get the next page of test cases in {project} after token {token}.
        slots:
          project: path.project-key
          token: query.nextPageToken
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/test-cases/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search test cases with JQL (deprecated)
      effect: read
      questions:
      - Is there a legacy offset-paged JQL search for test cases?
      - Can I still run the deprecated test case search with an offset?
      instructions:
      - text: Run the deprecated test case search with JQL {jql}.
        slots:
          jql: requestBody.jql
      - text: Use the legacy JQL search {jql} starting at offset {offset}.
        slots:
          jql: requestBody.jql
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/test-cases/search/jql'].post
  update:
    x-apievangelist-phrasing:
      intent: Search test cases with JQL
      effect: read
      questions:
      - How do I find test cases with a JQL query?
      - Can a JQL test case search return only certain fields?
      instructions:
      - text: Search test cases with JQL {jql}.
        slots:
          jql: requestBody.jql
      - text: Find test cases matching {jql} returning fields {fields}.
        slots:
          jql: requestBody.jql
          fields: query.jiraFields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{project-key}/jobs/{job-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a test case import job
      effect: read
      questions:
      - Has my asynchronous test case import finished?
      - What is the status of the job that creates my test cases?
      instructions:
      - text: Check job {job} in project {project}.
        slots:
          job: path.job-id
          project: path.project-key
      - text: Show the status of test case import job {job}.
        slots:
          job: path.job-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{project-key}/test-cases/{key}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a test case
      effect: write
      questions:
      - How do I change a test case's summary or fields?
      - Can I move an existing test case to another folder?
      instructions:
      - text: Update test case {key} in project {project} with fields {fields}.
        slots:
          key: path.key
          project: path.project-key
          fields: requestBody.fields
      - text: Move test case {key} in {project} to folder {folder}.
        slots:
          key: path.key
          project: path.project-key
          folder: requestBody.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{project-key}/test-cases/{key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a test case
      effect: destructive
      questions:
      - How do I delete a test case?
      - Can I remove a test by its Jira key?
      instructions:
      - text: Delete test case {key} in project {project}.
        slots:
          key: path.key
          project: path.project-key
      - text: Remove test {key} permanently.
        slots:
          key: path.key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{project-key}/test-cases/{key}/automation'].put
  update:
    x-apievangelist-phrasing:
      intent: Set automation details on a test case
      effect: write
      questions:
      - How do I mark a manual test case as automated?
      - Can I store the external automation id against a test case?
      - Will switching a test to automated overwrite its precondition?
      instructions:
      - text: Set automation {name} on test case {key} in project {project}.
        slots:
          name: requestBody.name
          key: path.key
          project: path.project-key
      - text: Link test {key} to external automated test {external_id}.
        slots:
          key: path.key
          external_id: requestBody.externalId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/testcases'].get
  update:
    x-apievangelist-phrasing:
      intent: List test cases in the analytics feed
      effect: read
      questions:
      - Which test cases are in the test analytics data?
      - Can I count analytics test cases matching a filter?
      instructions:
      - text: List analytics test cases.
      - text: List analytics test cases matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/testcases({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an analytics test case by key
      effect: read
      questions:
      - How do I read one test case record from the analytics feed?
      - Can I select only some fields of an analytics test case?
      instructions:
      - text: Get analytics test case {id}.
        slots:
          id: path.id
      - text: Show only {select} of analytics test case {id}.
        slots:
          select: query.$select
          id: path.id
      method: generated
      generated: '2026-10-01'