Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for NeoLoad Deletion Policies API

7 actions 7 updates phrasing extends openapi/tricentis-deletion-policies-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 7

$.info

$.paths['/v3/workspaces/{workspaceId}/deletion-policies'].get

$.paths['/v3/workspaces/{workspaceId}/deletion-policies'].post

$.paths['/v3/workspaces/{workspaceId}/deletion-policies/{deletionPolicyId}'].get

$.paths['/v3/workspaces/{workspaceId}/deletion-policies/{deletionPolicyId}'].put

$.paths['/v3/workspaces/{workspaceId}/deletion-policies/{deletionPolicyId}'].delete

$.paths['/v3/workspaces/{workspaceId}/deletion-policies/{deletionPolicyId}'].patch

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for NeoLoad Deletion Policies API
  version: 1.0.0
extends: openapi/tricentis-deletion-policies-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: 6
- target: $.paths['/v3/workspaces/{workspaceId}/deletion-policies'].get
  update:
    x-apievangelist-phrasing:
      intent: List deletion policies in a workspace
      effect: read
      questions:
      - What automatic deletion policies are set up for my workspace?
      - Which rules clean up old test results?
      instructions:
      - text: List the deletion policies in workspace {ws}.
        slots:
          ws: path.workspaceId
      - text: Show all result-cleanup rules for workspace {ws}.
        slots:
          ws: path.workspaceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/deletion-policies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a deletion policy
      effect: write
      questions:
      - How do I set up a policy that deletes old test results automatically?
      - Can I filter which test results a deletion policy targets?
      instructions:
      - text: Create a deletion policy in workspace {ws} with filter {filter} and setting {setting}.
        slots:
          ws: path.workspaceId
          filter: requestBody.deletionFilter
          setting: requestBody.deletionSetting
      - text: Add a new result-retention policy to workspace {ws}.
        slots:
          ws: path.workspaceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/deletion-policies/{deletionPolicyId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a deletion policy
      effect: read
      questions:
      - How do I see the details of one deletion policy?
      - What filter does a given deletion policy use?
      instructions:
      - text: Get deletion policy {policy} in workspace {ws}.
        slots:
          ws: path.workspaceId
          policy: path.deletionPolicyId
      - text: Show the filter and setting of deletion policy {policy}.
        slots:
          policy: path.deletionPolicyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/deletion-policies/{deletionPolicyId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a deletion policy
      effect: write
      questions:
      - Can I overwrite every field of an existing deletion policy?
      - How do I fully redefine a deletion policy?
      instructions:
      - text: Replace deletion policy {policy} in workspace {ws} with filter {filter} and setting {setting}.
        slots:
          ws: path.workspaceId
          policy: path.deletionPolicyId
          filter: requestBody.deletionFilter
          setting: requestBody.deletionSetting
      - text: Fully redefine deletion policy {policy}.
        slots:
          policy: path.deletionPolicyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/deletion-policies/{deletionPolicyId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a deletion policy
      effect: destructive
      questions:
      - How do I remove a deletion policy?
      - Can I stop automatic result deletion by deleting its policy?
      instructions:
      - text: Delete deletion policy {policy} from workspace {ws}.
        slots:
          ws: path.workspaceId
          policy: path.deletionPolicyId
      - text: Remove the cleanup rule {policy}.
        slots:
          policy: path.deletionPolicyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/deletion-policies/{deletionPolicyId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a deletion policy
      effect: write
      questions:
      - Can I change only the deletion setting of a policy and leave the filter alone?
      - How do I tweak one field of a deletion policy?
      instructions:
      - text: Change only the setting of deletion policy {policy} in workspace {ws} to {setting}.
        slots:
          ws: path.workspaceId
          policy: path.deletionPolicyId
          setting: requestBody.deletionSetting
      - text: Patch the filter of deletion policy {policy} to {filter}.
        slots:
          policy: path.deletionPolicyId
          filter: requestBody.deletionFilter
      method: generated
      generated: '2026-10-01'