Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tricentis Folders API

6 actions 6 updates phrasing extends openapi/tricentis-folders-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 6

$.info
$.paths['/folders'].get
$.paths['/folders({id})'].get
$.paths['/v1/projects/{project-key}/folders'].get
$.paths['/v1/projects/{project-key}/folders'].post
$.paths['/v1/projects/{project-key}/folders/{folderId}'].put

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 Tricentis Folders API
  version: 1.0.0
extends: openapi/tricentis-folders-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: 5
- target: $.paths['/folders'].get
  update:
    x-apievangelist-phrasing:
      intent: List folders in the analytics feed
      effect: read
      questions:
      - Which folders appear in the test analytics data?
      - Can I search analytics folder records by phrase?
      instructions:
      - text: List all analytics folders.
      - text: List analytics folders matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/folders({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an analytics folder by key
      effect: read
      questions:
      - How do I read one folder record from the analytics feed?
      - Can I pick which fields come back for one analytics folder?
      instructions:
      - text: Get analytics folder {id}.
        slots:
          id: path.id
      - text: Show only {select} of analytics folder {id}.
        slots:
          select: query.$select
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{project-key}/folders'].get
  update:
    x-apievangelist-phrasing:
      intent: List test case folders in a Jira project
      effect: read
      questions:
      - Which test case folders exist in my Jira project?
      - Can I list subfolders under a particular parent folder?
      instructions:
      - text: List root test folders in project {project}.
        slots:
          project: path.project-key
      - text: List subfolders of {parent} in project {project}.
        slots:
          parent: query.parentId
          project: path.project-key
      - text: Find test folders named {name} in {project}.
        slots:
          name: query.name
          project: path.project-key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{project-key}/folders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create test case folders
      effect: write
      questions:
      - How do I create new test case folders in a Jira project?
      - Can I create several folders in a single request?
      instructions:
      - text: Create folders in project {project}.
        slots:
          project: path.project-key
      - text: Add new test case folders to Jira project {project}.
        slots:
          project: path.project-key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{project-key}/folders/{folderId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or move a test case folder
      effect: write
      questions:
      - Can I move a test folder under a different parent?
      - How do I rename a test case folder?
      instructions:
      - text: Rename folder {folder} in project {project} to {name}.
        slots:
          folder: path.folderId
          project: path.project-key
          name: requestBody.name
      - text: Move folder {folder} in {project} under parent {parent}.
        slots:
          folder: path.folderId
          project: path.project-key
          parent: requestBody.parentId
      method: generated
      generated: '2026-10-01'