dotCMS · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for dotCMS REST Language API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/api/v1/languages/i18n'].post
$.paths['/api/v1/languages'].get

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 dotCMS REST Language API
  version: 1.0.0
extends: openapi/dotcms-language-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/api/v1/languages/i18n'].post
  update:
    x-apievangelist-phrasing:
      intent: Get i18n messages for a locale (v1)
      effect: read
      questions:
      - Can I get translated UI strings for specific message keys in a given locale?
      - Which v1 languages call returns a map of message key to translation?
      instructions:
      - text: Get the messages {messagesKey} for language {language} and country {country}.
        slots:
          messagesKey: requestBody.messagesKey
          language: requestBody.language
          country: requestBody.country
      - text: Translate message keys {messagesKey} into {language} with the v1 languages API.
        slots:
          messagesKey: requestBody.messagesKey
          language: requestBody.language
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/languages'].get
  update:
    x-apievangelist-phrasing:
      intent: List all configured languages (v1)
      effect: read
      questions:
      - What languages are set up on my dotCMS instance, keyed by language code?
      - Can I get every language with its country and display name?
      instructions:
      - text: List every configured language keyed by code.
      - text: Show all languages with country and display name from the v1 API.
      method: generated
      generated: '2026-09-26'