# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Tricentis Project API
  version: 1.0.0
extends: openapi/tricentis-project-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: 9
- target: $.paths['/api/v3/projects'].get
  update:
    x-apievangelist-phrasing:
      intent: List projects I can access
      effect: read
      questions:
      - Which qTest projects do I have access to?
      - Can I list only projects I'm assigned to?
      instructions:
      - text: List all the projects I can access.
      - text: Show only projects where assigned is {assigned}.
        slots:
          assigned: query.assigned
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a project
      effect: write
      questions:
      - How do I create a new test project?
      - Can a new project start from a template or include sample data?
      instructions:
      - text: Create a project named {name}.
        slots:
          name: requestBody.name
      - text: Create project {name} from template {template}, running {start} to {end}.
        slots:
          name: requestBody.name
          template: requestBody.template_id
          start: requestBody.start_date
          end: requestBody.end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search projects by UUID
      effect: read
      questions:
      - Can I find a project by its UUID?
      - Is there a project search that matches on UUID rather than ID?
      instructions:
      - text: Search for the project with UUID {uuid}.
        slots:
          uuid: requestBody.uuid
      - text: Find which project has uuid {uuid}.
        slots:
          uuid: requestBody.uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project
      effect: read
      questions:
      - How can I look up one project's details?
      - What are the start and end dates of a given project?
      instructions:
      - text: Get project {project}.
        slots:
          project: path.projectId
      - text: Show the details of project {project}.
        slots:
          project: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a project
      effect: write
      questions:
      - Can I rename a project or change its dates?
      - How do I change who administers a project?
      instructions:
      - text: Rename project {project} to {name}.
        slots:
          project: path.projectId
          name: requestBody.name
      - text: Set the end date of project {project} to {end}.
        slots:
          project: path.projectId
          end: requestBody.end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/user-profiles/current'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my permissions in a project
      effect: read
      questions:
      - What am I allowed to do in this project?
      - Can I check my own permissions on a project before making changes?
      instructions:
      - text: Show my permissions in project {project}.
        slots:
          project: path.projectId
      - text: Get my current user profile for project {project}.
        slots:
          project: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users in a project
      effect: read
      questions:
      - Who are the members of a project?
      - Can I include inactive members in a project roster?
      instructions:
      - text: List the users in project {project}.
        slots:
          project: path.projectId
      - text: Show all members of project {project}, including inactive ones.
        slots:
          project: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects'].get
  update:
    x-apievangelist-phrasing:
      intent: List qTest Pulse projects
      effect: read
      questions:
      - What projects exist in qTest Pulse?
      - Can I get every Pulse project my automation rules can belong to?
      instructions:
      - text: List all qTest Pulse projects.
      - text: Show me the projects configured in Pulse.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a qTest Pulse project
      effect: read
      questions:
      - How can I read one Pulse project by its id?
      - What does a single qTest Pulse project record contain?
      instructions:
      - text: Get Pulse project {id}.
        slots:
          id: path.id
      - text: Look up the qTest Pulse project with id {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'