Gainsight · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gainsight PX REST Article API

3 actions 3 updates phrasing extends openapi/gainsight-article-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['/v1/articles'].get
$.paths['/v1/articles/{articleId}'].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 Article API
  version: 1.0.0
extends: openapi/gainsight-article-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['/v1/articles'].get
  update:
    x-apievangelist-phrasing:
      intent: List knowledge center articles
      effect: read
      questions:
      - What articles exist in my PX subscription?
      - Can I list articles for just one product?
      instructions:
      - text: List articles for product {productId}.
        slots:
          productId: query.productId
      - text: Show the metadata of all knowledge center articles.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/articles/{articleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a knowledge center article
      effect: read
      questions:
      - How do I pull the content of one article by its ID?
      - What metadata is stored for a single article?
      instructions:
      - text: Get article {articleId}.
        slots:
          articleId: path.articleId
      - text: Retrieve the article with ID {articleId}.
        slots:
          articleId: path.articleId
      method: generated
      generated: '2026-09-26'