Gainsight · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gainsight PX Engagements API

2 actions 2 updates phrasing extends openapi/gainsight-engagements-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 2

$.info
$.paths['/engagements'].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 PX Engagements API
  version: 1.0.0
extends: openapi/gainsight-engagements-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: 1
- target: $.paths['/engagements'].get
  update:
    x-apievangelist-phrasing:
      intent: List in-app engagements
      effect: read
      questions:
      - What in-app engagements are set up in Gainsight PX?
      - Can I page through engagements with a scroll cursor?
      instructions:
      - text: List my in-app engagements.
      - text: Get the next page of engagements after scroll ID {scrollId}.
        slots:
          scrollId: query.scrollId
      method: generated
      generated: '2026-09-26'