# 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 Build API
  version: 1.0.0
extends: openapi/tricentis-build-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}/builds'].get
  update:
    x-apievangelist-phrasing:
      intent: List builds under a release
      effect: read
      questions:
      - Which builds belong to a given release?
      - Can I see all builds of a release in one project?
      instructions:
      - text: List the builds of release {release} in project {project}.
        slots:
          release: query.releaseId
          project: path.projectId
      - text: Show every build under release {release}, project {project}.
        slots:
          release: query.releaseId
          project: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/builds'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a build under a release
      effect: write
      questions:
      - How do I add a new build to a release?
      - Can I set custom properties when creating a build?
      instructions:
      - text: Create build {name} in project {project} with properties {properties}.
        slots:
          name: requestBody.name
          project: path.projectId
          properties: requestBody.properties
      - text: Add a build named {name} under release {release} in project {project}, properties {properties}.
        slots:
          name: requestBody.name
          release: requestBody.release
          project: path.projectId
          properties: requestBody.properties
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/builds/{buildId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a build
      effect: read
      questions:
      - How can I look up one build's details?
      - What properties are recorded on a specific build?
      instructions:
      - text: Get build {build} in project {project}.
        slots:
          project: path.projectId
          build: path.buildId
      - text: Show the details of build {build}, project {project}.
        slots:
          project: path.projectId
          build: path.buildId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/builds/{buildId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a build
      effect: write
      questions:
      - Can I rename a build or change its properties?
      - How do I move a build to a different release?
      instructions:
      - text: Rename build {build} in project {project} to {name}, keeping properties {properties}.
        slots:
          project: path.projectId
          build: path.buildId
          name: requestBody.name
          properties: requestBody.properties
      - text: Update the properties of build {build} in project {project} to {properties}.
        slots:
          project: path.projectId
          build: path.buildId
          properties: requestBody.properties
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/builds/{buildId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a build
      effect: destructive
      questions:
      - Can I delete a build from a release?
      - What's the way to remove an obsolete build?
      instructions:
      - text: Delete build {build} from project {project}.
        slots:
          project: path.projectId
          build: path.buildId
      - text: Remove build {build} in project {project} permanently.
        slots:
          project: path.projectId
          build: path.buildId
      method: generated
      generated: '2026-10-01'