Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Localization Translation Management Runtime API

3 actions 3 updates phrasing extends openapi/conga-translation-management-runtime-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Conga's API. It is a proposal applied on top of the contract, not a document Conga publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/api/localization/v1/translations'].get
$.paths['/api/localization/v1/translations'].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 Localization Translation Management Runtime API
  version: 1.0.0
extends: openapi/conga-translation-management-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: 2
- target: $.paths['/api/localization/v1/translations'].get
  update:
    x-apievangelist-phrasing:
      intent: Get all string translations for several modules
      effect: read
      questions:
      - Can I load every string translation for a few modules at once, grouped by module?
      - What comes back when I ask for translations by module name only?
      instructions:
      - text: Get all string translations for module {module}.
        slots:
          module: query.module
      - text: Return a module-by-module dictionary of string translations for {module}.
        slots:
          module: query.module
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/localization/v1/translations'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up translations for chosen keys across modules
      effect: read
      questions:
      - Can I fetch translations for specific keys from several modules in a single request?
      - Which call returns only the string keys I name instead of a module's whole dictionary?
      instructions:
      - text: Fetch translations for the specific keys and modules I list in one request.
      - text: Look up string translations for this set of key and module pairs.
      method: generated
      generated: '2026-10-01'