Gainsight · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gainsight PX REST Feature API

7 actions 7 updates phrasing extends openapi/gainsight-feature-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 7

$.info
$.paths['/v1/feature'].get
$.paths['/v1/feature/adoption/{featureId}'].get
$.paths['/v1/feature/backfill/{featureId}'].post
$.paths['/v1/feature/{featureId}'].get
$.paths['/v1/feature/{featureId}'].put
$.paths['/v2/feature_ext'].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 PX REST Feature API
  version: 1.0.0
extends: openapi/gainsight-feature-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: 6
- target: $.paths['/v1/feature'].get
  update:
    x-apievangelist-phrasing:
      intent: List tracked features
      effect: read
      questions:
      - What features are defined in my product's feature tree?
      - Can I list features for one product key only?
      instructions:
      - text: List features for product key {propertyKey}.
        slots:
          propertyKey: query.propertyKey
      - text: Show the first {pageSize} features.
        slots:
          pageSize: query.pageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/feature/adoption/{featureId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get feature adoption statistics
      effect: read
      questions:
      - How many users adopted a feature last week?
      - What is the longest date range allowed for feature adoption numbers?
      instructions:
      - text: Get adoption numbers for feature {featureId}.
        slots:
          featureId: path.featureId
      - text: Show adoption of feature {featureId} from {dateRangeStart} to {dateRangeEnd}.
        slots:
          featureId: path.featureId
          dateRangeStart: query.dateRangeStart
          dateRangeEnd: query.dateRangeEnd
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/feature/backfill/{featureId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Backfill a feature's historical data
      effect: write
      questions:
      - Can PX recompute a feature's usage for data captured before it was defined?
      - How do I request a backfill after changing a feature's rules?
      instructions:
      - text: Request a backfill for feature {featureId}.
        slots:
          featureId: path.featureId
      - text: Start a historical data backfill on feature {featureId}.
        slots:
          featureId: path.featureId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/feature/{featureId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a feature
      effect: read
      questions:
      - How do I see one feature's name, type and parent?
      - Can I fetch a single feature definition by ID?
      instructions:
      - text: Get feature {featureId}.
        slots:
          featureId: path.featureId
      - text: Show the definition of feature {featureId}.
        slots:
          featureId: path.featureId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/feature/{featureId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or move a feature
      effect: write
      questions:
      - Can I move a feature to the root of the feature tree?
      - Which feature fields can be edited, and are labels supported?
      instructions:
      - text: Rename feature {featureId} to {name} (id {id}, type {type}, product {propertyKey}).
        slots:
          featureId: path.featureId
          name: requestBody.name
          id: requestBody.id
          type: requestBody.type
          propertyKey: requestBody.propertyKey
      - text: Move feature {featureId} under parent {parentFeatureId}, keeping id {id}, name {name}, type {type}, product {propertyKey}.
        slots:
          featureId: path.featureId
          parentFeatureId: requestBody.parentFeatureId
          id: requestBody.id
          name: requestBody.name
          type: requestBody.type
          propertyKey: requestBody.propertyKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/feature_ext'].get
  update:
    x-apievangelist-phrasing:
      intent: List features with extended details
      effect: read
      questions:
      - Is there a v2 feature listing with more detail than the basic one?
      - Can I get extended feature data for a product key?
      instructions:
      - text: List extended v2 feature data for product {propertyKey}.
        slots:
          propertyKey: query.propertyKey
      - text: Show the extended feature list, page {pageNumber}.
        slots:
          pageNumber: query.pageNumber
      method: generated
      generated: '2026-09-26'