openapi: 3.2.0
info:
  title: dotCMS REST Internationalization API
  version: '3'
  description: Language management and localization
servers:
- url: /
  description: dotCMS Server
tags:
- name: Internationalization
  description: Language management and localization
paths:
  /api/v1/system/i18n/{lang}/{rsrc}:
    get:
      tags:
      - Internationalization
      operationId: list_7
      parameters:
      - name: lang
        in: path
        required: true
        schema:
          pattern: '[\w]{2,3}(?:-?[\w]{2})?'
          type: string
      - name: rsrc
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
      summary: List 7
      x-summary-source: derived
  /api/v2/languages/{languageId}:
    put:
      tags:
      - Internationalization
      operationId: updateLanguage
      parameters:
      - name: languageId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/LanguageForm'
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/javascript: {}
      summary: Update language
      x-summary-source: derived
    delete:
      tags:
      - Internationalization
      operationId: deleteLanguage
      parameters:
      - name: languageId
        in: path
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/javascript: {}
      summary: Delete language
      x-summary-source: derived
  /api/v2/languages/id/{languageid}:
    get:
      tags:
      - Internationalization
      operationId: get_8
      parameters:
      - name: languageid
        in: path
        required: true
        schema:
          type: integer
          format: int64
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/javascript: {}
      summary: Get 8
      x-summary-source: derived
  /api/v2/languages/{language}/keys:
    get:
      tags:
      - Internationalization
      operationId: getAllMessages
      parameters:
      - name: language
        in: path
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/javascript: {}
      summary: Get all messages
      x-summary-source: derived
  /api/v2/languages/_getdefault:
    get:
      tags:
      - Internationalization
      operationId: getDefaultLanguage
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseEntityViewLanguage'
            application/javascript:
              schema:
                $ref: '#/components/schemas/ResponseEntityViewLanguage'
      summary: Get default language
      x-summary-source: derived
  /api/v2/languages/{languageTag}:
    get:
      tags:
      - Internationalization
      operationId: getFromLanguageTag
      parameters:
      - name: languageTag
        in: path
        required: true
        schema:
          type: string
      - name: strict
        in: query
        schema:
          type: boolean
          default: false
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/javascript: {}
      summary: Get from language tag
      x-summary-source: derived
    post:
      tags:
      - Internationalization
      operationId: saveFromLanguageTag
      parameters:
      - name: languageTag
        in: path
        required: true
        schema:
          type: string
      - name: strict
        in: query
        schema:
          type: boolean
          default: false
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/javascript: {}
      summary: Save from language tag
      x-summary-source: derived
  /api/v2/languages/iso:
    get:
      tags:
      - Internationalization
      operationId: getIsoLanguagesAndCountries
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/javascript: {}
      summary: Get iso languages and countries
      x-summary-source: derived
  /api/v2/languages/i18n:
    post:
      tags:
      - Internationalization
      operationId: getMessages
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/I18NForm'
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/javascript: {}
      summary: Get messages
      x-summary-source: derived
  /api/v2/languages/variables:
    get:
      tags:
      - Internationalization
      operationId: getVariables
      parameters:
      - name: renderNulls
        in: query
        schema:
          type: boolean
          default: true
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/javascript: {}
      summary: Get variables
      x-summary-source: derived
  /api/v2/languages:
    get:
      tags:
      - Internationalization
      operationId: list_10
      parameters:
      - name: contentInode
        in: query
        schema:
          type: string
      - name: countLangVars
        in: query
        schema:
          type: boolean
      responses:
        default:
          description: default response
          content:
            application/json: {}
      summary: List 10
      x-summary-source: derived
    post:
      tags:
      - Internationalization
      operationId: saveLanguage
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/LanguageForm'
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/javascript: {}
      summary: Save language
      x-summary-source: derived
  /api/v2/languages/{language}/_makedefault:
    put:
      tags:
      - Internationalization
      operationId: makeDefault
      parameters:
      - name: language
        in: path
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/MakeDefaultLangForm'
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/javascript: {}
      summary: Make default
      x-summary-source: derived
components:
  schemas:
    I18NForm:
      type: object
      properties:
        language:
          type: string
        country:
          type: string
        messagesKey:
          type: array
          items:
            type: string
    Pagination:
      type: object
      properties:
        currentPage:
          type: integer
          format: int32
        perPage:
          type: integer
          format: int32
        totalEntries:
          type: integer
          format: int64
    MessageEntity:
      type: object
      properties:
        message:
          type: string
    LanguageForm:
      type: object
      properties:
        languageCode:
          type: string
        countryCode:
          type: string
        language:
          type: string
        country:
          type: string
        isoCode:
          type: string
    MakeDefaultLangForm:
      type: object
      properties:
        fireTransferAssetsJob:
          type: boolean
    Language:
      type: object
      properties:
        id:
          type: integer
          format: int64
        languageCode:
          type: string
        countryCode:
          type: string
        language:
          type: string
        country:
          type: string
        isoCode:
          type: string
    ErrorEntity:
      type: object
      properties:
        errorCode:
          type: string
        message:
          type: string
        fieldName:
          type: string
    ResponseEntityViewLanguage:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorEntity'
        entity:
          $ref: '#/components/schemas/Language'
        messages:
          type: array
          items:
            $ref: '#/components/schemas/MessageEntity'
        i18nMessagesMap:
          type: object
          additionalProperties:
            type: string
        permissions:
          type: array
          items:
            type: string
        pagination:
          $ref: '#/components/schemas/Pagination'