Gainsight · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gainsight CS Task and Playbook Playbooks API

3 actions 3 updates phrasing extends openapi/gainsight-playbooks-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Gainsight's API. It is a proposal applied on top of the contract, not a document Gainsight publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/playbooks'].get

$.paths['/playbooks/{playbookId}'].get

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 Gainsight CS Task and Playbook Playbooks API
  version: 1.0.0
extends: openapi/gainsight-playbooks-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/playbooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List playbooks
      effect: read
      questions:
      - What playbooks are configured for CTAs?
      - Which PlaybookId can I attach to a new CTA?
      instructions:
      - text: List the configured playbooks.
      - text: Show every playbook available.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/playbooks/{playbookId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a playbook and its tasks
      effect: read
      questions:
      - What task templates are in a particular playbook?
      - Can I see the steps a playbook will create?
      instructions:
      - text: Get playbook {playbookId}.
        slots:
          playbookId: path.playbookId
      - text: Show the task templates in playbook {playbookId}.
        slots:
          playbookId: path.playbookId
      method: generated
      generated: '2026-09-26'