# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Localization Translation Runtime API
  version: 1.0.0
extends: openapi/conga-translation-runtime-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: 5
- target: $.paths['/api/localization/v1/translations/modules/{module}/bulk'].get
  update:
    x-apievangelist-phrasing:
      intent: Page through all translations in a module
      effect: read
      questions:
      - Can I download every translation in a module like CPQ.CART page by page?
      - What's the default page size when pulling a module's translations, and how do I continue with a cursor?
      instructions:
      - text: Get all translations for module {module}.
        slots:
          module: path.module
      - text: Fetch the next {pageSize} translations in {module} after cursor {cursor}.
        slots:
          pageSize: query.pageSize
          module: path.module
          cursor: query.cursor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/localization/v1/translations/{module}/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Translate a list of keys in one module
      effect: read
      questions:
      - Can I get the user's-locale text for a list of keys from one module in one call?
      - Which request translates many keys of a single module without message parameters?
      instructions:
      - text: Translate keys {Keys} from module {module} into my locale.
        slots:
          Keys: requestBody.Keys
          module: path.module
      - text: Return my-locale values for this batch of keys in {module}.
        slots:
          module: path.module
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/localization/v1/translations/{module}/bulk/parameters'].post
  update:
    x-apievangelist-phrasing:
      intent: Translate many keys with message parameters
      effect: read
      questions:
      - Can I translate several keys at once and fill in their placeholder variables?
      - Which call returns parameterized messages for a list of keys in one module?
      instructions:
      - text: Translate these keys in {module} with their placeholder values filled in.
        slots:
          module: path.module
      - text: Resolve a batch of parameterized messages from module {module} for my locale.
        slots:
          module: path.module
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/localization/v1/translations/{module}/{key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the translation of one key
      effect: read
      questions:
      - What does a single translation key read as in my locale?
      - Can I look up just one label's translated text by module and key?
      instructions:
      - text: Get the translation of {key} in module {module}.
        slots:
          key: path.key
          module: path.module
      - text: Show my-locale text for key {key} from {module}.
        slots:
          key: path.key
          module: path.module
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/localization/v1/translations/{module}/{key}/parameters'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one translated message with variables filled in
      effect: read
      questions:
      - Can I get a single translated message with its variables substituted?
      - How are message parameters passed when translating one key?
      instructions:
      - text: Translate {key} in {module} using parameters {parameters}.
        slots:
          key: path.key
          module: path.module
          parameters: query.parameters
      - text: Render the parameterized message {key} from module {module} in my locale.
        slots:
          key: path.key
          module: path.module
      method: generated
      generated: '2026-10-01'