API Evangelist conversational phrasing for qTest Manager API Version 3.0 Field 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 Field API
  version: 1.0.0
extends: openapi/tricentis-field-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: 18
- target: $.paths['/api/v3/fields/{objectType}'].get
  update:
    x-apievangelist-phrasing:
      intent: List site-level fields of an object type
      effect: read
      questions:
      - What site-wide fields exist for test cases across all projects?
      - Can I page through the site-level fields defined for defects?
      instructions:
      - text: List the site-level fields for {type}.
        slots:
          type: path.objectType
      - text: Show page {page} of site fields for object type {type}.
        slots:
          type: path.objectType
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/fields/{objectType}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a site-level custom field
      effect: write
      questions:
      - How do I add a custom field that applies at the site level for every project?
      - Can a new site field be required and searchable?
      instructions:
      - text: Create a site-level custom field labelled {label} on {type}.
        slots:
          type: path.objectType
          label: requestBody.label
      - text: Add a required site field {label} of data type {data_type} for {type}.
        slots:
          type: path.objectType
          label: requestBody.label
          data_type: requestBody.data_type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/fields/{objectType}/{fieldId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a site-level custom field
      effect: read
      questions:
      - How can I look up one site-level custom field's settings?
      - What data type and default value does a given site field have?
      instructions:
      - text: Get site field {field} of {type}.
        slots:
          type: path.objectType
          field: path.fieldId
      - text: Show the settings of site-level custom field {field} on {type}.
        slots:
          type: path.objectType
          field: path.fieldId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/fields/{objectType}/{fieldId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a site-level custom field
      effect: write
      questions:
      - Can I rename or deactivate a site-wide custom field?
      - How do I make an existing site field required for everyone?
      instructions:
      - text: Rename site field {field} on {type} to {label}.
        slots:
          type: path.objectType
          field: path.fieldId
          label: requestBody.label
      - text: Deactivate the site-level custom field {field} of {type}.
        slots:
          type: path.objectType
          field: path.fieldId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/fields/{objectType}/{fieldId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a site-level custom field
      effect: destructive
      questions:
      - Can I delete a custom field defined at the site level?
      - What's the way to remove an unused site-wide field from requirements?
      instructions:
      - text: Delete site field {field} from {type}.
        slots:
          type: path.objectType
          field: path.fieldId
      - text: Remove the site-level custom field {field} on {type} permanently.
        slots:
          type: path.objectType
          field: path.fieldId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/fields/{objectType}/{fieldId}/allowed-values'].get
  update:
    x-apievangelist-phrasing:
      intent: List allowed values of a site field
      effect: read
      questions:
      - Which options can be picked in a site-level combo box field?
      - Can I list the allowed values of a site-wide user list field?
      instructions:
      - text: List the allowed values of site field {field} on {type}.
        slots:
          type: path.objectType
          field: path.fieldId
      - text: Show page {page} of options for site-level field {field} of {type}.
        slots:
          type: path.objectType
          field: path.fieldId
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/fields/{objectType}/{fieldId}/allowed-values'].post
  update:
    x-apievangelist-phrasing:
      intent: Add allowed values to a site field
      effect: write
      questions:
      - How many new options can I add to a site-level dropdown field at once?
      - Can I add choices to a site-wide check box field?
      instructions:
      - text: Add allowed values to site field {field} on {type}.
        slots:
          type: path.objectType
          field: path.fieldId
      - text: Create new dropdown options for the site-level field {field} of {type}.
        slots:
          type: path.objectType
          field: path.fieldId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/fields/{objectType}/{fieldId}/allowed-values/{value}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an allowed value of a site field
      effect: write
      questions:
      - Can I change the label or color of one option in a site-level field?
      - How do I make a site field option the default?
      instructions:
      - text: Update option {value} of site field {field} on {type}.
        slots:
          type: path.objectType
          field: path.fieldId
          value: path.value
      - text: Relabel allowed value {value} of site-level field {field} ({type}) to {label}.
        slots:
          type: path.objectType
          field: path.fieldId
          value: path.value
          label: requestBody.label
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/fields/{objectType}/{fieldId}/allowed-values/{value}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an allowed value of a site field
      effect: destructive
      questions:
      - Can I remove an outdated choice from a site-level combo box?
      - What's involved in deleting one option of a site-wide field?
      instructions:
      - text: Delete allowed value {value} from site field {field} on {type}.
        slots:
          type: path.objectType
          field: path.fieldId
          value: path.value
      - text: Remove option {value} of the site-level field {field} for {type}.
        slots:
          type: path.objectType
          field: path.fieldId
          value: path.value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/settings/{objectType}/fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's fields for an object type
      effect: read
      questions:
      - Which fields does my project use for test runs, including inactive ones?
      - What fields are configured on requirements in a specific project?
      instructions:
      - text: List the fields of {type} in project {project}.
        slots:
          project: path.projectId
          type: path.objectType
      - text: Show all {type} fields in project {project}, including inactive ones.
        slots:
          project: path.projectId
          type: path.objectType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/settings/{objectType}/fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a project custom field
      effect: write
      questions:
      - How do I add a custom field to test cases in just one project?
      - Can a project-level custom field have allowed values and a default?
      instructions:
      - text: Create a custom field labelled {label} on {type} in project {project}.
        slots:
          project: path.projectId
          type: path.objectType
          label: requestBody.label
      - text: Add a project field {label} with data type {data_type} to {type} in project {project}.
        slots:
          project: path.projectId
          type: path.objectType
          label: requestBody.label
          data_type: requestBody.data_type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/settings/{objectType}/fields/{fieldId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project custom field
      effect: read
      questions:
      - How can I read one project-level custom field's configuration?
      - Is a particular project field required or searchable?
      instructions:
      - text: Get field {field} of {type} in project {project}.
        slots:
          project: path.projectId
          type: path.objectType
          field: path.fieldId
      - text: Show the configuration of project custom field {field} on {type} in project {project}.
        slots:
          project: path.projectId
          type: path.objectType
          field: path.fieldId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/settings/{objectType}/fields/{fieldId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a project custom field
      effect: write
      questions:
      - Can I change the label of a custom field in one project?
      - How do I mark a project-level field inactive?
      instructions:
      - text: Rename field {field} on {type} in project {project} to {label}.
        slots:
          project: path.projectId
          type: path.objectType
          field: path.fieldId
          label: requestBody.label
      - text: Make project custom field {field} of {type} in project {project} required.
        slots:
          project: path.projectId
          type: path.objectType
          field: path.fieldId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/settings/{objectType}/fields/{fieldId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a project custom field
      effect: destructive
      questions:
      - Can I delete a custom field from a single project?
      - Which project-level fields can be removed from defects?
      instructions:
      - text: Delete field {field} from {type} in project {project}.
        slots:
          project: path.projectId
          type: path.objectType
          field: path.fieldId
      - text: Remove the project custom field {field} on {type} in project {project} permanently.
        slots:
          project: path.projectId
          type: path.objectType
          field: path.fieldId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/settings/{objectType}/fields/{fieldId}/allowed-values'].get
  update:
    x-apievangelist-phrasing:
      intent: List allowed values of a project field
      effect: read
      questions:
      - What options are available in a project's custom dropdown field?
      - Can I page through the allowed values of a project-level user list field?
      instructions:
      - text: List the allowed values of field {field} on {type} in project {project}.
        slots:
          project: path.projectId
          type: path.objectType
          field: path.fieldId
      - text: Show page {page} of options for project field {field} ({type}) in project {project}.
        slots:
          project: path.projectId
          type: path.objectType
          field: path.fieldId
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/settings/{objectType}/fields/{fieldId}/allowed-values'].post
  update:
    x-apievangelist-phrasing:
      intent: Add allowed values to a project field
      effect: write
      questions:
      - How can I add options to a combo box field in one project?
      - Is there a limit on how many values I can add to a project field at once?
      instructions:
      - text: Add allowed values to field {field} on {type} in project {project}.
        slots:
          project: path.projectId
          type: path.objectType
          field: path.fieldId
      - text: Create new options for project field {field} of {type} in project {project}.
        slots:
          project: path.projectId
          type: path.objectType
          field: path.fieldId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/settings/{objectType}/fields/{fieldId}/allowed-values/{value}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an allowed value of a project field
      effect: write
      questions:
      - Can I recolor or reorder a single option of a project-level field?
      - How do I deactivate one choice in a project dropdown without deleting it?
      instructions:
      - text: Update option {value} of field {field} on {type} in project {project}.
        slots:
          project: path.projectId
          type: path.objectType
          field: path.fieldId
          value: path.value
      - text: Set the label of value {value} in project field {field} ({type}, project {project}) to {label}.
        slots:
          project: path.projectId
          type: path.objectType
          field: path.fieldId
          value: path.value
          label: requestBody.label
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/settings/{objectType}/fields/{fieldId}/allowed-values/{value}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an allowed value of a project field
      effect: destructive
      questions:
      - Can I delete one option from a project's check box field?
      - What's the way to drop an obsolete value from a project dropdown?
      instructions:
      - text: Delete allowed value {value} from field {field} on {type} in project {project}.
        slots:
          project: path.projectId
          type: path.objectType
          field: path.fieldId
          value: path.value
      - text: Remove option {value} of project field {field} for {type} in project {project}.
        slots:
          project: path.projectId
          type: path.objectType
          field: path.fieldId
          value: path.value
      method: generated
      generated: '2026-10-01'