# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for qTest Parameters API
  version: 1.0.0
extends: openapi/tricentis-parameters-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: 16
- target: $.paths['/api/v1/parameters/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a test parameter
      effect: write
      questions:
      - How do I create a new test parameter for my projects?
      - Must a new parameter be associated with at least one project?
      instructions:
      - text: Create parameter {identifier} for projects {project_ids}.
        slots:
          identifier: requestBody.identifier
          project_ids: requestBody.project_ids
      - text: Add parameter {identifier} described as {description} to projects {project_ids}.
        slots:
          identifier: requestBody.identifier
          description: requestBody.description
          project_ids: requestBody.project_ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/parameters/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Search parameters
      effect: read
      questions:
      - Which parameters are not used by any test case?
      - Can I search parameter names case sensitively?
      - Could the parameter search also return usage statistics?
      instructions:
      - text: Search parameters whose identifier contains {identifier}.
        slots:
          identifier: requestBody.identifier
      - text: Find parameters in projects {project_ids} where used is {used}.
        slots:
          project_ids: requestBody.project_ids
          used: requestBody.used
      - text: Query parameters with statuses {statuses} sorted by {sort_by}.
        slots:
          statuses: requestBody.statuses
          sort_by: requestBody.sort_by
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/parameters/bulk-query'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up parameters by exact identifiers
      effect: read
      questions:
      - Can I fetch several parameters at once by a list of identifiers?
      - Which of a given set of parameter names already exist?
      instructions:
      - text: Look up parameters with identifiers {identifiers}.
        slots:
          identifiers: requestBody.identifiers
      - text: Bulk fetch parameters {identifiers} in projects {project_ids}.
        slots:
          identifiers: requestBody.identifiers
          project_ids: requestBody.project_ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/parameters/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a parameter
      effect: read
      questions:
      - Can I retrieve a single parameter by its id?
      - What status and projects does one parameter have?
      instructions:
      - text: Get parameter {id}.
        slots:
          id: path.id
      - text: Show details of parameter {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/parameters/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a parameter
      effect: write
      questions:
      - How do I rename a parameter or change its status?
      - Can I change which projects a parameter belongs to?
      instructions:
      - text: Update parameter {id} to identifier {identifier}, status {status}, projects {project_ids}.
        slots:
          id: path.id
          identifier: requestBody.identifier
          status: requestBody.status
          project_ids: requestBody.project_ids
      - text: Change the description of parameter {id} to {description}.
        slots:
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/parameters/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete or archive a parameter
      effect: destructive
      questions:
      - Does deleting a parameter archive it unless I force it?
      - How do I permanently delete one parameter?
      instructions:
      - text: Archive parameter {id}.
        slots:
          id: path.id
      - text: Force delete parameter {id} with force {force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/parameters/bulk-delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete several parameters
      effect: destructive
      questions:
      - Can I delete many parameters in one request?
      - Is there a bulk delete for parameters?
      instructions:
      - text: Delete parameters {ids}.
        slots:
          ids: requestBody.ids
      - text: Remove the parameters with ids {ids} in bulk.
        slots:
          ids: requestBody.ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/parameters/bulk-archive'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive several parameters
      effect: destructive
      questions:
      - Can I archive a group of parameters at once?
      - What happens if a parameter I archive is still used by test cases?
      instructions:
      - text: Archive parameters {ids}.
        slots:
          ids: requestBody.ids
      - text: Archive parameters {ids} even if in use, force {force}.
        slots:
          ids: requestBody.ids
          force: requestBody.force
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/parameters/status'].put
  update:
    x-apievangelist-phrasing:
      intent: Change the status of parameters
      effect: write
      questions:
      - How do I set several parameters to inactive together?
      - Can I change one or many parameters' status in a single request?
      instructions:
      - text: Set parameters {ids} to status {status}.
        slots:
          ids: requestBody.ids
          status: requestBody.status
      - text: Mark parameters {ids} active.
        slots:
          ids: requestBody.ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/parameters/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import parameters from Excel
      effect: write
      questions:
      - Can I bulk load parameters from an Excel file?
      - What happens to duplicates when I import parameters?
      instructions:
      - text: Import parameters from {file} with options {config}.
        slots:
          file: requestBody.file
          config: requestBody.config
      - text: Upload Excel sheet {file} of parameters.
        slots:
          file: requestBody.file
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/parameters/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export parameters to Excel
      effect: write
      questions:
      - How do I export selected parameters to a spreadsheet?
      - Does a parameter export return a task I have to poll?
      instructions:
      - text: Export parameters {ids} to a file named {name}.
        slots:
          ids: requestBody.ids
          name: requestBody.name
      - text: Start an Excel export of parameters {ids}.
        slots:
          ids: requestBody.ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/download/parameters/export/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a parameter export file
      effect: read
      questions:
      - Where do I download the Excel file from a finished parameter export?
      - Can I fetch the exported parameters by export task id?
      instructions:
      - text: Download parameter export {id}.
        slots:
          id: path.id
      - text: Get the Excel file produced by export task {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/parameters/{pid}/values'].post
  update:
    x-apievangelist-phrasing:
      intent: Add values to a parameter
      effect: write
      questions:
      - How do I add new values to a parameter?
      - Can I add several values at once separated by new lines?
      instructions:
      - text: Add value {value} to parameter {pid}.
        slots:
          value: requestBody.value
          pid: path.pid
      - text: Append these newline-separated values {value} to parameter {pid}.
        slots:
          value: requestBody.value
          pid: path.pid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/parameters/{pid}/values/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a parameter value
      effect: write
      questions:
      - Can I change the text of one value inside a parameter?
      - How do I reorder a parameter's values?
      instructions:
      - text: Change value {id} of parameter {pid} to {value} at order {order}.
        slots:
          id: path.id
          pid: path.pid
          value: requestBody.value
          order: requestBody.order
      - text: Move value {id} of parameter {pid} to position {order}, keeping text {value}.
        slots:
          id: path.id
          pid: path.pid
          order: requestBody.order
          value: requestBody.value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/parameters/{pid}/values/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete values from a parameter
      effect: destructive
      questions:
      - Can I remove several values from a parameter in one call?
      - Which call deletes values without deleting the parameter itself?
      instructions:
      - text: Delete values from parameter {pid}.
        slots:
          pid: path.pid
      - text: Remove the selected values of parameter {pid}.
        slots:
          pid: path.pid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/parameters/{pid}/values/query'].post
  update:
    x-apievangelist-phrasing:
      intent: List a parameter's values
      effect: read
      questions:
      - What values does a given parameter contain?
      - Can I sort a parameter's values in descending order?
      instructions:
      - text: List the values of parameter {pid}.
        slots:
          pid: path.pid
      - text: Show values of parameter {pid} sorted {sort_order}.
        slots:
          pid: path.pid
          sort_order: requestBody.sort_order
      method: generated
      generated: '2026-10-01'