# 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 Success Plan Objectives API
  version: 1.0.0
extends: openapi/gainsight-objectives-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['/successplans/{planId}/objectives'].get
  update:
    x-apievangelist-phrasing:
      intent: List a success plan's objectives
      effect: read
      questions:
      - What objectives are part of a customer's success plan?
      - Can I see every objective under one success plan?
      instructions:
      - text: List objectives for success plan {planId}.
        slots:
          planId: path.planId
      - text: Show the objectives inside plan {planId}.
        slots:
          planId: path.planId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/successplans/{planId}/objectives'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an objective to a success plan
      effect: write
      questions:
      - How do I add a new objective to a success plan?
      - Can I set a priority and due date on a plan objective?
      instructions:
      - text: Add objective {Name} to success plan {planId}.
        slots:
          Name: requestBody.Name
          planId: path.planId
      - text: Create objective {Name} in plan {planId} with priority {Priority}, due {DueDate}.
        slots:
          Name: requestBody.Name
          planId: path.planId
          Priority: requestBody.Priority
          DueDate: requestBody.DueDate
      method: generated
      generated: '2026-09-26'