Gainsight · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gainsight PX REST Segment API

3 actions 3 updates phrasing extends openapi/gainsight-segment-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['/v1/segment'].get

$.paths['/v1/segment/{segmentId}'].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 PX REST Segment API
  version: 1.0.0
extends: openapi/gainsight-segment-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['/v1/segment'].get
  update:
    x-apievangelist-phrasing:
      intent: List segments
      effect: read
      questions:
      - What user segments are defined in PX?
      - Can I page through segments?
      instructions:
      - text: List segments, page {pageNumber}.
        slots:
          pageNumber: query.pageNumber
      - text: Show the first {pageSize} segments.
        slots:
          pageSize: query.pageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/segment/{segmentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a segment
      effect: read
      questions:
      - How do I see one segment's definition?
      - Can I fetch a segment by ID?
      instructions:
      - text: Get segment {segmentId}.
        slots:
          segmentId: path.segmentId
      - text: Show the rules of segment {segmentId}.
        slots:
          segmentId: path.segmentId
      method: generated
      generated: '2026-09-26'