{
  "openapi": "3.0.1",
  "info": {
    "title": "Language Descriptions",
    "version": "9.1.20.0",
    "description": "Create and administer collection of language descriptions.",
    "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": "Language Descriptions",
      "description": "Provide RESTful services to manage language descriptions."
    }
  ],
  "paths": {
    "/language-descriptions": {
      "get": {
        "tags": [
          "Language Descriptions"
        ],
        "description": "Get a collection of languages descriptions.",
        "operationId": "getLanguageDescriptions",
        "parameters": [
          {
            "name": "descriptionLanguageId",
            "in": "query",
            "description": "The language ID of the language that is being described.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "description",
            "in": "query",
            "description": "The description of the language that is displayed in a graphical user interface, which manages supported languages for a StoreEntity.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "languageId",
            "in": "query",
            "description": "The language ID.",
            "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"
                }
              }
            }
          }
        }
      },
      "post": {
        "tags": [
          "Language Descriptions"
        ],
        "description": "Create a language descriptions.",
        "operationId": "createLanguageDescription",
        "requestBody": {
          "description": "Language Description",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LanguageDescriptionRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the language.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetLanguageDescriptionById": {
                "operationRef": "#/paths/~1language-descriptions~1descriptionLanguageId:{descriptionLanguageId},languageId:{languageId}/get",
                "parameters": {
                  "descriptionLanguageId": "$request.body#/descriptionLanguageId",
                  "languageId": "$request.body#/languageId"
                },
                "description": "The `descriptionLanguageId`, `languageId` value used in the request body can be used as the `descriptionLanguageId`, `languageId` parameter in `GET /language-descriptions/descriptionLanguageId:{descriptionLanguageId},languageId:{languageId}`.\n"
              },
              "DeleteLanguageDescriptionById": {
                "operationRef": "#/paths/~1language-descriptions~1descriptionLanguageId:{descriptionLanguageId},languageId:{languageId}/delete",
                "parameters": {
                  "descriptionLanguageId": "$request.body#/descriptionLanguageId",
                  "languageId": "$request.body#/languageId"
                },
                "description": "The `descriptionLanguageId`, `languageId` value used in the request body can be used as the `descriptionLanguageId`, `languageId` parameter in `DELETE /language-descriptions/descriptionLanguageId:{descriptionLanguageId},languageId:{languageId}`.\n"
              },
              "UpdateLanguageDescriptionById": {
                "operationRef": "#/paths/~1language-descriptions~1descriptionLanguageId:{descriptionLanguageId},languageId:{languageId}/patch",
                "parameters": {
                  "descriptionLanguageId": "$request.body#/descriptionLanguageId",
                  "languageId": "$request.body#/languageId"
                },
                "description": "The `descriptionLanguageId`, `languageId` value used in the request body can be used as the `descriptionLanguageId`, `languageId` parameter in `PATCH /language-descriptions/descriptionLanguageId:{descriptionLanguageId},languageId:{languageId}`.\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": "LanguageDescription"
      }
    },
    "/language-descriptions/descriptionLanguageId:{descriptionLanguageId},languageId:{languageId}": {
      "get": {
        "tags": [
          "Language Descriptions"
        ],
        "description": "Get a language descriptions.",
        "operationId": "getLanguageDescriptionById",
        "parameters": [
          {
            "name": "descriptionLanguageId",
            "in": "path",
            "description": "The language ID of the language that is being described.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "languageId",
            "in": "path",
            "description": "The language ID.",
            "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": "Language Description",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LanguageDescription"
                }
              }
            }
          },
          "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": [
          "Language Descriptions"
        ],
        "description": "Delete a language descriptions.",
        "operationId": "deleteLanguageDescriptionById",
        "parameters": [
          {
            "name": "descriptionLanguageId",
            "in": "path",
            "description": "The language ID of the language that is being described.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "languageId",
            "in": "path",
            "description": "The language ID.",
            "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": [
          "Language Descriptions"
        ],
        "description": "Update a language descriptions.",
        "operationId": "updateLanguageDescriptionById",
        "parameters": [
          {
            "name": "descriptionLanguageId",
            "in": "path",
            "description": "The language ID of the language that is being described.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "languageId",
            "in": "path",
            "description": "The language ID.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "requestBody": {
          "description": "Language Description",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LanguageDescriptionRequest"
              }
            }
          },
          "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": "LanguageDescription"
      }
    }
  },
  "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."
      },
      "LanguageDescriptionRequest": {
        "required": [
          "descriptionLanguageId",
          "languageId"
        ],
        "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"
      },
      "LanguageDescription": {
        "required": [
          "descriptionLanguageId",
          "languageId"
        ],
        "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"
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "The URL of the self link."
                  }
                },
                "description": ""
              }
            },
            "description": "Links to related resources."
          }
        },
        "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": []
    }
  ]
}