# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Localization Translations Management Admin API
  version: 1.0.0
extends: openapi/conga-translations-management-admin-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 14
- target: $.paths['/api/localization-admin/v1/translations'].get
  update:
    x-apievangelist-phrasing:
      intent: Browse translations page by page
      effect: read
      questions:
      - Can I browse String or Schema translations by numbered page, with a total count?
      - Is there a way to search translation keys by text and filter by locale and module, page by page?
      instructions:
      - text: Show page {page} of {type} translations for locales {locales}.
        slots:
          page: query.page
          type: query.type
          locales: query.locales
      - text: Search {type} translation keys for {searchText} in module {module}, sorted by {sortField}, with page numbers.
        slots:
          type: query.type
          searchText: query.searchText
          module: query.module
          sortField: query.sortField
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/localization-admin/v1/translations/locales/{locale}'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk update translations for a locale
      effect: write
      questions:
      - Can I overwrite many existing translations for one locale in a single request?
      - What's the bulk way to correct existing French translations?
      instructions:
      - text: Bulk update existing translations for locale {locale}.
        slots:
          locale: path.locale
      - text: Apply these corrected values to the current {locale} translations.
        slots:
          locale: path.locale
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/localization-admin/v1/translations/locales/{locale}'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk add new translations for a locale
      effect: write
      questions:
      - How do I add a batch of new translations for a locale that has none yet?
      - Can I create many new translation entries for one locale at once?
      instructions:
      - text: Bulk create new translations for locale {locale}.
        slots:
          locale: path.locale
      - text: Add this set of brand-new translation entries under {locale}.
        slots:
          locale: path.locale
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/localization-admin/v1/translations/locales/{locale}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete translations for a locale
      effect: destructive
      questions:
      - Can I remove a batch of translations from one locale?
      - Is there a bulk delete for translations I no longer need in a language?
      instructions:
      - text: Bulk delete translations for locale {locale}.
        slots:
          locale: path.locale
      - text: Remove these translation entries from {locale}.
        slots:
          locale: path.locale
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/localization-admin/v1/translations/locales/{locale}/custom/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export a locale's custom translations to CSV
      effect: read
      questions:
      - Can I download a locale's custom translations as a CSV file to send to translators?
      - Is it possible to export only one translation type for a locale?
      instructions:
      - text: Export the custom translations for {locale} to CSV.
        slots:
          locale: path.locale
      - text: Export {type} translations for locale {locale} as a CSV file.
        slots:
          type: query.type
          locale: path.locale
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/localization-admin/v1/translations/locales/{locale}/custom/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import a translation file for a locale
      effect: write
      questions:
      - How do I upload a file of translated strings back in for a locale?
      - Can I load translations from a file my translators returned?
      instructions:
      - text: Import translations for locale {locale} from file {translations}.
        slots:
          locale: path.locale
          translations: requestBody.translations
      - text: Load the returned translation file into {locale}.
        slots:
          locale: path.locale
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/localization-admin/v1/translations/modules'].get
  update:
    x-apievangelist-phrasing:
      intent: List translation modules for a type
      effect: read
      questions:
      - What translation modules are defined, such as CLM.DOC_GEN or CPQ.CART?
      - Can I see which modules exist for Schema translations versus String translations?
      instructions:
      - text: List all translation modules.
      - text: List the translation modules defined for type {type}.
        slots:
          type: query.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/localization-admin/v1/translations/organization-locales'].get
  update:
    x-apievangelist-phrasing:
      intent: View the organization's configured locales
      effect: read
      questions:
      - Which languages are currently enabled for my organization?
      - Where can I see the current organization locales configuration?
      instructions:
      - text: Show my organization's locale configuration.
      - text: List the locales currently enabled for the org.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/localization-admin/v1/translations/organization-locales'].put
  update:
    x-apievangelist-phrasing:
      intent: Change which locales the organization uses
      effect: write
      questions:
      - Can I enable a new language for my whole organization?
      - Does changing the organization's locales return a tracking ID I can follow?
      instructions:
      - text: Update my organization's enabled locales to this list.
      - text: Configure the org locales setting with the languages I provide.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/localization-admin/v1/translations/organization-locales-tracking/{trackingId}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check progress of an org locale change
      effect: read
      questions:
      - Has my organization locale change finished processing yet?
      - Can I check the status of an org locale update with the tracking ID it gave me?
      instructions:
      - text: Check the status of org locale change {trackingId}.
        slots:
          trackingId: path.trackingId
      - text: Tell me whether locale update tracking ID {trackingId} is complete.
        slots:
          trackingId: path.trackingId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/localization-admin/v1/translations/schema-auto-translate'].post
  update:
    x-apievangelist-phrasing:
      intent: Auto-translate an object's schema labels
      effect: write
      questions:
      - Can field labels, display names and descriptions on an object be machine-translated automatically?
      - Does auto-translating an object's schema run in the background?
      instructions:
      - text: Auto-translate the schema of object {Name} into the default locales.
        slots:
          Name: requestBody.Name
      - text: Auto-translate display names and field labels of {DisplayName} into {targetLocales}.
        slots:
          DisplayName: requestBody.DisplayName
          targetLocales: query.targetLocales
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/localization-admin/v1/translations/text-auto-translate'].post
  update:
    x-apievangelist-phrasing:
      intent: Auto-translate text key-value pairs
      effect: write
      questions:
      - Can I machine-translate a set of plain text key-value pairs into other languages?
      - Which target languages are used for text auto-translation if I don't name any?
      instructions:
      - text: Auto-translate these text key-value pairs into {targetLocales}.
        slots:
          targetLocales: query.targetLocales
      - text: Machine-translate my set of text keys into the default locales.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/localization-admin/v1/translations/{type}'].get
  update:
    x-apievangelist-phrasing:
      intent: Stream translations of a type with a cursor
      effect: read
      questions:
      - Can I walk through every translation of a type using a cursor instead of page numbers?
      - Is there a cursor-based export of translations filtered by several locales at once?
      instructions:
      - text: Get {type} translations using cursor paging.
        slots:
          type: path.type
      - text: Fetch the next {pageSize} {type} translations after cursor {cursor} for locales {localesCSV}.
        slots:
          pageSize: query.pageSize
          type: path.type
          cursor: query.cursor
          localesCSV: query.localesCSV
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/localization-admin/v1/translations/{type}/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count translations of a type
      effect: read
      questions:
      - How many translations of a given type exist?
      - Can I count translations for a module or matching some search text without fetching them?
      instructions:
      - text: Count the {type} translations.
        slots:
          type: path.type
      - text: Count {type} translations in module {module} for locales {localesCSV}.
        slots:
          type: path.type
          module: query.module
          localesCSV: query.localesCSV
      method: generated
      generated: '2026-10-01'