/*
Сервис управления настройками кодов доступа
*/
syntax = "proto3";
package deviceapis.device.v1;
import "deviceapis/device/v1/deviceapis_device_common_v1.proto";
import "google/api/annotations.proto";
import "google/api/field_behavior.proto";
import "protoc-gen-openapiv2/options/annotations.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Deviceapis.Device.V1";
option go_package = "/deviceapis_device_v1";
option java_multiple_files = false;
option java_outer_classname = "DeviceapisDeviceV1Proto";
option java_package = "ru.deviceapis.device.v1";
option java_string_check_utf8 = true;
option objc_class_prefix = "DEVICEAPISDEVICEV1";
option optimize_for = LITE_RUNTIME;
option php_namespace = "Deviceapis\\Device\\V1";
option ruby_package = "Deviceapis::Device::V1";
// Сервис управления настройками кодов доступа
service CodeService {
    // Метод удаления одного кода доступа
    rpc DeleteCode ( DeleteCodeRequest ) returns ( DeleteCodeResponse ) {
        option (google.api.http) = { delete: "/device/api/v1/code/{code}" };
    }
    // Метод удаления списка кодов доступа
    rpc DeleteCodeList ( DeleteCodeListRequest ) returns ( DeleteCodeListResponse ) {
        option (google.api.http) = { delete: "/device/api/v1/code/list" };
    }
    // Метод получения кода доступа
    rpc GetCode ( GetCodeRequest ) returns ( GetCodeResponse ) {
        option (google.api.http) = { get: "/device/api/v1/code/{code}" };
    }
    // Метод получения количества кодов доступа
    rpc GetCodeCount ( GetCodeCountRequest ) returns ( GetCodeCountResponse ) {
        option (google.api.http) = { get: "/device/api/v1/code/count" };
    }
    // Метод получения списка кодов доступа
    rpc GetCodeList ( GetCodeListRequest ) returns ( GetCodeListResponse ) {
        option (google.api.http) = { get: "/device/api/v1/code/list" };
    }
    // Метод создания кода доступа
    rpc SaveCode ( SaveCodeRequest ) returns ( SaveCodeResponse ) {
        option (google.api.http) = { post: "/device/api/v1/code", body: "*" };
    }
    // Метод создания списка кодов доступа
    rpc SaveCodeList ( SaveCodeListRequest ) returns ( SaveCodeListResponse ) {
        option (google.api.http) = { post: "/device/api/v1/code/list", body: "*" };
    }
}
// Код доступа
message Code {
    // Ошибки сохранения
    message SavingError {
        // Реле не найдено
        message RelayNotFound {
        }
        // Причина ошибки
        oneof reason {
            // Реле не найдено
            RelayNotFound relay_not_found = 1;
        }
    }
    // Код доступа
    string code = 1 [
        (google.api.field_behavior) = REQUIRED,
        (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "456778", max_length: 100 }
    ];
    // Описание
    string description = 2 [
        (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"Номер 45\"", max_length: 100 }
    ];
    // Идентификаторы реле.
    // Диапазон: 1..64
    repeated int32 relay_indexes = 3;
}
// Постраничный вывод
message CodePaging {
    // Количество записей на страницу.
    // Если значение 0 (не передано), то будет взято значение по умолчанию.
    // # Диапазон: 0..100.
    // # По умолчанию: 20
    int32 limit = 1;
    // Сдвиг.
    // # Диапазон: 0..2147483647
    int32 offset = 2;
}
// Запрос удаления списка кодов доступа
message DeleteCodeListRequest {
}
// Ответ на запрос удаления списка кодов доступа
message DeleteCodeListResponse {
    // Тип ответа
    oneof type {
        // Всего количество удаленных
        int32 data = 1;
    }
}
// Запрос удаления одного кода доступа
message DeleteCodeRequest {
    // Код доступа
    string code = 1 [
        (google.api.field_behavior) = REQUIRED,
        (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "456778", max_length: 100 }
    ];
}
// Ответ на запрос удаления одного кода доступа
message DeleteCodeResponse {
    // Ошибка запроса
    message Error {
        // Причина ошибки
        oneof reason {
            // Ошибка валидации
            ValidationError validation = 1;
        }
    }
    // Тип ответа
    oneof type {
        // Ошибка
        Error error = 1;
    }
}
// Запрос получения количества кодов доступа
message GetCodeCountRequest {
}
// Ответ на запрос получения количества кодов доступа
message GetCodeCountResponse {
    // Тип ответа
    oneof type {
        // Всего количество
        int32 data = 1;
    }
}
// Запрос получения списка кодов доступа
message GetCodeListRequest {
    // Вариант разбиения на страницы
    oneof pagination {
        // Постраничный вывод
        CodePaging paging = 1;
    }
}
// Ответ на запрос получения списка кодов доступа
message GetCodeListResponse {
    // Список Code
    repeated Code data = 1;
}
// Запрос получения получения кода доступа
message GetCodeRequest {
    // Код доступа
    string code = 1 [
        (google.api.field_behavior) = REQUIRED,
        (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "456778", max_length: 100 }
    ];
}
// Ответ на запрос получения получения кода доступа
message GetCodeResponse {
    // Тип ответа
    oneof type {
        // Код доступа
        Code data = 1;
    }
}
// Запрос на создание списка кодов доступа
message SaveCodeListRequest {
    // Список Code
    repeated Code data = 1;
}
// Ответ на создание списка кодов доступа
message SaveCodeListResponse {
    // Ошибка запроса
    message Error {
        // Код доступа
        string code = 1 [
            (google.api.field_behavior) = REQUIRED,
            (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "456778", max_length: 100 }
        ];
        // Причина ошибки
        oneof reason {
            // Ошибка валидации
            ValidationError validation = 2;
            // Ошибка сохранения
            Code.SavingError saving = 3;
        }
    }
    // Список Code
    repeated Code data = 1;
    // Список ошибок
    repeated Error errors = 2;
}
// Запрос создания кода доступа
message SaveCodeRequest {
    // Код доступа
    Code data = 1 [(google.api.field_behavior) = REQUIRED];
}
// Ответ на запрос создания кода доступа
message SaveCodeResponse {
    // Ошибка запроса
    message Error {
        // Причина ошибки
        oneof reason {
            // Ошибка валидации
            ValidationError validation = 1;
            // Ошибка сохранения
            Code.SavingError saving = 2;
        }
    }
    // Тип ответа
    oneof type {
        // Код доступа
        Code data = 1;
        // Ошибка
        Error error = 2;
    }
}