Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for TTM for Jira Attachments API

6 actions 6 updates phrasing extends openapi/tricentis-attachments-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Tricentis's API. It is a proposal applied on top of the contract, not a document Tricentis publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/v1/projects/{project-key}/test-runs/{test-run-key}/attachments'].get

$.paths['/v1/projects/{project-key}/test-runs/{test-run-key}/attachments'].post

$.paths['/v1/projects/{project-key}/test-runs/attachments/{attachmentId}'].get

$.paths['/v1/projects/{project-key}/test-runs/{test-run-key}/steps/{step-number}/attachments'].post

$.paths['/v1/projects/{project-key}/test-runs/attachments/{id}'].put

OpenAPI Overlay

# 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 Attachments API
  version: 1.0.0
extends: openapi/tricentis-attachments-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['/v1/projects/{project-key}/test-runs/{test-run-key}/attachments'].get
  update:
    x-apievangelist-phrasing:
      intent: List attachments on a test run
      effect: read
      questions:
      - Which files are attached to a test run?
      - Can I page through a test run's attachments?
      instructions:
      - text: List the attachments on test run {test_run} in project {project}.
        slots:
          test_run: path.test-run-key
          project: path.project-key
      - text: Show the first {limit} attachments of run {test_run} in {project}.
        slots:
          limit: query.limit
          test_run: path.test-run-key
          project: path.project-key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{project-key}/test-runs/{test-run-key}/attachments'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an attachment upload to a test run
      effect: write
      questions:
      - How do I attach a screenshot to a whole test run?
      - What is the maximum file size for a test run attachment?
      instructions:
      - text: Start uploading {file_name} to test run {test_run} in project {project}.
        slots:
          file_name: requestBody.fileName
          test_run: path.test-run-key
          project: path.project-key
      - text: Get an upload link for a {mime_type} file on run {test_run} in {project}.
        slots:
          mime_type: requestBody.mimeType
          test_run: path.test-run-key
          project: path.project-key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{project-key}/test-runs/attachments/{attachmentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a test run attachment's link
      effect: read
      questions:
      - Can I get a download link for one attachment by its id?
      - Where can I fetch a test run attachment file from?
      instructions:
      - text: Get the link for attachment {attachment} in project {project}.
        slots:
          attachment: path.attachmentId
          project: path.project-key
      - text: Give me a download URL for attachment {attachment}.
        slots:
          attachment: path.attachmentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{project-key}/test-runs/{test-run-key}/steps/{step-number}/attachments'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an attachment upload to a run step
      effect: write
      questions:
      - Can I attach evidence to one specific step of a test run?
      - How do I upload a file against step 3 of a run?
      instructions:
      - text: Start uploading {file_name} to step {step} of run {test_run} in {project}.
        slots:
          file_name: requestBody.fileName
          step: path.step-number
          test_run: path.test-run-key
          project: path.project-key
      - text: Attach a file to step {step} of test run {test_run}.
        slots:
          step: path.step-number
          test_run: path.test-run-key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{project-key}/test-runs/attachments/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Confirm an attachment finished uploading
      effect: read
      questions:
      - How can I check that my attachment actually reached storage?
      - Is there a way to confirm the S3 upload of an attachment succeeded?
      instructions:
      - text: Confirm attachment {id} uploaded in project {project}.
        slots:
          id: path.id
          project: path.project-key
      - text: Check whether the file for attachment {id} is in storage.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'