# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Knock Management API (mAPI) Translations API
  version: 1.0.0
extends: openapi/knock-app-translations-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['/v1/translations'].get
  update:
    x-apievangelist-phrasing:
      intent: List translations
      effect: read
      questions:
      - Which locales have translations in this environment?
      - Can I filter translations by namespace or tenant?
      instructions:
      - text: List translations in {environment}.
        slots:
          environment: query.environment
      - text: List {locale_code} translations in namespace {namespace} in {environment}.
        slots:
          locale_code: query.locale_code
          namespace: query.namespace
          environment: query.environment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/translations/{locale_code}/validate'].put
  update:
    x-apievangelist-phrasing:
      intent: Validate a translation without saving
      effect: read
      questions:
      - Can I check a translation file for errors before saving it?
      - Is there a dry run for translation payloads?
      instructions:
      - text: Validate translation {translation} for locale {locale_code} in {environment}.
        slots:
          translation: requestBody.translation
          locale_code: path.locale_code
          environment: query.environment
      - text: Check the {locale_code} translation payload {translation} without persisting it in {environment}.
        slots:
          locale_code: path.locale_code
          translation: requestBody.translation
          environment: query.environment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/translations/{locale_code}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a translation for a locale
      effect: read
      questions:
      - How do I fetch the strings for one locale?
      - Can I get a translation for a specific namespace or tenant?
      instructions:
      - text: Get the {locale_code} translation in {environment}.
        slots:
          locale_code: path.locale_code
          environment: query.environment
      - text: Show the {locale_code} strings in namespace {namespace} in {environment}.
        slots:
          locale_code: path.locale_code
          namespace: query.namespace
          environment: query.environment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/translations/{locale_code}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a translation
      effect: write
      questions:
      - How do I add or update French strings for my notifications?
      - Can I store translations per namespace?
      instructions:
      - text: Upsert the {locale_code} translation in namespace {namespace} in {environment} with {translation}.
        slots:
          locale_code: path.locale_code
          namespace: query.namespace
          environment: query.environment
          translation: requestBody.translation
      - text: Save {translation} as the {locale_code} strings for namespace {namespace} and commit in {environment} with message {commit_message}.
        slots:
          translation: requestBody.translation
          locale_code: path.locale_code
          namespace: query.namespace
          environment: query.environment
          commit_message: query.commit_message
      method: generated
      generated: '2026-10-01'