Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for NeoLoad Resources|Reservations API

4 actions 4 updates phrasing extends openapi/tricentis-resources-reservations-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['/v3/resources/reservations'].get

$.paths['/v3/resources/reservations/mode'].get

$.paths['/v3/resources/reservations/mode'].post

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 Resources|Reservations API
  version: 1.0.0
extends: openapi/tricentis-resources-reservations-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['/v3/resources/reservations'].get
  update:
    x-apievangelist-phrasing:
      intent: List resource reservations
      effect: read
      questions:
      - What reservations are booked in a given time window?
      - Can I page through the reservations on the account?
      instructions:
      - text: List reservations between {from} and {to}.
        slots:
          from: query.fromDateTime
          to: query.toDateTime
      - text: Show {limit} reservations starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/resources/reservations/mode'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether reservation mode is on
      effect: read
      questions:
      - Is reservation mode currently switched on for the account?
      - Do tests need a reservation right now?
      instructions:
      - text: Check the current reservation mode.
      - text: Tell me if reservation mode is on or off.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/resources/reservations/mode'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn reservation mode on or off
      effect: write
      questions:
      - Can I switch reservation mode off for the account?
      - What's the way to enable reservation mode?
      instructions:
      - text: Set reservation mode to {enabled}.
        slots:
          enabled: requestBody.enabled
      - text: Switch reservation mode on.
      method: generated
      generated: '2026-10-01'