Gainsight · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gainsight CS Data Management Objects API

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

$.paths['/meta/objects/{objectName}'].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 Data Management Objects API
  version: 1.0.0
extends: openapi/gainsight-objects-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['/meta/objects'].get
  update:
    x-apievangelist-phrasing:
      intent: List data objects
      effect: read
      questions:
      - What standard and custom objects exist in my Gainsight org?
      - Can I get metadata for every object at once?
      instructions:
      - text: List all Gainsight objects.
      - text: Show metadata for every standard and custom object.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/meta/objects/{objectName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an object's metadata
      effect: read
      questions:
      - What is the definition of a particular object, such as Company?
      - Can I fetch metadata for one custom object by name?
      instructions:
      - text: Get metadata for object {objectName}.
        slots:
          objectName: path.objectName
      - text: Describe the {objectName} object.
        slots:
          objectName: path.objectName
      method: generated
      generated: '2026-09-26'