Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for qTest Parameters Datasets API

12 actions 12 updates phrasing extends openapi/tricentis-datasets-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Tricentis's API. It is a proposal applied on top of the contract, not a document Tricentis publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 12

$.info
$.paths['/api/v1/data-sets/create'].post
$.paths['/api/v1/data-sets/{id}'].get
$.paths['/api/v1/data-sets/{id}'].put
$.paths['/api/v1/data-sets/{id}'].delete
$.paths['/api/v1/data-sets/query'].post
$.paths['/api/v1/data-sets/bulk-delete'].post
$.paths['/api/v1/data-sets/status'].put
$.paths['/api/v1/data-sets/import'].post
$.paths['/api/v1/data-sets/{dsId}/rows'].get
$.paths['/api/v1/data-sets/{dsId}/rows'].post
$.paths['/api/v1/data-sets/{dsId}/rows/delete'].post

OpenAPI Overlay

Raw ↑
# 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 Datasets API
  version: 1.0.0
extends: openapi/tricentis-datasets-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: 11
- target: $.paths['/api/v1/data-sets/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a dataset
      effect: write
      questions:
      - How do I create a new test dataset?
      - Can I link a dataset to several projects when I create it?
      instructions:
      - text: Create a dataset named {name}.
        slots:
          name: requestBody.name
      - text: Create dataset {name} linked to projects {project_ids}.
        slots:
          name: requestBody.name
          project_ids: requestBody.project_ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/data-sets/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a dataset
      effect: read
      questions:
      - Can I retrieve one dataset by its id?
      - What headers and status does a given dataset have?
      instructions:
      - text: Get dataset {id}.
        slots:
          id: path.id
      - text: Show the details of dataset {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/data-sets/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a dataset
      effect: write
      questions:
      - Can I rename a dataset or change its description?
      - How would I relink an existing dataset to different projects?
      instructions:
      - text: Rename dataset {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update dataset {id} with description {description}.
        slots:
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/data-sets/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a dataset
      effect: destructive
      questions:
      - How do I delete a single dataset?
      - Can I remove one dataset by id?
      instructions:
      - text: Delete dataset {id}.
        slots:
          id: path.id
      - text: Permanently remove the dataset with id {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/data-sets/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Search datasets
      effect: read
      questions:
      - Which datasets have a name containing a keyword?
      - Can I list only inactive datasets for a project?
      - What fields can I sort dataset results by?
      instructions:
      - text: Search datasets whose name contains {name}.
        slots:
          name: requestBody.name
      - text: Find datasets in projects {project_ids} with statuses {statuses}.
        slots:
          project_ids: requestBody.project_ids
          statuses: requestBody.statuses
      - text: Query datasets sorted by {sort_by}.
        slots:
          sort_by: requestBody.sort_by
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/data-sets/bulk-delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete several datasets
      effect: destructive
      questions:
      - Can I delete many datasets in one call?
      - Is there a bulk delete for datasets?
      instructions:
      - text: Bulk delete the selected datasets.
      - text: Remove multiple datasets at once.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/data-sets/status'].put
  update:
    x-apievangelist-phrasing:
      intent: Change the status of several datasets
      effect: write
      questions:
      - How do I deactivate a batch of datasets at once?
      - Can I mark several datasets active in one request?
      instructions:
      - text: Set datasets {ids} to status {status}.
        slots:
          ids: requestBody.ids
          status: requestBody.status
      - text: Mark datasets {ids} as inactive.
        slots:
          ids: requestBody.ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/data-sets/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import datasets from Excel
      effect: write
      questions:
      - Can I import datasets from an Excel workbook?
      - How do I track progress of a dataset import?
      instructions:
      - text: Import datasets from {file} with options {config}.
        slots:
          file: requestBody.file
          config: requestBody.config
      - text: Upload Excel file {file} as new datasets.
        slots:
          file: requestBody.file
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/data-sets/{dsId}/rows'].get
  update:
    x-apievangelist-phrasing:
      intent: List a dataset's rows
      effect: read
      questions:
      - What values are stored in the rows of a dataset?
      - Can I page through rows of a large dataset?
      instructions:
      - text: List the rows of dataset {dataset}.
        slots:
          dataset: path.dsId
      - text: Show page {offset} of rows in dataset {dataset}.
        slots:
          offset: query.offset
          dataset: path.dsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/data-sets/{dsId}/rows'].post
  update:
    x-apievangelist-phrasing:
      intent: Add rows to a dataset
      effect: write
      questions:
      - How do I add new value rows to a dataset?
      - Can I insert several rows of values in one request?
      instructions:
      - text: Add rows to dataset {dataset}.
        slots:
          dataset: path.dsId
      - text: Insert new values into dataset {dataset}.
        slots:
          dataset: path.dsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/data-sets/{dsId}/rows/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete rows from a dataset
      effect: destructive
      questions:
      - Can I remove several value rows from a dataset at once?
      - Which call deletes rows inside a dataset without deleting the dataset?
      instructions:
      - text: Delete rows from dataset {dataset}.
        slots:
          dataset: path.dsId
      - text: Remove the chosen values in dataset {dataset}.
        slots:
          dataset: path.dsId
      method: generated
      generated: '2026-10-01'