API Evangelist conversational phrasing for qTest Manager API Version 3.0 Integration Settings API

# 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 Integration Settings API
  version: 1.0.0
extends: openapi/tricentis-integration-settings-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: 21
- target: $.paths['/api/v3/projects/{projectId}/settings/integration/connections'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's Jira connections
      effect: read
      questions:
      - Which Jira connections are set up for my qTest project?
      - Can I see every Jira integration configured on a project at once?
      instructions:
      - text: List the Jira connections in project {project}.
        slots:
          project: path.projectId
      - text: Show me all Jira integrations configured for project {project}.
        slots:
          project: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/settings/integration/connections'].post
  update:
    x-apievangelist-phrasing:
      intent: Connect a project to a Jira server
      effect: write
      questions:
      - How do I connect a qTest project to our Jira instance?
      - Can I add a Jira connection that authenticates with a username and API token?
      instructions:
      - text: Add a Jira connection named {name} pointing at {server_url} to project {project}.
        slots:
          name: requestBody.connection_name
          server_url: requestBody.server_url
          project: path.projectId
      - text: Connect project {project} to Jira at {server_url} as user {username} with token {token}.
        slots:
          project: path.projectId
          server_url: requestBody.server_url
          username: requestBody.username
          token: requestBody.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/settings/integration/connections/oauthAuthorizeURL'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the OAuth authorize URL for Jira Server
      effect: read
      questions:
      - Where do I get the OAuth authorization link to connect Jira Server or Data Center?
      - Is there an OAuth authorize URL I can open to approve a Jira DC connection?
      instructions:
      - text: Get the Jira OAuth authorize URL for server {server} in project {project}.
        slots:
          server: query.serverUrl
          project: path.projectId
      - text: Generate the OAuth approval link for Jira Data Center at {server} for project {project}.
        slots:
          server: query.serverUrl
          project: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/settings/integration/connections/{connectionId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Activate or deactivate a Jira connection
      effect: write
      questions:
      - Can I temporarily turn off a Jira connection without deleting it?
      - How can I reactivate a Jira connection that was switched off?
      instructions:
      - text: Deactivate Jira connection {connection} in project {project}.
        slots:
          project: path.projectId
          connection: path.connectionId
      - text: Set Jira connection {connection} in project {project} to active={active}.
        slots:
          project: path.projectId
          connection: path.connectionId
          active: query.active
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/settings/integration/connections/{connectionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Jira connection
      effect: destructive
      questions:
      - Can I permanently remove a Jira connection from a project?
      - What happens when I delete a Jira integration connection in qTest?
      instructions:
      - text: Delete Jira connection {connection} from project {project}.
        slots:
          project: path.projectId
          connection: path.connectionId
      - text: Remove the Jira integration {connection} in project {project} for good.
        slots:
          project: path.projectId
          connection: path.connectionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/settings/integration/connections/{connectionId}/defect'].put
  update:
    x-apievangelist-phrasing:
      intent: Toggle storing unlinked Jira defects
      effect: write
      questions:
      - Can qTest pull in Jira defects that aren't linked to any test run?
      - How do I stop a Jira connection from populating unlinked defects?
      instructions:
      - text: Turn on populating unlinked Jira defects for connection {connection} in project {project}.
        slots:
          project: path.projectId
          connection: path.connectionId
      - text: Set store unlinked defects to {enabled} on Jira connection {connection} in project {project}.
        slots:
          project: path.projectId
          connection: path.connectionId
          enabled: query.storeUnlinkedDefects
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/settings/integration/connections/{connectionId}/defect/mappings'].get
  update:
    x-apievangelist-phrasing:
      intent: List defect mappings of a Jira connection
      effect: read
      questions:
      - Which Jira issue types are mapped to qTest defects on this connection?
      - Can I filter a connection's defect mappings by Jira project?
      instructions:
      - text: Show the defect mappings of Jira connection {connection} in project {project}.
        slots:
          project: path.projectId
          connection: path.connectionId
      - text: List defect mappings for Jira project {jira_project} on connection {connection} in project {project}.
        slots:
          project: path.projectId
          connection: path.connectionId
          jira_project: query.externalProjectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/settings/integration/connections/{connectionId}/defect/mappings'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Jira defect mapping
      effect: write
      questions:
      - Can I change an existing defect mapping so attachments are sent to Jira?
      - How can I edit the field configuration of a Jira defect mapping I already created?
      instructions:
      - text: Update the defect mapping for Jira project {jira_project} and issue type {issue_type} on connection {connection} in project {project}.
        slots:
          project: path.projectId
          connection: path.connectionId
          jira_project: query.externalProjectId
          issue_type: query.externalIssueTypeId
      - text: Enable sending attachments to Jira on the defect mapping for {jira_project}/{issue_type}, connection {connection}, project {project}.
        slots:
          project: path.projectId
          connection: path.connectionId
          jira_project: query.externalProjectId
          issue_type: query.externalIssueTypeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/settings/integration/connections/{connectionId}/defect/mappings'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a defect mapping to a Jira connection
      effect: write
      questions:
      - How can I map a new Jira issue type to qTest defects?
      - Can I add another Jira project as a defect source on an existing connection?
      instructions:
      - text: Add a defect mapping for Jira project {jira_project} with issue type {issue_type} to connection {connection} in project {project}.
        slots:
          project: path.projectId
          connection: path.connectionId
          jira_project: query.externalProjectId
          issue_type: query.externalIssueTypeId
      - text: Map Jira issue type {issue_type} of project {jira_project} as defects on connection {connection}, project {project}.
        slots:
          project: path.projectId
          connection: path.connectionId
          jira_project: query.externalProjectId
          issue_type: query.externalIssueTypeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/settings/integration/connections/{connectionId}/refreshFieldSettings'].post
  update:
    x-apievangelist-phrasing:
      intent: Refresh field settings from Jira
      effect: write
      questions:
      - We added fields in Jira; how do I make qTest pick up the latest field settings?
      - Can I refresh Jira field settings for just one requirement or defect mapping?
      instructions:
      - text: Refresh the Jira {artifact} field settings for connection {connection} in project {project}.
        slots:
          project: path.projectId
          connection: path.connectionId
          artifact: query.artifact
      - text: Re-pull Jira field settings for {artifact} mapping {mapping} on connection {connection}, project {project}.
        slots:
          project: path.projectId
          connection: path.connectionId
          artifact: query.artifact
          mapping: query.mappingId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/settings/integration/connections/{connectionId}/release'].put
  update:
    x-apievangelist-phrasing:
      intent: Toggle Jira release integration
      effect: write
      questions:
      - Can I sync Jira fix versions into qTest as releases?
      - Is there an option to merge duplicated fix versions when release integration is on?
      instructions:
      - text: Enable release integration on Jira connection {connection} in project {project}.
        slots:
          project: path.projectId
          connection: path.connectionId
      - text: Turn release integration {active} on connection {connection} in project {project} and merge duplicate fix versions.
        slots:
          project: path.projectId
          connection: path.connectionId
          active: query.active
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/settings/integration/connections/{connectionId}/release/mappings'].get
  update:
    x-apievangelist-phrasing:
      intent: List release mappings of a Jira connection
      effect: read
      questions:
      - Which Jira projects feed releases through this connection?
      - What release mappings exist on a given Jira connection?
      instructions:
      - text: List the release mappings on Jira connection {connection} in project {project}.
        slots:
          project: path.projectId
          connection: path.connectionId
      - text: Show release mappings for Jira project {jira_project} on connection {connection}, project {project}.
        slots:
          project: path.projectId
          connection: path.connectionId
          jira_project: query.externalProjectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/settings/integration/connections/{connectionId}/release/mappings'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Jira release mapping
      effect: write
      questions:
      - Can I make a Jira release mapping auto-update its release scope?
      - How can I change the data retrieval options on an existing release mapping?
      instructions:
      - text: Reconfigure how Jira fix versions from {jira_project} ({issue_type}) become releases on connection {connection}, project {project}.
        slots:
          project: path.projectId
          connection: path.connectionId
          jira_project: query.externalProjectId
          issue_type: query.externalIssueTypeId
      - text: Turn on auto-update for release mapping {jira_project}/{issue_type} on connection {connection}, project {project}.
        slots:
          project: path.projectId
          connection: path.connectionId
          jira_project: query.externalProjectId
          issue_type: query.externalIssueTypeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/settings/integration/connections/{connectionId}/release/mappings'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a release mapping to a Jira connection
      effect: write
      questions:
      - How can I start importing releases from another Jira project?
      - Can I add a new release mapping to a Jira connection?
      instructions:
      - text: Add a release mapping for Jira project {jira_project}, issue type {issue_type}, to connection {connection} in project {project}.
        slots:
          project: path.projectId
          connection: path.connectionId
          jira_project: query.externalProjectId
          issue_type: query.externalIssueTypeId
      - text: Map Jira project {jira_project} releases into connection {connection} of project {project} using issue type {issue_type}.
        slots:
          project: path.projectId
          connection: path.connectionId
          jira_project: query.externalProjectId
          issue_type: query.externalIssueTypeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/settings/integration/connections/{connectionId}/requirement'].put
  update:
    x-apievangelist-phrasing:
      intent: Toggle Jira requirement integration
      effect: write
      questions:
      - Can I import Jira issues as qTest requirements?
      - How can I switch off requirement integration on one Jira connection?
      instructions:
      - text: Enable requirement integration on Jira connection {connection} in project {project}.
        slots:
          project: path.projectId
          connection: path.connectionId
      - text: Set requirement integration active={active} for connection {connection} in project {project}.
        slots:
          project: path.projectId
          connection: path.connectionId
          active: query.active
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/settings/integration/connections/{connectionId}/requirement/mappings'].get
  update:
    x-apievangelist-phrasing:
      intent: List requirement mappings of a Jira connection
      effect: read
      questions:
      - Which Jira issue types are imported as requirements on this connection?
      - Can I list requirement mappings filtered by Jira issue type?
      instructions:
      - text: List requirement mappings of Jira connection {connection} in project {project}.
        slots:
          project: path.projectId
          connection: path.connectionId
      - text: Show requirement mappings for Jira issue type {issue_type} on connection {connection}, project {project}.
        slots:
          project: path.projectId
          connection: path.connectionId
          issue_type: query.externalIssueTypeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/settings/integration/connections/{connectionId}/requirement/mappings'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Jira requirement mapping
      effect: write
      questions:
      - Can I change the Jira filter used by an existing requirement mapping?
      - How do I choose which Jira fields show on requirements from a mapping?
      instructions:
      - text: Change which Jira {issue_type} issues from {jira_project} sync as requirements on connection {connection}, project {project}.
        slots:
          project: path.projectId
          connection: path.connectionId
          jira_project: query.externalProjectId
          issue_type: query.externalIssueTypeId
      - text: Set the Jira filter {filter} on requirement mapping {jira_project}/{issue_type}, connection {connection}, project {project}.
        slots:
          project: path.projectId
          connection: path.connectionId
          filter: requestBody.external_filter
          jira_project: query.externalProjectId
          issue_type: query.externalIssueTypeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/settings/integration/connections/{connectionId}/requirement/mappings'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a requirement mapping to a Jira connection
      effect: write
      questions:
      - Can I map a Jira issue type like Story into qTest requirements?
      - What do I need to add a requirement mapping to a connection?
      instructions:
      - text: Add a requirement mapping for Jira project {jira_project}, issue type {issue_type}, to connection {connection} in project {project}.
        slots:
          project: path.projectId
          connection: path.connectionId
          jira_project: query.externalProjectId
          issue_type: query.externalIssueTypeId
      - text: Import Jira issue type {issue_type} from {jira_project} as requirements via connection {connection}, project {project}.
        slots:
          project: path.projectId
          connection: path.connectionId
          jira_project: query.externalProjectId
          issue_type: query.externalIssueTypeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/settings/integration/connections/{connectionId}/retrieve'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve data now from a Jira connection
      effect: write
      questions:
      - Can I force qTest to pull requirements or releases from Jira right now?
      - Is there a way to kick off a Jira sync for one connection on demand?
      instructions:
      - text: Retrieve {artifact} data now from Jira connection {connection} in project {project}.
        slots:
          project: path.projectId
          connection: path.connectionId
          artifact: query.artifact
      - text: Kick off a Jira sync of {artifact} on connection {connection}, project {project}.
        slots:
          project: path.projectId
          connection: path.connectionId
          artifact: query.artifact
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/settings/integration/connections/{connectionId}/{artifact}/mappings'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a mapping from a Jira connection
      effect: destructive
      questions:
      - Can I delete a requirement, release or defect mapping from a Jira connection?
      - How do I stop importing one Jira issue type without removing the whole connection?
      instructions:
      - text: Remove the {artifact} mapping for Jira project {jira_project}, issue type {issue_type}, from connection {connection} in project {project}.
        slots:
          project: path.projectId
          connection: path.connectionId
          artifact: path.artifact
          jira_project: query.externalProjectId
          issue_type: query.externalIssueTypeId
      - text: Delete {artifact} mapping {jira_project}/{issue_type} on connection {connection}, project {project}.
        slots:
          project: path.projectId
          connection: path.connectionId
          artifact: path.artifact
          jira_project: query.externalProjectId
          issue_type: query.externalIssueTypeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/settings/jira-integration/defect/retrieve'].post
  update:
    x-apievangelist-phrasing:
      intent: Retrieve defects from Jira for a project
      effect: write
      questions:
      - Can I trigger a project-wide pull of defects from the integrated Jira system?
      - Is there a way to refresh Jira defects across the whole project at once?
      instructions:
      - text: Trigger defect retrieval from Jira for project {project}.
        slots:
          project: path.projectId
      - text: Pull the latest Jira defects into project {project}.
        slots:
          project: path.projectId
      method: generated
      generated: '2026-10-01'