Gainsight · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gainsight CS Data Management Fields API

3 actions 3 updates phrasing extends openapi/gainsight-fields-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/{objectName}/fields'].get
$.paths['/meta/objects/{objectName}/fields/{fieldName}'].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 Data Management Fields API
  version: 1.0.0
extends: openapi/gainsight-fields-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/{objectName}/fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List fields on an object
      effect: read
      questions:
      - What fields does the Company object have?
      - Can I see all field definitions for a custom object?
      instructions:
      - text: List the fields of object {objectName}.
        slots:
          objectName: path.objectName
      - text: Show all field metadata on {objectName}.
        slots:
          objectName: path.objectName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/meta/objects/{objectName}/fields/{fieldName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a field's metadata
      effect: read
      questions:
      - What data type is a specific field on an object?
      - Can I check one field's definition before writing to it?
      instructions:
      - text: Get field {fieldName} on object {objectName}.
        slots:
          fieldName: path.fieldName
          objectName: path.objectName
      - text: Show the metadata for {objectName}.{fieldName}.
        slots:
          objectName: path.objectName
          fieldName: path.fieldName
      method: generated
      generated: '2026-09-26'