Gainsight · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gainsight PX REST Localization API

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

$.info
$.paths['/v1/localization/export/articles'].get
$.paths['/v1/localization/export/content'].get
$.paths['/v1/localization/export/engagement'].get
$.paths['/v1/localization/export/kcbot'].get
$.paths['/v1/localization/import/articles'].post
$.paths['/v1/localization/import/content'].post
$.paths['/v1/localization/import/engagement'].post
$.paths['/v1/localization/import/kcbot'].post

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 Localization API
  version: 1.0.0
extends: openapi/gainsight-localization-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: 8
- target: $.paths['/v1/localization/export/articles'].get
  update:
    x-apievangelist-phrasing:
      intent: Export article translations as XLIFF
      effect: read
      questions:
      - Can I export an article's text for translation?
      - Can I export only untranslated article strings for one language?
      instructions:
      - text: Export the XLIFF zip for article {id}.
        slots:
          id: query.id
      - text: Export article {id} XLIFF for target language {trgLang}.
        slots:
          id: query.id
          trgLang: query.trgLang
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/localization/export/content'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a Content Library entry as XLIFF
      effect: read
      questions:
      - What's the way to send a Content Library entry out for translation?
      - Can I export content library XLIFF for a specific language?
      instructions:
      - text: Export XLIFF for content entry {contentId} of type {type}.
        slots:
          contentId: query.contentId
          type: query.type
      - text: Export content {contentId} ({type}) translations for language {trgLang}.
        slots:
          contentId: query.contentId
          type: query.type
          trgLang: query.trgLang
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/localization/export/engagement'].get
  update:
    x-apievangelist-phrasing:
      intent: Export an engagement as XLIFF
      effect: read
      questions:
      - Where do I get an in-app engagement's text out for translators?
      - Can I export the draft version of an engagement for translation?
      instructions:
      - text: Export the XLIFF zip for engagement {id}.
        slots:
          id: query.id
      - text: Export engagement {id} in draft ({draft}) for language {trgLang}.
        slots:
          id: query.id
          draft: query.draft
          trgLang: query.trgLang
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/localization/export/kcbot'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a Knowledge Center bot as XLIFF
      effect: read
      questions:
      - How do I export a KC bot's strings for localization?
      - Can I pick which KC version to export for translation?
      instructions:
      - text: Export the XLIFF zip for KC bot {id}.
        slots:
          id: query.id
      - text: Export KC bot {id} version {kcVersion} for language {trgLang}.
        slots:
          id: query.id
          kcVersion: query.kcVersion
          trgLang: query.trgLang
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/localization/import/articles'].post
  update:
    x-apievangelist-phrasing:
      intent: Import article translations
      effect: write
      questions:
      - What endpoint loads translated articles back into PX?
      - Can I upload an XLIFF file to update article translations?
      instructions:
      - text: Import article translations from XLIFF file {file}.
        slots:
          file: requestBody.file
      - text: Upload translated article file {file}.
        slots:
          file: requestBody.file
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/localization/import/content'].post
  update:
    x-apievangelist-phrasing:
      intent: Import Content Library translations
      effect: write
      questions:
      - Where would I upload a translated Content Library entry?
      - Can I import XLIFF into one specific content entry?
      instructions:
      - text: Import XLIFF {file} into content entry {contentId}.
        slots:
          file: requestBody.file
          contentId: query.contentId
      - text: Load translations for Content Library entry {contentId} from {file}.
        slots:
          contentId: query.contentId
          file: requestBody.file
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/localization/import/engagement'].post
  update:
    x-apievangelist-phrasing:
      intent: Import engagement translations
      effect: write
      questions:
      - Can translated engagement text be brought back into PX?
      - Can I upload an XLIFF file to localize an in-app guide?
      instructions:
      - text: Import engagement translations from XLIFF {file}.
        slots:
          file: requestBody.file
      - text: Upload the translated engagement file {file}.
        slots:
          file: requestBody.file
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/localization/import/kcbot'].post
  update:
    x-apievangelist-phrasing:
      intent: Import Knowledge Center bot translations
      effect: write
      questions:
      - How do I upload translated strings for a KC bot?
      - Can I import KC bot translations into a particular KC version?
      instructions:
      - text: Import KC bot translations from {file}.
        slots:
          file: requestBody.file
      - text: Load translated KC file {file} into KC version {kcVersion}.
        slots:
          file: requestBody.file
          kcVersion: query.kcVersion
      method: generated
      generated: '2026-09-26'