/* Сервис реализует функционал управления зонами доступа */ syntax = "proto3"; import "google/protobuf/timestamp.proto"; import "google/api/annotations.proto"; import "google/api/field_behavior.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 AccessZoneService { // Метод сохранения зоны доступа. // Поддерживает создание и обновление. // Для пользователей типов owner, employee можно создать и редактировать зону доступа только в квартирограмме, относящейся к компании пользователя. // Метод доступен для: admin, service, bti, ltp_first, device_admin, manager, owner, employee rpc PostAccessZone(PostAccessZoneRequest) returns (PostAccessZoneResponse) { option (google.api.http) = { post: "/access_control/api/v1/access_zone", body: "*" }; } // Метод получения зоны доступа по идентификатору. // Для пользователей типов owner, employee возвращаются только зоны доступа, относящиеся к компании пользователя. // Метод доступен для: admin, service, bti, ltp_first, device_admin, manager, owner, employee rpc GetAccessZone(GetAccessZoneRequest) returns (GetAccessZoneResponse) { option (google.api.http) = { get: "/access_control/api/v1/access_zone/{id}" }; } // Метод получения списка зон доступа. // Для пользователей типов owner, employee возвращаются только зоны доступа, относящиеся к компании пользователя. // Метод доступен для: admin, service, bti, ltp_first, device_admin, manager, owner, employee rpc GetAccessZoneList(GetAccessZoneListRequest) returns (stream GetAccessZoneListResponse) { option (google.api.http) = { get: "/access_control/api/v1/access_zone/list" }; } // Метод получения количества зон доступа. // Для пользователей типов owner, employee возвращаются только зоны доступа, относящиеся к компании пользователя. // Метод доступен для: admin, service, bti, ltp_first, device_admin, manager, owner, employee rpc GetAccessZoneCount(GetAccessZoneCountRequest) returns (GetAccessZoneCountResponse) { option (google.api.http) = { get: "/access_control/api/v1/access_zone/count" }; } // Метод архивации зоны доступа. // Для пользователей типов owner, employee доступны к архивации только зоны доступа, относящиеся к компании пользователя. // Метод доступен для: admin, service, bti, ltp_first, device_admin, manager, owner, employee rpc DeleteAccessZone(DeleteAccessZoneRequest) returns (DeleteAccessZoneResponse) { option (google.api.http) = { delete: "/access_control/api/v1/access_zone/{id}" }; } // Метод разархивации зоны доступа по идентификатору. // Для пользователей типов owner, employee доступны к разархивации только зоны доступа, относящиеся к компании пользователя. // Метод доступен для: admin, service, bti, ltp_first, device_admin, manager, owner, employee rpc PostAccessZoneRestore(PostAccessZoneRestoreRequest) returns (PostAccessZoneRestoreResponse) { option (google.api.http) = { post: "/access_control/api/v1/access_zone/restore/{id}" }; } } // Зона доступа. // # Описание модели message AccessZone { // Идентификатор зоны доступа. // # Тип: Guid string id = 1; // Наименование. // # Диапазон: 3..64 string title = 2 [(google.api.field_behavior) = REQUIRED]; // Описание. // # Диапазон: 3..200 google.protobuf.StringValue description = 3; // Идентификатор квартирограммы. // # Диапазон: 1..2147483647 int32 flatgramm_id = 4 [(google.api.field_behavior) = REQUIRED]; // Дата создания. // # Тип: DateTime google.protobuf.Timestamp created_at = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; // Дата последнего изменения. // Заполняется и обновляется сервером. // Заполняется при создании и изменении. // Является версией объекта. // # Тип: DateTime google.protobuf.Timestamp changed_at = 6; // Дата удаления. // # Тип: DateTime google.protobuf.Timestamp deleted_at = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; // Идентификаторы точек доступа, входящих в зону. // Все точки доступа должны принадлежать той же квартирограмме, что и зона. // # Тип: Guid. // # Диапазон: 0..1000 repeated string access_point_ids = 8; // Ошибка сохранения. // Эти проверки выполняются при работе с базой данных и сторонними сервисами message SavingError { // Конфликт версий. // Причины: // - В базе хранится другая версия строки, значения changed_at отличаются message Conflict {} // Несовпадение квартирограммы точки доступа. // Причины: // - Точка доступа принадлежит другой квартирограмме — её flatgramm_id не совпадает с flatgramm_id зоны доступа message AccessPointFlatgrammMismatch { // Идентификатор точки доступа с несовпадающей квартирограммой. // # Тип: Guid string access_point_id = 1 [(google.api.field_behavior) = REQUIRED]; // Идентификатор квартирограммы точки доступа. // # Диапазон: 1..2147483647 int32 access_point_flatgramm_id = 2 [(google.api.field_behavior) = REQUIRED]; } // Причина ошибки oneof reason { // Конфликт версий Conflict conflict = 1; // Точка доступа принадлежит другой квартирограмме AccessPointFlatgrammMismatch access_point_flatgramm_mismatch = 2; } } } // Фильтр по зонам доступа message AccessZoneFilter { // По тексту. // Если значение не передано, поиск по нему не производится. // # Диапазон: 3..64. // # Поиск производится по полям: // # - Наименование; // # - Описание google.protobuf.StringValue text = 1; // По идентификаторам квартирограмм repeated int32 flatgramm_ids = 2; // Включать удалённые записи. // Если не передано — удалённые записи не включаются google.protobuf.BoolValue show_deleted = 3; } // Постраничный вывод зон доступа message AccessZonePaging { // Справочник типов значений сортировки. // # Тип: 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 PostAccessZoneRequest { // Зона доступа AccessZone data = 1 [(google.api.field_behavior) = REQUIRED]; } // Ответ на запрос на создание/изменение зоны доступа message PostAccessZoneResponse { // Ошибка запроса сохранения зоны доступа message Error { // Причина ошибки oneof reason { // Ошибка валидации ValidationError validation = 1; // Ошибка сохранения AccessZone.SavingError saving = 2; } } // Тип ответа oneof type { // Зона доступа AccessZone data = 1; // Ошибка Error error = 2; } } // Запрос на получение зоны доступа по идентификатору message GetAccessZoneRequest { // Идентификатор. // # Тип: Guid string id = 1 [(google.api.field_behavior) = REQUIRED]; } // Ответ на запрос получения зоны доступа message GetAccessZoneResponse { // Ошибка запроса получения зоны доступа message Error { // Причина ошибки oneof reason { // Ошибка валидации ValidationError validation = 1; } } // Тип результата oneof type { // Зона доступа AccessZone data = 1; // Ошибка Error error = 2; } } // Запрос на получение списка зон доступа message GetAccessZoneListRequest { // Фильтр AccessZoneFilter filter = 1; // Вариант разбиения на страницы oneof pagination { // Стандартный постраничный вывод AccessZonePaging paging = 2; } } // Ответ на запрос получения списка зон доступа message GetAccessZoneListResponse { // Ошибка запроса получения списка зон доступа message Error { // Причина ошибки oneof reason { // Ошибка валидации ValidationError validation = 1; } } // Тип результата oneof type { // Зона доступа AccessZone data = 1; // Ошибка Error error = 2; } } // Запрос на получение количества зон доступа message GetAccessZoneCountRequest { // Фильтр AccessZoneFilter filter = 1; } // Ответ на запрос получения количества зон доступа message GetAccessZoneCountResponse { // Ошибка запроса получения количества зон доступа message Error { // Причина ошибки oneof reason { // Ошибка валидации ValidationError validation = 1; } } // Тип результата oneof type { // Всего зон доступа int32 data = 1; // Ошибка Error error = 2; } } // Запрос удаления зоны доступа message DeleteAccessZoneRequest { // Идентификатор. // # Тип: Guid string id = 1 [(google.api.field_behavior) = REQUIRED]; } // Ответ на запрос удаления зоны доступа message DeleteAccessZoneResponse { // Ошибка запроса удаления зоны доступа message Error { // Причина ошибки oneof reason { // Ошибка валидации ValidationError validation = 1; } } // Тип результата oneof type { // Ошибка Error error = 1; } } // Запрос разархивации зоны доступа по идентификатору message PostAccessZoneRestoreRequest { // Идентификатор. // # Тип: Guid string id = 1 [(google.api.field_behavior) = REQUIRED]; } // Ответ на запрос разархивации зоны доступа message PostAccessZoneRestoreResponse { // Ошибка запроса разархивации зоны доступа message Error { // Причина ошибки oneof reason { // Ошибка валидации ValidationError validation = 1; } } // Тип результата oneof type { // Ошибка Error error = 1; } }