# 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 Release API
  version: 1.0.0
extends: openapi/tricentis-release-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['/api/v3/projects/{projectId}/releases'].get
  update:
    x-apievangelist-phrasing:
      intent: List releases in a project
      effect: read
      questions:
      - What releases are set up in my qTest project?
      - Can I include closed releases in the list?
      instructions:
      - text: List releases in project {project}.
        slots:
          project: path.projectId
      - text: List all releases in project {project}, including closed ones.
        slots:
          project: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/releases'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a release
      effect: write
      questions:
      - How do I create a new release to plan testing against?
      - Can I set start and end dates on a release?
      instructions:
      - text: Create a release named {name} in project {project}.
        slots:
          project: path.projectId
          name: requestBody.name
      - text: Create release {name} in project {project} running from {start} to {end}.
        slots:
          project: path.projectId
          name: requestBody.name
          start: requestBody.start_date
          end: requestBody.end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/releases/{releaseId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a release
      effect: read
      questions:
      - How do I look up one release?
      - What are the dates of a given release?
      instructions:
      - text: Get release {release} in project {project}.
        slots:
          project: path.projectId
          release: path.releaseId
      - text: Show the start and end dates of release {release}.
        slots:
          release: path.releaseId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/releases/{releaseId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a release
      effect: write
      questions:
      - How do I change a release's dates or description?
      - Can I push back a release's end date?
      instructions:
      - text: Change the end date of release {release} in project {project} to {end}.
        slots:
          project: path.projectId
          release: path.releaseId
          end: requestBody.end_date
      - text: Rename release {release} to {name}.
        slots:
          release: path.releaseId
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/releases/{releaseId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a release
      effect: destructive
      questions:
      - How do I delete a release?
      - Can I remove a cancelled release from a project?
      instructions:
      - text: Delete release {release} from project {project}.
        slots:
          project: path.projectId
          release: path.releaseId
      - text: Remove the cancelled release {release}.
        slots:
          release: path.releaseId
      method: generated
      generated: '2026-10-01'