{
  "openapi": "3.0.3",
  "info": {
    "title": "rfidregistry",
    "version": "1.0.1775813760260",
    "description": "Сервис rfidregistry",
    "license": {
      "name": "CC BY-NC-ND 4.0",
      "url": "https://gitlab.infra.rtkit.dev/openapi/key/raw/main/LICENCE.md"
    }
  },
  "tags": [
    {
      "name": "record(auth)",
      "description": "Методы record. Требуют авторизацию. Доступны из интернета"
    },
    {
      "name": "system(public)",
      "description": "Методы system. Не требуют авторизацию. Доступны из интернета"
    }
  ],
  "paths": {
    "/rfidregistry/api/v1/record": {
      "post": {
        "summary": "Метод сохранения записи.\nНельзя отвязать ключ, который привязал кто-то другой.\nПоддерживает создание и обновление.\nМетод доступен для: admin, service, device_admin",
        "operationId": "RecordService_PostRecord",
        "responses": {
          "200": {
            "description": "Успешный ответ",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/v1PostRecordResponse"
                }
              }
            }
          },
          "400": {
            "description": "Ошибка",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/v1PostRecordResponse"
                }
              }
            }
          },
          "401": {
            "description": "Запрос не авторизован"
          },
          "403": {
            "description": "В доступе отказано"
          },
          "409": {
            "description": "В базе данных хранится более новая версия объекта"
          },
          "500": {
            "description": "Внутренняя ошибка сервиса",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/v1PostRecordResponse"
                }
              }
            }
          },
          "default": {
            "description": "Ошибки транспортного слоя",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/rpcStatus"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/v1PostRecordRequest"
              }
            }
          },
          "required": true
        },
        "tags": [
          "record(auth)"
        ],
        "security": [
          {
            "oauth2": [
              "rfidregistry:edit"
            ],
            "bearerHttp": []
          }
        ],
        "parameters": [
          {
            "in": "header",
            "name": "X-Request-Id",
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "description": "Уникальный идентификатор запроса. Создаётся клиентом на каждый запрос"
          },
          {
            "in": "header",
            "name": "X-Device-Id",
            "schema": {
              "type": "string"
            },
            "description": "Уникальный идентификатор устройства. Создаётся клиентом при первом запуске приложения. Если есть способ однозначно узнать идентификатор устройства, то создаётся на основе него и остаётся неизменным после переустановки приложения"
          },
          {
            "in": "header",
            "name": "X-Api-Key",
            "schema": {
              "type": "string"
            },
            "description": "Уникальный ключ для партнера. Создается администратором и передается партнерам."
          },
          {
            "in": "header",
            "name": "Canary",
            "schema": {
              "type": "string"
            },
            "description": "Параметр балансировки запроса. Если для заголовка запроса установлено значение always, он будет перенаправлен на канареечный деплой. Если для заголовка установлено значение never, он никогда не будет перенаправлен на канареечный деплой"
          }
        ]
      }
    },
    "/rfidregistry/api/v1/record/count": {
      "get": {
        "summary": "Метод получения количества записей.\nМетод доступен для: admin, service, device_admin",
        "operationId": "RecordService_GetRecordCount",
        "responses": {
          "200": {
            "description": "Успешный ответ",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/v1GetRecordCountResponse"
                }
              }
            }
          },
          "400": {
            "description": "Ошибка",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/v1GetRecordCountResponse"
                }
              }
            }
          },
          "401": {
            "description": "Запрос не авторизован"
          },
          "403": {
            "description": "В доступе отказано"
          },
          "500": {
            "description": "Внутренняя ошибка сервиса",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/v1GetRecordCountResponse"
                }
              }
            }
          },
          "default": {
            "description": "Ошибки транспортного слоя",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/rpcStatus"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter.rfidTypes",
            "description": "По типам ключей\n\n - RFID_TYPE_UNKNOWN: Значение не указано\n - FOB: Брелок\n - CARD: Карта\n - BAND: Браслет\n - STICKER: Стикер\n - ACTIVE_TAG: Активная метка",
            "in": "query",
            "required": false,
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "FOB",
                  "CARD",
                  "BAND",
                  "STICKER",
                  "ACTIVE_TAG"
                ]
              }
            }
          },
          {
            "name": "filter.encryptionTypes",
            "description": "По типам шифрования\n\n - ENCRYPTION_TYPE_UNKNOWN: Значение не указано\n - SL0: Без шифрования\n - SL1: С шифрованием, копируемый\n - SL3: С шифрованием, не копируемый",
            "in": "query",
            "required": false,
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "SL0",
                  "SL1",
                  "SL3"
                ]
              }
            }
          },
          {
            "name": "filter.uids",
            "description": "По номерам ключей",
            "in": "query",
            "required": false,
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "filter.statusTypes",
            "description": "По типам статуса\n\n - STATUS_TYPE_UNKNOWN: Значение не указано\n - NEW: Новый\n - SHIPPED: Отгружен\n - DEFECT: Брак\n - IN_USE: Использован",
            "in": "query",
            "required": false,
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "NEW",
                  "SHIPPED",
                  "DEFECT",
                  "IN_USE"
                ]
              }
            }
          },
          {
            "name": "filter.inUseRfidIds",
            "description": "По номерам привязанных ключей",
            "in": "query",
            "required": false,
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "filter.resourceOwnerIds",
            "description": "По владельцам",
            "in": "query",
            "required": false,
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "filter.orderNumbers",
            "description": "По номерам заказа",
            "in": "query",
            "required": false,
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "filter.inUseResourceOwnerIds",
            "description": "По владельцам привязанных ключей",
            "in": "query",
            "required": false,
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "filter.isDeleted",
            "description": "По удалённым записям.\nПо умолчанию: false",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "filter.text",
            "description": "По тексту.\nЕсли значение не передано то поиск по нему не производится.\n# Диапазон: 3..64.\n# Поиск производится по полям:\n# - Номер заказа;\n# - Производитель",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "filter.startShippedAt",
            "description": "Дата отгрузки от",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "filter.endShippedAt",
            "description": "Дата отгрузки до",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "filter.packageInfoBoxes",
            "description": "По номеру коробки",
            "in": "query",
            "required": false,
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "integer",
                "format": "int32"
              }
            }
          },
          {
            "name": "filter.packageInfoPlaces",
            "description": "По номеру места в коробке",
            "in": "query",
            "required": false,
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "integer",
                "format": "int32"
              }
            }
          },
          {
            "name": "filter.identificationMethodTypes",
            "description": "По методу идентификации\n\n - IDENTIFICATION_METHOD_TYPE_UNKNOWN: Значение не указано\n - MIFARE: Значение Mifare\n - BLE: Значение Bluetooth low energy\n - UHF: Значение Ultra high frequency\n - EM_MARINE: Значение em-marine",
            "in": "query",
            "required": false,
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "MIFARE",
                  "BLE",
                  "UHF",
                  "EM_MARINE"
                ]
              }
            }
          },
          {
            "in": "header",
            "name": "X-Request-Id",
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "description": "Уникальный идентификатор запроса. Создаётся клиентом на каждый запрос"
          },
          {
            "in": "header",
            "name": "X-Device-Id",
            "schema": {
              "type": "string"
            },
            "description": "Уникальный идентификатор устройства. Создаётся клиентом при первом запуске приложения. Если есть способ однозначно узнать идентификатор устройства, то создаётся на основе него и остаётся неизменным после переустановки приложения"
          },
          {
            "in": "header",
            "name": "X-Api-Key",
            "schema": {
              "type": "string"
            },
            "description": "Уникальный ключ для партнера. Создается администратором и передается партнерам."
          },
          {
            "in": "header",
            "name": "Canary",
            "schema": {
              "type": "string"
            },
            "description": "Параметр балансировки запроса. Если для заголовка запроса установлено значение always, он будет перенаправлен на канареечный деплой. Если для заголовка установлено значение never, он никогда не будет перенаправлен на канареечный деплой"
          }
        ],
        "tags": [
          "record(auth)"
        ],
        "security": [
          {
            "oauth2": [
              "rfidregistry:read",
              "rfidregistry:edit"
            ],
            "bearerHttp": []
          }
        ]
      }
    },
    "/rfidregistry/api/v1/record/list": {
      "get": {
        "summary": "Метод получения списка записей.\nМетод доступен для: admin, service, device_admin",
        "operationId": "RecordService_GetRecordList",
        "responses": {
          "200": {
            "description": "Успешный ответ",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "result": {
                      "$ref": "#/components/schemas/v1GetRecordListResponse"
                    },
                    "error": {
                      "$ref": "#/components/schemas/rpcStatus"
                    }
                  },
                  "title": "Поток объектов v1GetRecordListResponse"
                }
              }
            }
          },
          "400": {
            "description": "Ошибка"
          },
          "401": {
            "description": "Запрос не авторизован"
          },
          "403": {
            "description": "В доступе отказано"
          },
          "500": {
            "description": "Внутренняя ошибка сервиса",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/rpcStatus"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "filter.rfidTypes",
            "description": "По типам ключей\n\n - RFID_TYPE_UNKNOWN: Значение не указано\n - FOB: Брелок\n - CARD: Карта\n - BAND: Браслет\n - STICKER: Стикер\n - ACTIVE_TAG: Активная метка",
            "in": "query",
            "required": false,
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "FOB",
                  "CARD",
                  "BAND",
                  "STICKER",
                  "ACTIVE_TAG"
                ]
              }
            }
          },
          {
            "name": "filter.encryptionTypes",
            "description": "По типам шифрования\n\n - ENCRYPTION_TYPE_UNKNOWN: Значение не указано\n - SL0: Без шифрования\n - SL1: С шифрованием, копируемый\n - SL3: С шифрованием, не копируемый",
            "in": "query",
            "required": false,
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "SL0",
                  "SL1",
                  "SL3"
                ]
              }
            }
          },
          {
            "name": "filter.uids",
            "description": "По номерам ключей",
            "in": "query",
            "required": false,
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "filter.statusTypes",
            "description": "По типам статуса\n\n - STATUS_TYPE_UNKNOWN: Значение не указано\n - NEW: Новый\n - SHIPPED: Отгружен\n - DEFECT: Брак\n - IN_USE: Использован",
            "in": "query",
            "required": false,
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "NEW",
                  "SHIPPED",
                  "DEFECT",
                  "IN_USE"
                ]
              }
            }
          },
          {
            "name": "filter.inUseRfidIds",
            "description": "По номерам привязанных ключей",
            "in": "query",
            "required": false,
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "filter.resourceOwnerIds",
            "description": "По владельцам",
            "in": "query",
            "required": false,
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "filter.orderNumbers",
            "description": "По номерам заказа",
            "in": "query",
            "required": false,
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "filter.inUseResourceOwnerIds",
            "description": "По владельцам привязанных ключей",
            "in": "query",
            "required": false,
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "filter.isDeleted",
            "description": "По удалённым записям.\nПо умолчанию: false",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "filter.text",
            "description": "По тексту.\nЕсли значение не передано то поиск по нему не производится.\n# Диапазон: 3..64.\n# Поиск производится по полям:\n# - Номер заказа;\n# - Производитель",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "filter.startShippedAt",
            "description": "Дата отгрузки от",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "filter.endShippedAt",
            "description": "Дата отгрузки до",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "filter.packageInfoBoxes",
            "description": "По номеру коробки",
            "in": "query",
            "required": false,
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "integer",
                "format": "int32"
              }
            }
          },
          {
            "name": "filter.packageInfoPlaces",
            "description": "По номеру места в коробке",
            "in": "query",
            "required": false,
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "integer",
                "format": "int32"
              }
            }
          },
          {
            "name": "filter.identificationMethodTypes",
            "description": "По методу идентификации\n\n - IDENTIFICATION_METHOD_TYPE_UNKNOWN: Значение не указано\n - MIFARE: Значение Mifare\n - BLE: Значение Bluetooth low energy\n - UHF: Значение Ultra high frequency\n - EM_MARINE: Значение em-marine",
            "in": "query",
            "required": false,
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "MIFARE",
                  "BLE",
                  "UHF",
                  "EM_MARINE"
                ]
              }
            }
          },
          {
            "name": "paging.orderByType",
            "description": "Тип значения сортировки.\nЕсли значение не передано, то будет взято значение по умолчанию.\n# По умолчанию: NEW_AT\n\n - ORDER_BY_TYPE_UNKNOWN: Значение не указано\n - NEW_AT: По дате перевода в статус new (дате создания)\n - CHANGED_AT: По времени изменения\n - ORDER_AT: По времени заказа\n - ORDER_NUMBER: По номеру заказа\n - RANK: По рангу для поиска по тексту.\nПрименяется когда передано поле для поиска по тексту.\nВ случае если текстовое поле не передано, применяется значение по умолчанию",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "NEW_AT",
                "CHANGED_AT",
                "ORDER_AT",
                "ORDER_NUMBER",
                "RANK"
              ]
            }
          },
          {
            "name": "paging.directionType",
            "description": "Тип направления сортировки.\n# По умолчанию: DESC\n\n - DIRECTION_TYPE_UNKNOWN: Значение не указано\n - DESC: От большего к меньшему\n - ASC: От меньшего к большему",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "DESC",
                "ASC"
              ]
            }
          },
          {
            "name": "paging.limit",
            "description": "Количество записей на страницу.\nЕсли значение 0 (не передано), то будет взято значение по умолчанию.\n# Диапазон: 0..100.\n# По умолчанию: 20",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "paging.offset",
            "description": "Сдвиг.\n# Диапазон: 0..2147483647",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "in": "header",
            "name": "X-Request-Id",
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "description": "Уникальный идентификатор запроса. Создаётся клиентом на каждый запрос"
          },
          {
            "in": "header",
            "name": "X-Device-Id",
            "schema": {
              "type": "string"
            },
            "description": "Уникальный идентификатор устройства. Создаётся клиентом при первом запуске приложения. Если есть способ однозначно узнать идентификатор устройства, то создаётся на основе него и остаётся неизменным после переустановки приложения"
          },
          {
            "in": "header",
            "name": "X-Api-Key",
            "schema": {
              "type": "string"
            },
            "description": "Уникальный ключ для партнера. Создается администратором и передается партнерам."
          },
          {
            "in": "header",
            "name": "Canary",
            "schema": {
              "type": "string"
            },
            "description": "Параметр балансировки запроса. Если для заголовка запроса установлено значение always, он будет перенаправлен на канареечный деплой. Если для заголовка установлено значение never, он никогда не будет перенаправлен на канареечный деплой"
          }
        ],
        "tags": [
          "record(auth)"
        ],
        "security": [
          {
            "oauth2": [
              "rfidregistry:read",
              "rfidregistry:edit"
            ],
            "bearerHttp": []
          }
        ]
      }
    },
    "/rfidregistry/api/v1/record/{id}": {
      "get": {
        "summary": "Метод получения записи.\nМетод доступен для: admin, service, device_admin",
        "operationId": "RecordService_GetRecord",
        "responses": {
          "200": {
            "description": "Успешный ответ",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/v1GetRecordResponse"
                }
              }
            }
          },
          "400": {
            "description": "Ошибка"
          },
          "401": {
            "description": "Запрос не авторизован"
          },
          "403": {
            "description": "В доступе отказано"
          },
          "404": {
            "description": "Объект не найден"
          },
          "500": {
            "description": "Внутренняя ошибка сервиса",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/rpcStatus"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "description": "Идентификатор.\n# Тип: Guid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "name": "X-Request-Id",
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "description": "Уникальный идентификатор запроса. Создаётся клиентом на каждый запрос"
          },
          {
            "in": "header",
            "name": "X-Device-Id",
            "schema": {
              "type": "string"
            },
            "description": "Уникальный идентификатор устройства. Создаётся клиентом при первом запуске приложения. Если есть способ однозначно узнать идентификатор устройства, то создаётся на основе него и остаётся неизменным после переустановки приложения"
          },
          {
            "in": "header",
            "name": "X-Api-Key",
            "schema": {
              "type": "string"
            },
            "description": "Уникальный ключ для партнера. Создается администратором и передается партнерам."
          },
          {
            "in": "header",
            "name": "Canary",
            "schema": {
              "type": "string"
            },
            "description": "Параметр балансировки запроса. Если для заголовка запроса установлено значение always, он будет перенаправлен на канареечный деплой. Если для заголовка установлено значение never, он никогда не будет перенаправлен на канареечный деплой"
          }
        ],
        "tags": [
          "record(auth)"
        ],
        "security": [
          {
            "oauth2": [
              "rfidregistry:read",
              "rfidregistry:edit"
            ],
            "bearerHttp": []
          }
        ]
      },
      "delete": {
        "summary": "Метод удаления записи.\nМожно удалять только свои записи.\nНельзя удалить ключ, если его использует кто-то другой.\nМетод доступен для: admin, service, device_admin",
        "operationId": "RecordService_DeleteRecord",
        "responses": {
          "200": {
            "description": "Успешный ответ",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/v1DeleteRecordResponse"
                }
              }
            }
          },
          "400": {
            "description": "Ошибка",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/v1DeleteRecordResponse"
                }
              }
            }
          },
          "401": {
            "description": "Запрос не авторизован"
          },
          "403": {
            "description": "В доступе отказано"
          },
          "404": {
            "description": "Объект не найден"
          },
          "500": {
            "description": "Внутренняя ошибка сервиса",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/v1DeleteRecordResponse"
                }
              }
            }
          },
          "default": {
            "description": "Ошибки транспортного слоя",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/rpcStatus"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "description": "Идентификатор записи.\n# Тип: Guid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "name": "X-Request-Id",
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "description": "Уникальный идентификатор запроса. Создаётся клиентом на каждый запрос"
          },
          {
            "in": "header",
            "name": "X-Device-Id",
            "schema": {
              "type": "string"
            },
            "description": "Уникальный идентификатор устройства. Создаётся клиентом при первом запуске приложения. Если есть способ однозначно узнать идентификатор устройства, то создаётся на основе него и остаётся неизменным после переустановки приложения"
          },
          {
            "in": "header",
            "name": "X-Api-Key",
            "schema": {
              "type": "string"
            },
            "description": "Уникальный ключ для партнера. Создается администратором и передается партнерам."
          },
          {
            "in": "header",
            "name": "Canary",
            "schema": {
              "type": "string"
            },
            "description": "Параметр балансировки запроса. Если для заголовка запроса установлено значение always, он будет перенаправлен на канареечный деплой. Если для заголовка установлено значение never, он никогда не будет перенаправлен на канареечный деплой"
          }
        ],
        "tags": [
          "record(auth)"
        ],
        "security": [
          {
            "oauth2": [
              "rfidregistry:edit"
            ],
            "bearerHttp": []
          }
        ]
      }
    },
    "/rfidregistry/api/v1/system/status": {
      "get": {
        "summary": "Метод получения статуса сервиса.\nНе требует авторизации",
        "operationId": "SystemService_GetSystemStatus",
        "responses": {
          "200": {
            "description": "Успешный ответ",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/v1GetSystemStatusResponse"
                }
              }
            }
          },
          "400": {
            "description": "Ошибка"
          },
          "500": {
            "description": "Внутренняя ошибка сервиса",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/rpcStatus"
                }
              }
            }
          }
        },
        "tags": [
          "system(public)"
        ],
        "parameters": [
          {
            "in": "header",
            "name": "X-Request-Id",
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "description": "Уникальный идентификатор запроса. Создаётся клиентом на каждый запрос"
          },
          {
            "in": "header",
            "name": "X-Device-Id",
            "schema": {
              "type": "string"
            },
            "description": "Уникальный идентификатор устройства. Создаётся клиентом при первом запуске приложения. Если есть способ однозначно узнать идентификатор устройства, то создаётся на основе него и остаётся неизменным после переустановки приложения"
          },
          {
            "in": "header",
            "name": "X-Api-Key",
            "schema": {
              "type": "string"
            },
            "description": "Уникальный ключ для партнера. Создается администратором и передается партнерам."
          },
          {
            "in": "header",
            "name": "Canary",
            "schema": {
              "type": "string"
            },
            "description": "Параметр балансировки запроса. Если для заголовка запроса установлено значение always, он будет перенаправлен на канареечный деплой. Если для заголовка установлено значение never, он никогда не будет перенаправлен на канареечный деплой"
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "RecordAesKeyConfiguration": {
        "type": "object",
        "properties": {
          "address": {
            "type": "string",
            "title": "Адрес.\n# Паттерн: /^[A-Za-z0-9=]+$/"
          },
          "data": {
            "type": "string",
            "title": "Данные.\n# Паттерн: /^[A-Za-z0-9=]+$/"
          }
        },
        "title": "Конфигурация шифрования ключа",
        "required": [
          "address",
          "data"
        ]
      },
      "RecordDataCell": {
        "type": "object",
        "properties": {
          "section": {
            "type": "integer",
            "format": "int32",
            "title": "Сектор.\n# Диапазон: 0..127"
          },
          "block": {
            "type": "integer",
            "format": "int32",
            "title": "Блок.\n# Диапазон: 0..127"
          },
          "data": {
            "type": "string",
            "title": "Данные.\n# Паттерн: /^[A-Za-z0-9=]+$/"
          }
        },
        "title": "Содержимое ячейки ключа",
        "required": [
          "section",
          "block",
          "data"
        ]
      },
      "RecordEncryptionType": {
        "type": "string",
        "enum": [
          "SL0",
          "SL1",
          "SL3"
        ],
        "description": "- ENCRYPTION_TYPE_UNKNOWN: Значение не указано\n - SL0: Без шифрования\n - SL1: С шифрованием, копируемый\n - SL3: С шифрованием, не копируемый",
        "title": "Справочник типов шифрования ключа.\n# Тип: byte"
      },
      "RecordIdentificationMethodType": {
        "type": "string",
        "enum": [
          "MIFARE",
          "BLE",
          "UHF",
          "EM_MARINE"
        ],
        "description": "- IDENTIFICATION_METHOD_TYPE_UNKNOWN: Значение не указано\n - MIFARE: Значение Mifare\n - BLE: Значение Bluetooth low energy\n - UHF: Значение Ultra high frequency\n - EM_MARINE: Значение em-marine",
        "title": "Справочник методов идентификации.\n# Тип: byte"
      },
      "RecordPagingDirectionType": {
        "type": "string",
        "enum": [
          "DESC",
          "ASC"
        ],
        "description": "- DIRECTION_TYPE_UNKNOWN: Значение не указано\n - DESC: От большего к меньшему\n - ASC: От меньшего к большему",
        "title": "Справочник типов направлений сортировки.\n# Тип: byte"
      },
      "RecordPagingOrderByType": {
        "type": "string",
        "enum": [
          "NEW_AT",
          "CHANGED_AT",
          "ORDER_AT",
          "ORDER_NUMBER",
          "RANK"
        ],
        "description": "- ORDER_BY_TYPE_UNKNOWN: Значение не указано\n - NEW_AT: По дате перевода в статус new (дате создания)\n - CHANGED_AT: По времени изменения\n - ORDER_AT: По времени заказа\n - ORDER_NUMBER: По номеру заказа\n - RANK: По рангу для поиска по тексту.\nПрименяется когда передано поле для поиска по тексту.\nВ случае если текстовое поле не передано, применяется значение по умолчанию",
        "title": "Справочник типов значений сортировки.\n# Тип: byte"
      },
      "RecordRfidType": {
        "type": "string",
        "enum": [
          "FOB",
          "CARD",
          "BAND",
          "STICKER",
          "ACTIVE_TAG"
        ],
        "description": "- RFID_TYPE_UNKNOWN: Значение не указано\n - FOB: Брелок\n - CARD: Карта\n - BAND: Браслет\n - STICKER: Стикер\n - ACTIVE_TAG: Активная метка",
        "title": "Справочник типов ключей.\n# Тип: byte"
      },
      "RecordSavingError": {
        "type": "object",
        "properties": {
          "statusTypeRestricted": {
            "title": "Перевод статуса запрещён",
            "allOf": [
              {
                "$ref": "#/components/schemas/SavingErrorStatusTypeRestricted"
              }
            ]
          },
          "uidExist": {
            "title": "Запись уже существует",
            "allOf": [
              {
                "$ref": "#/components/schemas/SavingErrorUidExist"
              }
            ]
          },
          "ownedByAnotherUser": {
            "title": "Вы не владелец",
            "allOf": [
              {
                "$ref": "#/components/schemas/SavingErrorOwnedByAnotherUser"
              }
            ]
          },
          "alreadyLinked": {
            "title": "Ключ уже использован",
            "allOf": [
              {
                "$ref": "#/components/schemas/SavingErrorAlreadyLinked"
              }
            ]
          },
          "conflict": {
            "title": "Конфликт версий",
            "allOf": [
              {
                "$ref": "#/components/schemas/SavingErrorConflict"
              }
            ]
          }
        },
        "title": "Ошибка сохранения записи.\nЭти проверки выполняются при работе с базой данных и сторонними сервисами"
      },
      "RecordStatusType": {
        "type": "string",
        "enum": [
          "NEW",
          "SHIPPED",
          "DEFECT",
          "IN_USE"
        ],
        "description": "- STATUS_TYPE_UNKNOWN: Значение не указано\n - NEW: Новый\n - SHIPPED: Отгружен\n - DEFECT: Брак\n - IN_USE: Использован",
        "title": "Справочник типов статусов ключа.\n# Тип: byte"
      },
      "RecordTrailer": {
        "type": "object",
        "properties": {
          "sector": {
            "type": "integer",
            "format": "int32",
            "title": "Сектор.\n# Диапазон: 0..15"
          },
          "keyA": {
            "type": "string",
            "title": "Ключ А.\n# Диапазон: 1..256"
          },
          "keyB": {
            "type": "string",
            "title": "Ключ Б.\n# Диапазон: 1..256"
          },
          "accessMask": {
            "type": "string",
            "title": "Маска доступа.\n# Диапазон: 1..512"
          }
        },
        "title": "Контрольная сумма",
        "required": [
          "sector",
          "keyA",
          "keyB",
          "accessMask"
        ]
      },
      "SavingErrorAlreadyLinked": {
        "type": "object",
        "title": "Причины:\n- Такой ключ уже привязан к другой записи"
      },
      "SavingErrorConflict": {
        "type": "object",
        "title": "Причины:\n- В базе хранится более новая версия записи, значения changed_at отличаются"
      },
      "SavingErrorOwnedByAnotherUser": {
        "type": "object",
        "title": "Причины:\n- Запись принадлежит другому пользователю"
      },
      "SavingErrorStatusTypeRestricted": {
        "type": "object",
        "title": "Причины:\n- Недопустимый перевод статуса.\n- Не переданы обязательные поля https://openapi-key.deploy.rtkit.dev/keyapis_rfidregistry_v1/#таблица-обязательности-передачи-полей-в-request"
      },
      "SavingErrorUidExist": {
        "type": "object",
        "title": "Причины:\n- Ключ уже существует"
      },
      "protobufAny": {
        "type": "object",
        "properties": {
          "@type": {
            "type": "string"
          }
        },
        "additionalProperties": {},
        "title": "Произвольный JSON"
      },
      "rpcStatus": {
        "type": "object",
        "properties": {
          "code": {
            "type": "integer",
            "format": "int32"
          },
          "message": {
            "type": "string"
          },
          "details": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/protobufAny"
            }
          }
        },
        "title": "Ошибка транспортного слоя"
      },
      "v1DeleteRecordResponse": {
        "type": "object",
        "properties": {
          "error": {
            "title": "Ошибка",
            "allOf": [
              {
                "$ref": "#/components/schemas/v1DeleteRecordResponseError"
              }
            ]
          }
        },
        "title": "Ответ на запрос удаления записи из реестра"
      },
      "v1DeleteRecordResponseError": {
        "type": "object",
        "properties": {
          "validation": {
            "title": "Ошибка валидации",
            "allOf": [
              {
                "$ref": "#/components/schemas/v1ValidationError"
              }
            ]
          }
        },
        "title": "Ошибка удаления записи"
      },
      "v1GetRecordCountResponse": {
        "type": "object",
        "properties": {
          "data": {
            "type": "integer",
            "format": "int32",
            "title": "Всего записей"
          },
          "error": {
            "title": "Ошибка",
            "allOf": [
              {
                "$ref": "#/components/schemas/v1GetRecordCountResponseError"
              }
            ]
          }
        },
        "title": "Ответ на запрос получения количества записей"
      },
      "v1GetRecordCountResponseError": {
        "type": "object",
        "properties": {
          "validation": {
            "title": "Ошибка фильтрации записей",
            "allOf": [
              {
                "$ref": "#/components/schemas/v1ValidationError"
              }
            ]
          }
        },
        "title": "Ошибка запроса получения количества записей"
      },
      "v1GetRecordListResponse": {
        "type": "object",
        "properties": {
          "data": {
            "title": "Запись",
            "allOf": [
              {
                "$ref": "#/components/schemas/v1Record"
              }
            ]
          },
          "error": {
            "title": "Ошибка",
            "allOf": [
              {
                "$ref": "#/components/schemas/v1GetRecordListResponseError"
              }
            ]
          }
        },
        "title": "Ответ на запрос получения списка записей"
      },
      "v1GetRecordListResponseError": {
        "type": "object",
        "properties": {
          "validation": {
            "title": "Ошибка фильтрации записей",
            "allOf": [
              {
                "$ref": "#/components/schemas/v1ValidationError"
              }
            ]
          }
        },
        "title": "Ошибка запроса получения списка записей"
      },
      "v1GetRecordResponse": {
        "type": "object",
        "properties": {
          "data": {
            "title": "Запись",
            "allOf": [
              {
                "$ref": "#/components/schemas/v1Record"
              }
            ]
          }
        },
        "title": "Ответ на запрос получения записи"
      },
      "v1GetSystemStatusResponse": {
        "type": "object",
        "title": "Ответ на запрос проверки доступности сервиса"
      },
      "v1PostRecordRequest": {
        "type": "object",
        "properties": {
          "data": {
            "title": "Запись",
            "allOf": [
              {
                "$ref": "#/components/schemas/v1Record"
              }
            ]
          }
        },
        "title": "Запрос сохранения записи",
        "required": [
          "data"
        ]
      },
      "v1PostRecordResponse": {
        "type": "object",
        "properties": {
          "data": {
            "title": "Запись",
            "allOf": [
              {
                "$ref": "#/components/schemas/v1Record"
              }
            ]
          },
          "error": {
            "title": "Ошибка",
            "allOf": [
              {
                "$ref": "#/components/schemas/v1PostRecordResponseError"
              }
            ]
          }
        },
        "title": "Ответ на запрос сохранения записи"
      },
      "v1PostRecordResponseError": {
        "type": "object",
        "properties": {
          "validation": {
            "title": "Ошибка валидации",
            "allOf": [
              {
                "$ref": "#/components/schemas/v1ValidationError"
              }
            ]
          },
          "saving": {
            "title": "Ошибка сохранения записи",
            "allOf": [
              {
                "$ref": "#/components/schemas/RecordSavingError"
              }
            ]
          }
        },
        "title": "Ошибка запроса сохранения записи"
      },
      "v1Record": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "title": "Идентификатор.\nЕсли не передан создаётся сервером.\n# Тип: Guid"
          },
          "rfidType": {
            "title": "Тип ключа",
            "allOf": [
              {
                "$ref": "#/components/schemas/RecordRfidType"
              }
            ]
          },
          "encryptionType": {
            "title": "Тип шифрования ключа.\nМаксимально поддерживаемый ключом тип шифрования",
            "allOf": [
              {
                "$ref": "#/components/schemas/RecordEncryptionType"
              }
            ]
          },
          "uid": {
            "type": "string",
            "title": "Номер ключа.\nУказывается при создании.\n# Диапазон: 1..14"
          },
          "statusType": {
            "title": "Тип статуса ключа",
            "allOf": [
              {
                "$ref": "#/components/schemas/RecordStatusType"
              }
            ]
          },
          "newAt": {
            "type": "string",
            "format": "date-time",
            "title": "Дата перевода в статус \"Новый\".\n# Тип: DateTime",
            "readOnly": true
          },
          "shippedAt": {
            "type": "string",
            "format": "date-time",
            "title": "Дата перевода в статус \"Отгружен\".\n# Тип: DateTime",
            "readOnly": true
          },
          "defectAt": {
            "type": "string",
            "format": "date-time",
            "title": "Дата перевода в статус \"Брак\".\n# Тип: DateTime",
            "readOnly": true
          },
          "inUseAt": {
            "type": "string",
            "format": "date-time",
            "title": "Дата перевода в статус \"Использован\".\n# Тип: DateTime",
            "readOnly": true
          },
          "inUseRfidId": {
            "type": "string",
            "title": "Идентификатор привязанного ключа.\nЗаполняется при переводе в статус \"Использован\".\n# Диапазон: 0..16"
          },
          "dataCells": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RecordDataCell"
            },
            "title": "Содержимое ячеек ключа"
          },
          "resourceOwnerId": {
            "type": "string",
            "title": "Идентификатор владельца.\nЗаполняется сервером.\n# Диапазон: 0..255",
            "readOnly": true
          },
          "packageInfoBox": {
            "type": "integer",
            "format": "int32",
            "title": "Номер коробки.\n# Диапазон: 1..2147483647"
          },
          "packageInfoPlace": {
            "type": "integer",
            "format": "int32",
            "title": "Номер места в коробке.\n# Диапазон: 1..2147483647"
          },
          "changedAt": {
            "type": "string",
            "format": "date-time",
            "title": "Дата последнего изменения.\nЗаполняется и обновляется сервером.\nЗаполняется при создании и изменении.\nЯвляется версией объекта.\n# Тип: DateTime",
            "readOnly": true
          },
          "aesKeyConfigurations": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RecordAesKeyConfiguration"
            },
            "title": "Конфигурации шифрования ключа"
          },
          "trailers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RecordTrailer"
            },
            "title": "Контрольные суммы.\nНужны для ключей SL1 и SL3"
          },
          "orderNumber": {
            "type": "string",
            "title": "Номер заказа.\n# Диапазон: 0..256"
          },
          "orderAt": {
            "type": "string",
            "format": "date-time",
            "title": "Дата заказа.\n# Тип: DateTime"
          },
          "inUseResourceOwnerId": {
            "type": "string",
            "title": "Владелец привязанного ключа.\nЗаполняется сервером, значение берётся из токена при использовании ключа.\n# Диапазон: 0..255",
            "readOnly": true
          },
          "isDeleted": {
            "type": "boolean",
            "title": "Признак, удалена ли запись",
            "readOnly": true
          },
          "deletedAt": {
            "type": "string",
            "format": "date-time",
            "title": "Дата удаления.\n# Тип: DateTime",
            "readOnly": true
          },
          "vendorName": {
            "type": "string",
            "title": "Производитель.\n# Диапазон: 3..100"
          },
          "identificationMethodType": {
            "title": "Метод идентификации",
            "allOf": [
              {
                "$ref": "#/components/schemas/RecordIdentificationMethodType"
              }
            ]
          }
        },
        "title": "Запись.\n# Описание модели",
        "required": [
          "rfidType",
          "encryptionType",
          "uid",
          "statusType",
          "orderNumber",
          "orderAt"
        ]
      },
      "v1RecordFilter": {
        "type": "object",
        "properties": {
          "rfidTypes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RecordRfidType"
            },
            "title": "По типам ключей"
          },
          "encryptionTypes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RecordEncryptionType"
            },
            "title": "По типам шифрования"
          },
          "uids": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "title": "По номерам ключей"
          },
          "statusTypes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RecordStatusType"
            },
            "title": "По типам статуса"
          },
          "inUseRfidIds": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "title": "По номерам привязанных ключей"
          },
          "resourceOwnerIds": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "title": "По владельцам"
          },
          "orderNumbers": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "title": "По номерам заказа"
          },
          "inUseResourceOwnerIds": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "title": "По владельцам привязанных ключей"
          },
          "isDeleted": {
            "type": "boolean",
            "title": "По удалённым записям.\nПо умолчанию: false"
          },
          "text": {
            "type": "string",
            "title": "По тексту.\nЕсли значение не передано то поиск по нему не производится.\n# Диапазон: 3..64.\n# Поиск производится по полям:\n# - Номер заказа;\n# - Производитель"
          },
          "startShippedAt": {
            "type": "string",
            "format": "date-time",
            "title": "Дата отгрузки от"
          },
          "endShippedAt": {
            "type": "string",
            "format": "date-time",
            "title": "Дата отгрузки до"
          },
          "packageInfoBoxes": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int32"
            },
            "title": "По номеру коробки"
          },
          "packageInfoPlaces": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int32"
            },
            "title": "По номеру места в коробке"
          },
          "identificationMethodTypes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RecordIdentificationMethodType"
            },
            "title": "По методу идентификации"
          }
        },
        "title": "Фильтр записей"
      },
      "v1RecordPaging": {
        "type": "object",
        "properties": {
          "orderByType": {
            "title": "Тип значения сортировки.\nЕсли значение не передано, то будет взято значение по умолчанию.\n# По умолчанию: NEW_AT",
            "allOf": [
              {
                "$ref": "#/components/schemas/RecordPagingOrderByType"
              }
            ]
          },
          "directionType": {
            "title": "Тип направления сортировки.\n# По умолчанию: DESC",
            "allOf": [
              {
                "$ref": "#/components/schemas/RecordPagingDirectionType"
              }
            ]
          },
          "limit": {
            "type": "integer",
            "format": "int32",
            "title": "Количество записей на страницу.\nЕсли значение 0 (не передано), то будет взято значение по умолчанию.\n# Диапазон: 0..100.\n# По умолчанию: 20"
          },
          "offset": {
            "type": "integer",
            "format": "int32",
            "title": "Сдвиг.\n# Диапазон: 0..2147483647"
          }
        },
        "title": "Пагинация записей"
      },
      "v1ValidationError": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "title": "Путь к полю в формате наименования прото"
          },
          "message": {
            "type": "string",
            "title": "Валидационное сообщение"
          }
        },
        "title": "Ошибки валидации.\nЭти проверки выполняются до обращения в базу данных",
        "required": [
          "path",
          "message"
        ]
      }
    },
    "securitySchemes": {
      "bearerHttp": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      },
      "oauth2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://oauth2-staging.k8s.key.rt.ru/oauth2/token",
            "scopes": {
              "rfidregistry:edit": "Предоставляет полный доступ в сервис rfidregistry",
              "rfidregistry:read": "Предоставляет доступ на чтение данных из сервиса rfidregistry"
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://keyapis-staging.k8s.key.rt.ru",
      "description": "staging"
    },
    {
      "url": "https://{feature}.k8s.key.rt.ru/",
      "description": "https feature",
      "variables": {
        "feature": {
          "default": "",
          "description": "Feature name"
        }
      }
    },
    {
      "url": "http://{feature}.k8s.key.rt.ru/",
      "description": "http feature",
      "variables": {
        "feature": {
          "default": "",
          "description": "Feature name"
        }
      }
    },
    {
      "url": "https://localhost:3001",
      "description": "localhost"
    },
    {
      "url": "https://keyapis.key.rt.ru",
      "description": "production"
    }
  ]
}