Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for TTM for Jira Cycles API

4 actions 4 updates phrasing extends openapi/tricentis-cycles-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 4

$.info
$.paths['/v1/projects/{project-key}/cycles'].post
$.paths['/v1/projects/{project-key}/cycles/{cycleId}'].put
$.paths['/v1/projects/{project-key}/cycles/search'].get

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 TTM for Jira Cycles API
  version: 1.0.0
extends: openapi/tricentis-cycles-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: 3
- target: $.paths['/v1/projects/{project-key}/cycles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create test cycles
      effect: write
      questions:
      - How do I create a new test cycle for a Jira project?
      - Can I create several cycles in one request?
      instructions:
      - text: Create cycles in project {project}.
        slots:
          project: path.project-key
      - text: Add a new test cycle to Jira project {project}.
        slots:
          project: path.project-key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{project-key}/cycles/{cycleId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a test cycle
      effect: write
      questions:
      - Can I reassign a test cycle to a different person?
      - How do I change a cycle's planned start and end dates?
      instructions:
      - text: Rename cycle {cycle} in project {project} to {name}.
        slots:
          cycle: path.cycleId
          project: path.project-key
          name: requestBody.name
      - text: Assign cycle {cycle} in {project} to {assignee}.
        slots:
          cycle: path.cycleId
          project: path.project-key
          assignee: requestBody.assignee
      - text: Set cycle {cycle} to end on {end}.
        slots:
          cycle: path.cycleId
          end: requestBody.plannedEndDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{project-key}/cycles/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search test cycles
      effect: read
      questions:
      - Which test cycles exist for a given release version?
      - Can I find cycles assigned to a particular person?
      instructions:
      - text: Find cycles named {name} in project {project}.
        slots:
          name: query.name
          project: path.project-key
      - text: List cycles for version {version} in {project}.
        slots:
          version: query.version
          project: path.project-key
      - text: Show cycles in {project} assigned to {assignee}.
        slots:
          project: path.project-key
          assignee: query.assignee
      method: generated
      generated: '2026-10-01'