Gainsight · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gainsight CS CTA CTA Configuration API

5 actions 5 updates phrasing extends openapi/gainsight-cta-configuration-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 5

$.info
$.paths['/ctas/config/types'].get
$.paths['/ctas/config/reasons'].get
$.paths['/ctas/config/priorities'].get
$.paths['/ctas/config/statuses'].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 Gainsight CS CTA CTA Configuration API
  version: 1.0.0
extends: openapi/gainsight-cta-configuration-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: 4
- target: $.paths['/ctas/config/types'].get
  update:
    x-apievangelist-phrasing:
      intent: List CTA types
      effect: read
      questions:
      - What CTA types are configured in Cockpit?
      - Which type IDs can I use for a call to action, such as risk or expansion?
      instructions:
      - text: List the configured CTA types.
      - text: Show all call-to-action types.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ctas/config/reasons'].get
  update:
    x-apievangelist-phrasing:
      intent: List CTA reasons
      effect: read
      questions:
      - What reasons can be given for a CTA?
      - Can I see only the CTA reasons valid for one type?
      instructions:
      - text: List CTA reasons for type {typeId}.
        slots:
          typeId: query.typeId
      - text: Show all configured CTA reasons.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ctas/config/priorities'].get
  update:
    x-apievangelist-phrasing:
      intent: List CTA priorities
      effect: read
      questions:
      - What priority levels can a CTA have?
      - Which PriorityId means high priority?
      instructions:
      - text: List the configured CTA priorities.
      - text: Show the priority options for calls to action.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ctas/config/statuses'].get
  update:
    x-apievangelist-phrasing:
      intent: List CTA statuses
      effect: read
      questions:
      - What statuses can a CTA move through?
      - Which StatusId marks a CTA as closed?
      instructions:
      - text: List the configured CTA statuses.
      - text: Show every status a call to action can have.
      method: generated
      generated: '2026-09-26'