/* Сервис реализует функционал управления технологическими планами(ТП). ТП это подготовленный набор доступных услуг */ syntax = "proto3"; import "google/api/annotations.proto"; import "google/api/field_behavior.proto"; import "google/protobuf/descriptor.proto"; import "google/protobuf/wrappers.proto"; import "google/protobuf/timestamp.proto"; import "keyapis/subscription/v1/keyapis_subscription_privilege_v1.proto"; package keyapis.subscription.v1; option java_package = "ru.keyapis.subscription.v1"; option java_outer_classname = "KeyapisSubscriptionV1Proto"; option java_multiple_files = false; option java_string_check_utf8 = true; option go_package = "/keyapis_subscription_v1"; option cc_enable_arenas = true; option csharp_namespace = "Keyapis.Subscription.V1"; option objc_class_prefix = "KEYAPISSUBSCRIPTIONV1"; option php_namespace = "Keyapis\\Subscription\\V1"; option ruby_package = "Keyapis::Subscription::V1"; option optimize_for = LITE_RUNTIME; // Сервис технологических планов(ТП) service PlanService { // Метод получения технологического плана. // Метод доступен для: admin, mrf, master, ltp_first, service, application(subscription:read или subscription:edit) rpc GetPlan(GetPlanRequest) returns (GetPlanResponse) { option (google.api.http) = { get: "/subscription/api/v1/plan/{id}" }; } // Метод получения списка технологических планов. // Метод доступен для: admin, service, mrf, master, ltp_first, service, application(subscription:read или subscription:edit) rpc GetPlanList(GetPlanListRequest) returns (stream GetPlanListResponse) { option (google.api.http) = { get: "/subscription/api/v1/plan/list" }; } // Метод получения количества технологических планов. // Метод доступен для: admin, service, mrf, master, ltp_first, service, application(subscription:read или subscription:edit) rpc GetPlanCount(GetPlanCountRequest) returns (GetPlanCountResponse) { option (google.api.http) = { get: "/subscription/api/v1/plan/count" }; } } // Технологический план(ТП) message Plan { // Идентификатор int32 id = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Название string title = 2 [(google.api.field_behavior) = REQUIRED]; // Описание google.protobuf.StringValue description = 3; // Дата создания записи. // Заполняется сервером google.protobuf.Timestamp created_at = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; // Дата последнего изменения. // Заполняется и обновляется сервером. // Заполняется при создании и изменении. // Является версией объекта google.protobuf.Timestamp changed_at = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; // Идентификаторы родительских технологических планов(ТП) repeated int32 parent_ids = 6; // Идентификаторы регионов, в которых доступен технологический план(ТП) repeated int32 rf_ids = 7; // Краткое описание google.protobuf.StringValue summary = 8; // Справочник типов иконок enum IconType { // Значение не указано ICON_TYPE_UNKNOWN = 0; // Быстро FAST = 1; // Распознавание лиц FACE_REC = 2; // Безопасно SAFE = 3; } // Тип иконки IconType icon_type = 9; // Описание опции message OptionDescription { // Тип иконки IconType icon_type = 1; // Название string title = 2 [(google.api.field_behavior) = REQUIRED]; // Краткое описание google.protobuf.StringValue summary = 3; } // Описание опций repeated OptionDescription option_descriptions = 10; // Привилегии. // Массив услуг доступных по технологическому плану repeated keyapis.subscription.v1.Privilege.Type privilege_types = 11; } // Фильтр по технологическим планам message PlanFilter { // По тексту. // Если значение не передано то поиск по нему не производится. // # Поиск производится по полям: // # - Название; // # - Описание; // # - Краткое описание google.protobuf.StringValue text = 1; // По идентификаторам регионов repeated int32 rf_ids = 2; // Ошибки валидации фильтра по технологическим планам. // Эти проверки выполняются до обращения в базу данных message ValidationError { // Причины: // - Длина текста < 3 символов и >= 64 message TextInvalid {} // Причина ошибки oneof reason { // Текст передан некорректно TextInvalid text = 1; } } } // Пагинация по технологическим планам message PlanPaging { // Справочник типов значений сортировки enum OrderByType { // Значение не указано ORDER_BY_TYPE_UNKNOWN = 0; // По идентификатору ID = 1; } // Тип значения сортировки. // По умолчанию: ID OrderByType order_by_type = 1; // Справочник типов направлений сортировки enum DirectionType { // Значение не указано DIRECTION_TYPE_UNKNOWN = 0; // От большего к меньшему DESC = 1; // От меньшего к большему ASC = 2; } // Тип направления сортировки. // По умолчанию: DESC DirectionType direction_type = 2; // Количество записей на страницу. // Минимальное значение: 1. // Максимальное значение: 100. // По умолчанию: 20. // Если значение 0 (не передано), то выставляем значение по умолчанию int32 limit = 3; // Сдвиг. // По умолчанию: 0 int32 offset = 4; // Ошибка валидации постраничной пагинации по технологическим планам. // Эти проверки выполняются до обращения в базу данных message ValidationError { // Причины: // - Значение количества < 0 или > 100 message LimitInvalid {} // Причины: // - Значение сдвига < 0 message OffsetInvalid {} // Причина ошибки oneof reason { // Количество передано некорректно LimitInvalid limit = 1; // Сдвиг передан некорректно OffsetInvalid offset = 2; } } } // Запрос получения технологического плана message GetPlanRequest { // Идентификатор int32 id = 1 [(google.api.field_behavior) = REQUIRED]; } // Ответ на запрос получения технологического плана message GetPlanResponse { // Тип результата oneof type { // Технологический план Plan data = 1; } } // Запрос получения технологических планов message GetPlanListRequest { // Фильтр PlanFilter filter = 1 [(google.api.field_behavior) = REQUIRED]; // Вариант разбиения на страницы oneof pagination { // Пагинация PlanPaging paging = 2; } } // Ответ на запрос получения технологических планов message GetPlanListResponse { // Ошибка запроса получения технологических планов message Error { // Причина ошибки oneof reason { // Ошибка фильтрации PlanFilter.ValidationError plan_filter_validation = 1; // Ошибка пагинации по страницам PlanPaging.ValidationError plan_paging_validation = 2; } } // Тип результата oneof type { // Технологический план Plan data = 1; // Ошибка Error error = 2; } } // Запрос получения количества технологических планов message GetPlanCountRequest { // Фильтр PlanFilter filter = 1; } // Ответ на запрос получения количества технологических планов message GetPlanCountResponse { // Ошибка запроса получения количества технологических планов message Error { // Причина ошибки oneof reason { // Ошибка фильтрации PlanFilter.ValidationError plan_filter_validation = 1; } } // Тип результата oneof type { // Всего технологических планов int32 data = 1; // Ошибка Error error = 2; } }