Gainsight · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gainsight CS Customer Goals API

5 actions 5 updates phrasing extends openapi/gainsight-goals-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['/goals'].post

$.paths['/goals/{goalId}'].get

$.paths['/goals/{goalId}'].put

$.paths['/goals/search'].post

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 Customer Goals API
  version: 1.0.0
extends: openapi/gainsight-goals-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['/goals'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a customer goal
      effect: write
      questions:
      - How do I record a customer's business goal with a target date?
      - Can I create a goal from a goal template?
      instructions:
      - text: Create goal {Name} for company {CompanyId}.
        slots:
          Name: requestBody.Name
          CompanyId: requestBody.CompanyId
      - text: Add a goal {Name} to company {CompanyId} from template {TemplateId}, targeting {TargetDate}.
        slots:
          Name: requestBody.Name
          CompanyId: requestBody.CompanyId
          TemplateId: requestBody.TemplateId
          TargetDate: requestBody.TargetDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/goals/{goalId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a customer goal
      effect: read
      questions:
      - What is the status of a particular customer goal?
      - Can I fetch one goal by ID?
      instructions:
      - text: Get goal {goalId}.
        slots:
          goalId: path.goalId
      - text: Show the details of customer goal {goalId}.
        slots:
          goalId: path.goalId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/goals/{goalId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a customer goal
      effect: write
      questions:
      - Can I mark a customer goal as achieved?
      - How do I change a goal's target date or owner?
      instructions:
      - text: Update goal {goalId} to status {Status} (name {Name}, company {CompanyId}).
        slots:
          goalId: path.goalId
          Status: requestBody.Status
          Name: requestBody.Name
          CompanyId: requestBody.CompanyId
      - text: Move the target date of goal {goalId} to {TargetDate}, keeping name {Name} and company {CompanyId}.
        slots:
          goalId: path.goalId
          TargetDate: requestBody.TargetDate
          Name: requestBody.Name
          CompanyId: requestBody.CompanyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/goals/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search customer goals
      effect: read
      questions:
      - Which customers have open goals due this quarter?
      - Can I filter goals by company or status?
      instructions:
      - text: Search customer goals where {where}.
        slots:
          where: requestBody.where
      - text: Find up to {limit} goals matching {where}.
        slots:
          limit: requestBody.limit
          where: requestBody.where
      method: generated
      generated: '2026-09-26'