/*
  Сервис реализует функционал управления связями точек доступа и групп
*/
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 AccessPointGroupService {
  // Метод получения списка связей точек доступа и групп.
  // Метод доступен для: admin, service, bti
  rpc GetAccessPointGroupList(GetAccessPointGroupListRequest) returns (stream GetAccessPointGroupListResponse) {
    option (google.api.http) = {
      get : "/access_control/api/v1/access_point/group/list"
    };
  }
  // Метод получения количества связей точек доступа и групп.
  // Метод доступен для: admin, service, bti
  rpc GetAccessPointGroupCount(GetAccessPointGroupCountRequest) returns (GetAccessPointGroupCountResponse) {
    option (google.api.http) = {
      get : "/access_control/api/v1/access_point/group/count"
    };
  }
  // Метод создания связи точки доступа и группы.
  // Метод доступен для: admin, service, bti
  rpc PutAccessPointGroupAttach(PutAccessPointGroupAttachRequest) returns (PutAccessPointGroupAttachResponse) {
    option (google.api.http) = {
      put: "/access_control/api/v1/access_point/{access_point_group.access_point_id}/group/{access_point_group.group_id}/attach"
    };
  }
  // Метод удаления связи точки доступа и группы.
  // Метод доступен для: admin, service, bti
  rpc PutAccessPointGroupDetach(PutAccessPointGroupDetachRequest) returns (PutAccessPointGroupDetachResponse) {
    option (google.api.http) = {
      put: "/access_control/api/v1/access_point/{access_point_group.access_point_id}/group/{access_point_group.group_id}/detach"
    };
  }
}

// Связка точки доступа и группы.
// # Описание модели
message AccessPointGroup {
  // Идентификатор точки доступа.
  // # Тип: Guid
  string access_point_id = 1 [(google.api.field_behavior) = REQUIRED];
  // Идентификатор группы.
  // # Тип: Guid
  string group_id = 2 [(google.api.field_behavior) = REQUIRED];
}

// Фильтр по связям точек доступа и групп
message AccessPointGroupFilter {
  // По идентификаторам точки доступа.
  // # Тип: Guid
  repeated string access_point_ids = 1;
  // По идентификаторам группы.
  // # Тип: Guid
  repeated string group_ids = 2;
}
// Постраничный вывод
message AccessPointGroupPaging {
  // Справочник типов значений сортировки.
  // # Тип: byte
  enum OrderByType {
    // Значение не указано
    ORDER_BY_TYPE_UNKNOWN = 0;
    // По идентификатору группы
    GROUP_ID = 1;
    // По идентификатору точки доступа
    ACCESS_POINT_ID = 2;
    // По дате создания
    CREATED_AT = 3;
  }
  // Тип значения сортировки.
  // Если значение не передано, то будет взято значение по умолчанию.
  // # По умолчанию: GROUP_ID
  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 GetAccessPointGroupListRequest {
  // Фильтр
  AccessPointGroupFilter filter = 1;
  // Вариант разбиения на страницы
  oneof pagination {
    // Стандартный постраничный вывод
    AccessPointGroupPaging paging = 2;
  }
}
// Ответ на получение списка связей точек доступа и групп
message GetAccessPointGroupListResponse {
  // Ошибка запроса получения списка связей точек доступа и групп
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка валидации
      ValidationError validation = 1;
    }
  }
  // Тип результата
  oneof type {
    // Связь точки доступа и группы
    AccessPointGroup data = 1;
    // Ошибка
    Error error = 2;
  }
}

// Запрос получения количества связей точек доступа и групп
message GetAccessPointGroupCountRequest {
  // Фильтр
  AccessPointGroupFilter filter = 1;
}
// Ответ на запрос получения количества точек доступа
message GetAccessPointGroupCountResponse {
  // Ошибка запроса получения количества точек доступа
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка валидации
      ValidationError validation = 1;
    }
  }
  // Тип результата
  oneof type {
    // Всего точек доступа
    int32 data = 1;
    // Ошибка
    Error error = 2;
  }
}

// Запрос создания связи точки доступа и группы
message PutAccessPointGroupAttachRequest {
  // Связь точки доступа и группы
  AccessPointGroup access_point_group = 1 [(google.api.field_behavior) = REQUIRED];
}
  // Ответ на запрос сохранения связи точки доступа и группы
message PutAccessPointGroupAttachResponse {
  // Ошибка запроса на создание связи точки доступа и группы
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка валидации
      ValidationError validation = 1;
     }
  }
  // Тип результата
  oneof type {
    // Ошибка
     Error error = 1;
  }
}

// Запрос удаления связи точки доступа и группы
message PutAccessPointGroupDetachRequest {
  // Связь точки доступа и группы
  AccessPointGroup access_point_group = 1 [(google.api.field_behavior) = REQUIRED];
}
// Ответ на запрос удаления связи точки доступа и группы
message PutAccessPointGroupDetachResponse {
  // Ошибка запроса на удаление связи точки доступа и группы
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка валидации
      ValidationError validation = 1;
     }
  }
  // Тип результата
  oneof type {
    // Ошибка
     Error error = 1;
  }
}