{
  "openapi": "3.0.1",
  "info": {
    "title": "Languages",
    "description": "Create and administer collection of languages.",
    "version": "9.1.20.0",
    "x-introduced": "9.1.0.0"
  },
  "servers": [
    {
      "url": "https://{hostname}:{port}/rest/admin/v2",
      "variables": {
        "port": {
          "default": "443",
          "enum": [
            "443",
            "8000"
          ]
        },
        "hostname": {
          "default": "localhost",
          "enum": [
            "localhost",
            "test.hcl.com"
          ]
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Languages",
      "description": "Provide RESTful services to manage languages."
    }
  ],
  "paths": {
    "/languages": {
      "get": {
        "tags": [
          "Languages"
        ],
        "description": "Get a collection of languages.",
        "operationId": "getLanguages",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "The language ID. When creating new languages, use negative values less than -999.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "localeName",
            "in": "query",
            "description": "A Java locale used to represent a political, geographical, or cultural region that has a distinct language and customs. This is a mandatory field.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "language",
            "in": "query",
            "description": "Language component of the locale.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "country",
            "in": "query",
            "description": "Country or region component of the locale.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "variant",
            "in": "query",
            "description": "Variant component of the locale. Used to specify the locale encoding character set or to further segregate a distinct formatting custom for a political, geographical, or cultural region.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "encoding",
            "in": "query",
            "description": "The character encoding value that the browser uses to display the page in the selected language.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "mimeCharSet",
            "in": "query",
            "description": "The MIME character encoding value that the notification system uses to encode a message for the selected language.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "The position within the resulting dataset where the query begins returning item records. If the offset is \"5\", the records that returned begin with the sixth record that matches the query parameters. If the offset is \"0\", the records that are returned begin with the first record that matches the query parameters.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of records to return.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "expand",
            "in": "query",
            "description": "The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A collection of languages.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LanguageCollection"
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "post": {
        "tags": [
          "Languages"
        ],
        "description": "Create a language.",
        "operationId": "createLanguage",
        "requestBody": {
          "description": "The language.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LanguageRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the language.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetLanguageById": {
                "operationRef": "#/paths/~1languages~1{id}/get",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `GET /languages/{id}`.\n"
              },
              "DeleteLanguageById": {
                "operationRef": "#/paths/~1languages~1{id}/delete",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `DELETE /languages/{id}`.\n"
              },
              "UpdateLanguageById": {
                "operationRef": "#/paths/~1languages~1{id}/patch",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `PATCH /languages/{id}`.\n"
              },
              "GetLanguageDescriptionById": {
                "operationRef": "#/paths/~1languages~1{id}~1descriptions/get",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `GET /languages/{id}/descriptions`.\n"
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "Language"
      }
    },
    "/languages/{id}": {
      "get": {
        "tags": [
          "Languages"
        ],
        "description": "Get a language.",
        "operationId": "getLanguageById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The language ID. When creating new languages, use negative values less than -999.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "expand",
            "in": "query",
            "description": "The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The language.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Language"
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "delete": {
        "tags": [
          "Languages"
        ],
        "description": "Delete a language.",
        "operationId": "deleteLanguageById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The language ID. When creating new languages, use negative values less than -999.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "The operation was successful.",
            "content": {}
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "patch": {
        "tags": [
          "Languages"
        ],
        "description": "Update a language.",
        "operationId": "updateLanguageById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The language ID. When creating new languages, use negative values less than -999.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "requestBody": {
          "description": "The language.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LanguageRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "The operation was successful.",
            "content": {}
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "Language"
      }
    },
    "/languages/{id}/descriptions": {
      "get": {
        "tags": [
          "Languages"
        ],
        "operationId": "getDescriptionsOfLanguage",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The language ID. When creating new languages, use negative values less than -999.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "The position within the resulting dataset where the query begins returning item records. If the offset is \"5\", the records that returned begin with the sixth record that matches the query parameters. If the offset is \"0\", the records that are returned begin with the first record that matches the query parameters.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of records to return.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "expand",
            "in": "query",
            "description": "The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A collection of languages descriptions.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LanguageDescriptionCollection"
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Link": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string",
            "description": "The URL of the link.",
            "format": "uri"
          }
        },
        "description": "Links to related resources."
      },
      "Error": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "string",
            "description": "The error message code."
          },
          "errorMessage": {
            "type": "string",
            "description": "The error message."
          },
          "errorKey": {
            "type": "string",
            "description": "The error message key."
          },
          "errorParameters": {
            "type": "array",
            "description": "The arguments used to construct the error message.",
            "items": {
              "type": "object",
              "properties": {}
            }
          },
          "errorLevel": {
            "type": "string",
            "description": "The error level."
          },
          "errorHref": {
            "type": "string",
            "description": "The error hypertext reference."
          }
        },
        "description": "The error message item model."
      },
      "ErrorResponseContainer": {
        "type": "object",
        "properties": {
          "requestId": {
            "type": "string",
            "description": "The request identifier."
          },
          "errors": {
            "type": "array",
            "description": "The errors.",
            "items": {
              "$ref": "#/components/schemas/Error"
            }
          }
        },
        "description": "The error message model."
      },
      "LanguageRequest": {
        "required": [
          "id",
          "localeName"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The language ID. When creating new languages, use negative values less than -999.",
            "format": "int32"
          },
          "localeName": {
            "type": "string",
            "description": "A Java locale used to represent a political, geographical, or cultural region that has a distinct language and customs. This is a mandatory field."
          },
          "language": {
            "type": "string",
            "description": "Language component of the locale.",
            "nullable": true
          },
          "country": {
            "type": "string",
            "description": "Country or region component of the locale.",
            "nullable": true
          },
          "variant": {
            "type": "string",
            "description": "Variant component of the locale. Used to specify the locale encoding character set or to further segregate a distinct formatting custom for a political, geographical, or cultural region.",
            "nullable": true
          },
          "encoding": {
            "type": "string",
            "description": "The character encoding value that the browser uses to display the page in the selected language.",
            "nullable": true
          },
          "mimeCharSet": {
            "type": "string",
            "description": "The MIME character encoding value that the notification system uses to encode a message for the selected language.",
            "nullable": true
          }
        },
        "description": "The language."
      },
      "Language": {
        "required": [
          "id",
          "localeName"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The language ID. When creating new languages, use negative values less than -999.",
            "format": "int32"
          },
          "localeName": {
            "type": "string",
            "description": "A Java locale used to represent a political, geographical, or cultural region that has a distinct language and customs. This is a mandatory field."
          },
          "language": {
            "type": "string",
            "description": "Language component of the locale.",
            "nullable": true
          },
          "country": {
            "type": "string",
            "description": "Country or region component of the locale.",
            "nullable": true
          },
          "variant": {
            "type": "string",
            "description": "Variant component of the locale. Used to specify the locale encoding character set or to further segregate a distinct formatting custom for a political, geographical, or cultural region.",
            "nullable": true
          },
          "encoding": {
            "type": "string",
            "description": "The character encoding value that the browser uses to display the page in the selected language.",
            "nullable": true
          },
          "mimeCharSet": {
            "type": "string",
            "description": "The MIME character encoding value that the notification system uses to encode a message for the selected language.",
            "nullable": true
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "The URL of the self link."
                  }
                },
                "description": ""
              },
              "descriptions": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "The URL of the description link."
                  }
                },
                "description": "The language description relationships of a language."
              }
            },
            "description": "Links to related resources."
          }
        },
        "description": "The language."
      },
      "LanguageCollection": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string",
            "description": "The resource."
          },
          "count": {
            "type": "integer",
            "description": "The total number of items.",
            "format": "int32"
          },
          "items": {
            "type": "array",
            "description": "The items.",
            "items": {
              "$ref": "#/components/schemas/Language"
            }
          }
        },
        "description": "A collection of languages."
      },
      "LanguageDescription": {
        "type": "object",
        "properties": {
          "descriptionLanguageId": {
            "type": "integer",
            "description": "The language ID of the language that is being described.",
            "format": "int32"
          },
          "description": {
            "type": "string",
            "description": "The description of the language that is displayed in a graphical user interface, which manages supported languages for a StoreEntity."
          },
          "languageId": {
            "type": "integer",
            "description": "The language ID.",
            "format": "int32"
          }
        },
        "description": "Language Description"
      },
      "LanguageDescriptionCollection": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string",
            "description": "The resource."
          },
          "count": {
            "type": "integer",
            "description": "The total number of items.",
            "format": "int32"
          },
          "items": {
            "type": "array",
            "description": "The items.",
            "items": {
              "$ref": "#/components/schemas/LanguageDescription"
            }
          }
        },
        "description": "A collection of languages descriptions."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ]
}