/* Сервис реализует функционал управления точками доступа */ syntax = "proto3"; import "google/protobuf/timestamp.proto"; import "google/api/annotations.proto"; import "google/api/field_behavior.proto"; import "google/protobuf/descriptor.proto"; import "google/protobuf/wrappers.proto"; import "keyapis/access_control/v1/keyapis_access_control_access_control_v1.proto"; package keyapis.access_control.v1; option java_package = "ru.keyapis.access_control.v1"; option java_outer_classname = "KeyapisAccessControlV1Proto"; option java_multiple_files = false; option java_string_check_utf8 = true; option go_package = "/keyapis_access_control_v1"; option cc_enable_arenas = true; option csharp_namespace = "Keyapis.AccessControl.V1"; option objc_class_prefix = "KEYAPISACCESSCONTROLV1"; option php_namespace = "Keyapis\\AccessControl\\V1"; option ruby_package = "Keyapis::AccessControl::V1"; option optimize_for = LITE_RUNTIME; // Сервис точек доступа service AccessPointService { // Метод сохранения точки доступа. // Поддерживает создание и обновление. // Метод доступен для: admin, service, bti rpc PostAccessPoint(PostAccessPointRequest) returns (PostAccessPointResponse) { option (google.api.http) = { post: "/access_control/api/v1/access_point", body: "*" }; } // Метод получения точки доступа по идентификатору. // Метод доступен для: admin, service, bti. // Метод доступен для: ApiKey rpc GetAccessPoint(GetAccessPointRequest) returns (GetAccessPointResponse) { option (google.api.http) = { get : "/access_control/api/v1/access_point/{id}" }; } // Метод получения списка точек доступа. // Метод доступен для: admin, service, bti. // Метод доступен для: ApiKey rpc GetAccessPointList(GetAccessPointListRequest) returns (stream GetAccessPointListResponse) { option (google.api.http) = { get : "/access_control/api/v1/access_point/list" }; } // Метод получения количества точек доступа. // Метод доступен для: admin, service, bti. // Метод доступен для: ApiKey rpc GetAccessPointCount(GetAccessPointCountRequest) returns (GetAccessPointCountResponse) { option (google.api.http) = { get : "/access_control/api/v1/access_point/count" }; } // Метод удаления точки доступа. // Метод доступен для: admin, service, bti rpc DeleteAccessPoint(DeleteAccessPointRequest) returns (DeleteAccessPointResponse) { option (google.api.http) = { delete: "/access_control/api/v1/access_point/{id}" }; } // Метод открытия точки доступа. // Метод доступен для: admin, service, bti. // Метод доступен для: ApiKey rpc PostAccessPointOpen(PostAccessPointOpenRequest) returns (PostAccessPointOpenResponse) { option (google.api.http) = { post: "/access_control/api/v1/access_point/open" body: "*" }; } } // Точка доступа. // # Описание модели message AccessPoint { // Идентификатор точки доступа. // # Тип: Guid string id = 1; // Наименование. // # Диапазон: 3..40 string title = 2 [(google.api.field_behavior) = REQUIRED]; // Описание. // # Диапазон: 3..200 google.protobuf.StringValue description = 3; // Идентификатор устройства. // # Диапазон: 1..2147483647 int32 device_id = 4 [(google.api.field_behavior) = REQUIRED]; // Номер реле. // # Диапазон: 0..100 google.protobuf.Int32Value relay_index = 5; // Время задержки в секундах. // # Диапазон: 1..3600 int32 delay = 6 [(google.api.field_behavior) = REQUIRED]; // Идентификатор квартирограммы. // # Диапазон: 1..2147483647 int32 flatgramm_id = 7 [(google.api.field_behavior) = REQUIRED]; // Тип направления. // # Тип: byte enum DirectionType { // Не указано DIRECTION_TYPE_UNKNOWN = 0; // Вход IN = 1; // Выход OUT = 2; // В обоих направлениях REVERSE = 3; } // Тип направления DirectionType direction_type = 8 [(google.api.field_behavior) = REQUIRED]; // Камера message Camera { // UID камеры string uid = 1 [(google.api.field_behavior) = REQUIRED]; // Тип распознавания. // Атрибут, определяющий тип данных, который распознает камера. // # Тип: byte enum RecognitionType { // Не указано RECOGNITION_TYPE_UNKNOWN = 0; // По номеру авто CAR_NUMBER = 1; // По типу транспорта VEHICLE_TYPE = 2; } // Типы распознавания repeated RecognitionType recognition_types = 2; } // Список камер repeated Camera cameras = 9; // Дата создания. // # Тип: DateTime google.protobuf.Timestamp created_at = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; // Дата последнего изменения. // Заполняется и обновляется сервером. // Заполняется при создании и изменении. // Является версией объекта. // # Тип: DateTime google.protobuf.Timestamp changed_at = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; // Дата удаления. // # Тип: DateTime? google.protobuf.Timestamp deleted_at = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; // Ошибка сохранения. // Эти проверки выполняются при работе с базой данных и сторонними сервисами message SavingError { // Конфликт версий. // Причины: // - В базе хранится другая версия строки, значения changed_at оличаются message Conflict {} // Причина ошибки oneof reason { // Конфликт версий Conflict conflict = 1; } } } // Фильтр по точкам доступа message AccessPointFilter { // По тексту. // Если значение не передано то поиск по нему не производится. // # Диапазон: 3..64. // # Поиск производится по полям: // # - Наименование; // # - Описание google.protobuf.StringValue text = 1; // По идентификаторам устройств repeated int32 device_ids = 2; // По идентификаторам квартирограмм repeated int32 flatgramm_ids = 3; // По типам направления repeated AccessPoint.DirectionType direction_types = 4; // По идентификаторам группы. // # Тип: Guid repeated string group_ids = 5; // По идентификаторам камер repeated string camera_uids = 6; } // Постраничный вывод message AccessPointPaging { // Справочник типов значений сортировки. // # Тип: byte enum OrderByType { // Значение не указано ORDER_BY_TYPE_UNKNOWN = 0; // По идентификатору ID = 1; // По наименованию TITLE = 2; // Дата последнего изменения CHANGED_AT = 3; // Дата создания CREATED_AT = 4; // По рангу для поиска по тексту. // Применяется когда передано поле для поиска по тексту. // В случае если текстовое поле не передано, применяется значение по умолчанию RANK = 5; } // Тип значения сортировки. // Если значение не передано, то будет взято значение по умолчанию. // # По умолчанию: CHANGED_AT OrderByType order_by_type = 1; // Справочник типов направлений сортировки; // # Тип: byte enum DirectionType { // Значение не указано DIRECTION_TYPE_UNKNOWN = 0; // От большего к меньшему DESC = 1; // От меньшего к большему ASC = 2; } // Тип направления сортировки. // # По умолчанию: DESC DirectionType direction_type = 2; // Количество записей на страницу. // Если значение 0 (не передано), то будет взято значение по умолчанию. // # Диапазон: 0..100. // # По умолчанию: 20 int32 limit = 3; // Сдвиг. // # Диапазон: 0..2147483647 int32 offset = 4; } // Запрос на создание/изменение точки доступа message PostAccessPointRequest { // Точка доступа AccessPoint data = 1 [(google.api.field_behavior) = REQUIRED]; } // Ответ на запрос на создание/изменение точки доступа message PostAccessPointResponse { // Ошибка запроса сохранения точки доступа message Error { // Причина ошибки oneof reason { // Ошибка валидации ValidationError validation = 1; // Ошибка сохранения AccessPoint.SavingError saving = 2; } } // Тип ответа oneof type { // Точка доступа AccessPoint data = 1; // Ошибка Error error = 2; } } // Запрос на получение списка точек доступа message GetAccessPointListRequest { // Фильтр AccessPointFilter filter = 1; // Вариант разбиения на страницы oneof pagination { // Стандартный постраничный вывод AccessPointPaging paging = 2; } } // Ответ на получение списка точек доступа message GetAccessPointListResponse { // Ошибка запроса получения списка точек доступа message Error { // Причина ошибки oneof reason { // Ошибка валидации ValidationError validation = 1; } } // Тип результата oneof type { // Точка доступа AccessPoint data = 1; // Ошибка Error error = 2; } } // Запрос получения точки доступа message GetAccessPointRequest { // Идентификатор. // # Тип: Guid string id = 1 [(google.api.field_behavior) = REQUIRED]; } // Ответ на запрос получения точки доступа message GetAccessPointResponse { // Ошибка запроса получения точки доступа message Error { // Причина ошибки oneof reason { // Ошибка валидации ValidationError validation = 1; } } // Тип результата oneof type { // Точка доступа AccessPoint data = 1; // Ошибка Error error = 2; } } // Запрос получения количества точек доступа message GetAccessPointCountRequest { // Фильтр AccessPointFilter filter = 1; } // Ответ на запрос получения количества точек доступа message GetAccessPointCountResponse { // Ошибка запроса получения количества точек доступа message Error { // Причина ошибки oneof reason { // Ошибка валидации ValidationError validation = 1; } } // Тип результата oneof type { // Всего точек доступа int32 data = 1; // Ошибка Error error = 2; } } // Запрос удаления точки доступа message DeleteAccessPointRequest { // Идентификатор. // # Тип: Guid string id = 1 [(google.api.field_behavior) = REQUIRED]; } // Ответ на запрос удаления точки доступа message DeleteAccessPointResponse { // Ошибка запроса удаления точки доступа message Error { // Причина ошибки oneof reason { // Ошибка валидации ValidationError validation = 1; } } // Тип результата oneof type { // Ошибка Error error = 1; } } // Запрос открытия точки доступа message PostAccessPointOpenRequest { // Идентификатор точки доступа. // # Тип: Guid string access_point_id = 1 [(google.api.field_behavior) = REQUIRED]; // ГРЗ авто. // # Диапазон: 3..20 google.protobuf.StringValue car_number = 2; // Тип ТС enum VehicleType { // Не указано VEHICLE_TYPE_UNKNOWN = 0; // МЧС EMERGENCY = 1; // Полиция POLICE = 2; // Скорая помощь AMBULANCE = 3; // Мусоровоз GARBAGE_TRUCK = 4; // Такси TAXI = 5; } // Тип ТС VehicleType vehicle_type = 3; // Наименование курьерской компании. // # Диапазон: 3..150 google.protobuf.StringValue courier_company_name = 4; // Номер заказа. // # Диапазон: 3..64 google.protobuf.StringValue order_number = 5; // Идентификатор курьера. // # Диапазон: 3..64 google.protobuf.StringValue courier_id = 6; } // Ответ на запрос открытия точки доступа message PostAccessPointOpenResponse { // Ошибка запроса открытия точки доступа message Error { // Причина ошибки oneof reason { // Ошибка валидации ValidationError validation = 1; } } // Тип результата oneof type { // Ошибка Error error = 1; } }