Sigma Computing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sigma Computing Translations API

9 actions 9 updates phrasing extends openapi/sigma-computing-translations-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Sigma Computing's API. It is a proposal applied on top of the contract, not a document Sigma Computing publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 9

$.info
$.paths['/v2/translations/organization'].get
$.paths['/v2/translations/organization'].post
$.paths['/v2/translations/organization/{lng}'].get
$.paths['/v2/translations/organization/{lng}'].put
$.paths['/v2/translations/organization/{lng}'].delete
$.paths['/v2/translations/organization/{lng}/{lng_variant}'].get
$.paths['/v2/translations/organization/{lng}/{lng_variant}'].put
$.paths['/v2/translations/organization/{lng}/{lng_variant}'].delete

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 Sigma Computing Translations API
  version: 1.0.0
extends: openapi/sigma-computing-translations-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['/v2/translations/organization'].get
  update:
    x-apievangelist-phrasing:
      intent: List organization translation files
      effect: read
      questions:
      - Which locales have translation files defined for my organization?
      - Can I page through the organization's translation files?
      instructions:
      - text: List all organization translation files.
      - text: List organization locales, {limit} per page.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/translations/organization'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an organization translation file
      effect: write
      questions:
      - How do I add a translation file for a new language?
      - Can I create a custom translation variant for a locale?
      instructions:
      - text: Create a translation file for locale {lng}.
        slots:
          lng: requestBody.lng
      - text: Create custom variant {lng_variant} for locale {lng} with translations {translations}.
        slots:
          lng_variant: requestBody.lng_variant
          lng: requestBody.lng
          translations: requestBody.translations
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/translations/organization/{lng}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a locale's base translation file
      effect: read
      questions:
      - What translations are defined for a locale, without custom variants?
      - Can I download the base translation JSON for a language?
      instructions:
      - text: Get the translation file for locale {lng}.
        slots:
          lng: path.lng
      - text: Download the base {lng} translations without custom variants.
        slots:
          lng: path.lng
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/translations/organization/{lng}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a locale's base translation file
      effect: write
      questions:
      - How do I change the base translations for a language?
      - Can I replace a locale's key-value pairs without touching its variants?
      instructions:
      - text: Update locale {lng} translations to {translations}.
        slots:
          lng: path.lng
          translations: requestBody.translations
      - text: Replace the base {lng} translation file with {translations}.
        slots:
          lng: path.lng
          translations: requestBody.translations
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/translations/organization/{lng}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a locale's base translation file
      effect: destructive
      questions:
      - How do I delete the translation file for a language?
      - Does deleting a locale's translation file leave its custom variants alone?
      instructions:
      - text: Delete the translation file for locale {lng}.
        slots:
          lng: path.lng
      - text: Remove base {lng} translations from the organization.
        slots:
          lng: path.lng
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/translations/organization/{lng}/{lng_variant}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a locale's custom variant translations
      effect: read
      questions:
      - How do I get a locale's translations including a custom variant?
      - Can I download one custom translation variant for a language?
      instructions:
      - text: Get translations for locale {lng} variant {lng_variant}.
        slots:
          lng: path.lng
          lng_variant: path.lng_variant
      - text: Download the {lng_variant} custom translations of {lng}.
        slots:
          lng_variant: path.lng_variant
          lng: path.lng
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/translations/organization/{lng}/{lng_variant}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom translation variant
      effect: write
      questions:
      - How do I edit the key-value pairs of a custom translation variant?
      - Can I update one variant of a locale independently?
      instructions:
      - text: Update variant {lng_variant} of locale {lng} to {translations}.
        slots:
          lng_variant: path.lng_variant
          lng: path.lng
          translations: requestBody.translations
      - text: Replace custom {lng}/{lng_variant} translations with {translations}.
        slots:
          lng: path.lng
          lng_variant: path.lng_variant
          translations: requestBody.translations
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/translations/organization/{lng}/{lng_variant}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom translation variant
      effect: destructive
      questions:
      - How do I remove a custom translation variant for a locale?
      - Can I delete one variant without deleting the base language file?
      instructions:
      - text: Delete variant {lng_variant} of locale {lng}.
        slots:
          lng_variant: path.lng_variant
          lng: path.lng
      - text: Remove the custom {lng}/{lng_variant} translation file.
        slots:
          lng: path.lng
          lng_variant: path.lng_variant
      method: generated
      generated: '2026-09-26'