Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Schema Manager Object Definition Translation API

5 actions 5 updates phrasing extends openapi/conga-object-definition-translation-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 5

$.info
$.paths['/api/schema/v1/objects/{objectName}/translations/{locale}'].get
$.paths['/api/schema/v1/objects/{objectName}/translations/{locale}'].put
$.paths['/api/schema/v1/objects/{objectName}/translations/{locale}'].post
$.paths['/api/schema/v1/objects/{objectName}/translations/{locale}'].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 Schema Manager Object Definition Translation API
  version: 1.0.0
extends: openapi/conga-object-definition-translation-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: 4
- target: $.paths['/api/schema/v1/objects/{objectName}/translations/{locale}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an object translation
      effect: read
      questions:
      - What are the translated labels of an object in a locale?
      - Can I view an object's German translation?
      instructions:
      - text: Get the {locale} translation of object {object}.
        slots:
          locale: path.locale
          object: path.objectName
      - text: Show translated labels for {object} in {locale}.
        slots:
          object: path.objectName
          locale: path.locale
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/v1/objects/{objectName}/translations/{locale}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an object translation
      effect: write
      questions:
      - How do I change an existing object translation?
      - Can I fix a wrong translated label?
      instructions:
      - text: Update the {locale} translation of {object}.
        slots:
          locale: path.locale
          object: path.objectName
      - text: Correct the existing {locale} labels on {object}.
        slots:
          locale: path.locale
          object: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/v1/objects/{objectName}/translations/{locale}'].post
  update:
    x-apievangelist-phrasing:
      intent: Define an object translation
      effect: write
      questions:
      - How do I add a new language translation for an object?
      - Can I provide metadata translations for a locale?
      instructions:
      - text: Define a {locale} translation for {object} with {translations}.
        slots:
          locale: path.locale
          object: path.objectName
          translations: requestBody.MetadataTranslations
      - text: Add new {locale} labels to object {object}.
        slots:
          locale: path.locale
          object: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/v1/objects/{objectName}/translations/{locale}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an object translation
      effect: destructive
      questions:
      - Can I remove a translation for an object?
      - How do I delete one locale's labels?
      instructions:
      - text: Delete the {locale} translation of {object}.
        slots:
          locale: path.locale
          object: path.objectName
      - text: Remove {object}'s labels for locale {locale}.
        slots:
          object: path.objectName
          locale: path.locale
      method: generated
      generated: '2026-10-01'