{
  "openapi": "3.0.1",
  "info": {
    "title": "Facet Descriptions",
    "description": "Create and administer a collection of facet descriptions.",
    "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": "Facet Descriptions",
      "description": "Provide RESTful services to manage facet descriptions."
    }
  ],
  "paths": {
    "/facet-descriptions": {
      "get": {
        "tags": [
          "Facet Descriptions"
        ],
        "description": "Get a collection of facet descriptions.",
        "operationId": "getFacetDescriptions",
        "parameters": [
          {
            "name": "facetId",
            "in": "query",
            "description": "The unique identifier for this search facet.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "languageId",
            "in": "query",
            "description": "The language ID for identifying the description of the search facet.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "name",
            "in": "query",
            "description": "The language sensitive name for none attribute dictionary attribute based search facets.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "description",
            "in": "query",
            "description": "The language sensitive administrative description for none attribute dictionary attribute based search facets.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "field1",
            "in": "query",
            "description": "Customizable field.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "field2",
            "in": "query",
            "description": "Customizable field.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "field3",
            "in": "query",
            "description": "Customizable field.",
            "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 facet descriptions.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FacetDescriptionCollection"
                }
              }
            }
          },
          "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": [
          "Facet Descriptions"
        ],
        "description": "Create a facet descriptions.",
        "operationId": "createFacetDescription",
        "requestBody": {
          "description": "The search facet descriptions for none attribute dictionary attribute based facets.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FacetDescription.request"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the facet property Description.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetFacetPropertyDescriptionByFacetIdandLanguageId": {
                "operationRef": "#/paths/~1facet-descriptions~1facetId:{facetId},languageId:{languageId}/get",
                "parameters": {
                  "facetId": "$request.body#/facetId",
                  "languageId": "$request.body#/languageId"
                },
                "description": "The `facetId` value used in the request body can be used as the `id` parameter in `GET /facet-descriptions/facetId:{facetId},languageId:{languageId}`.\n"
              },
              "DeleteFacetPropertyDescriptionByFacetIdandLanguageId": {
                "operationRef": "#/paths/~1facet-descriptions~1facetId:{facetId},languageId:{languageId}/delete",
                "parameters": {
                  "facetId": "$request.body#/facetId",
                  "languageId": "$request.body#/languageId"
                },
                "description": "The `facetId` value used in the request body can be used as the `id` parameter in `DELETE /facet-descriptions/facetId:{facetId},languageId:{languageId}`.\n"
              },
              "UpdateFacetPropertyDescriptionByFacetIdandLanguageId": {
                "operationRef": "#/paths/~1facet-descriptions~1facetId:{facetId},languageId:{languageId}/patch",
                "parameters": {
                  "facetId": "$request.body#/facetId",
                  "languageId": "$request.body#/languageId"
                },
                "description": "The `facetId` value used in the request body can be used as the `id` parameter in `PATCH /facet-descriptions/facetId:{facetId},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": "FacetDescription"
      }
    },
    "/facet-descriptions/facetId:{facetId},languageId:{languageId}": {
      "get": {
        "tags": [
          "Facet Descriptions"
        ],
        "description": "Get a facet descriptions.",
        "operationId": "getFacetDescriptionById",
        "parameters": [
          {
            "name": "facetId",
            "in": "path",
            "description": "The unique identifier for this search facet.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "languageId",
            "in": "path",
            "description": "The language ID for identifying the description of the search facet.",
            "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 search facet descriptions for none attribute dictionary attribute based facets.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FacetDescription"
                }
              }
            }
          },
          "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": [
          "Facet Descriptions"
        ],
        "description": "Delete a facet descriptions.",
        "operationId": "deleteFacetDescriptionById",
        "parameters": [
          {
            "name": "facetId",
            "in": "path",
            "description": "The unique identifier for this search facet.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "languageId",
            "in": "path",
            "description": "The language ID for identifying the description of the search facet.",
            "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": [
          "Facet Descriptions"
        ],
        "description": "Update a facet descriptions.",
        "operationId": "updateFacetDescriptionById",
        "parameters": [
          {
            "name": "facetId",
            "in": "path",
            "description": "The unique identifier for this search facet.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "languageId",
            "in": "path",
            "description": "The language ID for identifying the description of the search facet.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "requestBody": {
          "description": "The search facet descriptions for none attribute dictionary attribute based facets.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FacetDescription.request"
              }
            }
          },
          "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": "FacetDescription"
      }
    }
  },
  "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."
      },
      "FacetDescription": {
        "type": "object",
        "properties": {
          "facetId": {
            "type": "integer",
            "description": "The unique identifier for this search facet.",
            "format": "int64"
          },
          "languageId": {
            "type": "integer",
            "description": "The language ID for identifying the description of the search facet.",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "description": "The language sensitive name for none attribute dictionary attribute based search facets."
          },
          "description": {
            "type": "string",
            "description": "The language sensitive administrative description for none attribute dictionary attribute based search facets."
          },
          "field1": {
            "type": "integer",
            "description": "Customizable field.",
            "format": "int32"
          },
          "field2": {
            "type": "string",
            "description": "Customizable field."
          },
          "field3": {
            "type": "string",
            "description": "Customizable field."
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                },
                "required": [
                  "href"
                ]
              }
            }
          }
        },
        "description": "The search facet descriptions for none attribute dictionary attribute based facets."
      },
      "FacetDescription.request": {
        "type": "object",
        "properties": {
          "facetId": {
            "type": "integer",
            "description": "The unique identifier for this search facet.",
            "format": "int64"
          },
          "languageId": {
            "type": "integer",
            "description": "The language ID for identifying the description of the search facet.",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "description": "The language sensitive name for none attribute dictionary attribute based search facets."
          },
          "description": {
            "type": "string",
            "description": "The language sensitive administrative description for none attribute dictionary attribute based search facets."
          },
          "field1": {
            "type": "integer",
            "description": "Customizable field.",
            "format": "int32"
          },
          "field2": {
            "type": "string",
            "description": "Customizable field."
          },
          "field3": {
            "type": "string",
            "description": "Customizable field."
          }
        },
        "description": "The search facet descriptions for none attribute dictionary attribute based facets."
      },
      "FacetDescriptionCollection": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string"
          },
          "count": {
            "type": "integer",
            "description": "The total number of items.",
            "format": "int64"
          },
          "items": {
            "type": "array",
            "description": "The items.",
            "items": {
              "$ref": "#/components/schemas/FacetDescription"
            }
          }
        },
        "description": "A collection of facet descriptions."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ]
}