/*
Спецификация АПИ управления сущностью SafeCityEmergencyFile
*/
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 SafeCityEmergencyFileService {
    // Метод удаления единичной сущности SafeCityEmergencyFile по ключу
    rpc DeleteSafeCityEmergencyFile ( DeleteSafeCityEmergencyFileRequest ) returns ( DeleteSafeCityEmergencyFileResponse ) {
        option (google.api.http) = {
            delete: "/device/api/v1/safe_city/emergency_file/{file_name}"
        };
    }
    // Метод получения списка файлов оповещения.
    // В ответе только массив file_name, необязательный параметр content не присутствует
    rpc GetSafeCityEmergencyFileList ( GetSafeCityEmergencyFileListRequest ) returns ( GetSafeCityEmergencyFileListResponse ) {
        option (google.api.http) = { get: "/device/api/v1/safe_city/emergency_file/list" };
    }
    // Метод загрузки файла на устройство.
    // Syslog: EVENT:000: Upload Emergency File: File size nnn byte: File Duration nnn sec
    rpc SaveSafeCityEmergencyFile ( SaveSafeCityEmergencyFileRequest ) returns ( SaveSafeCityEmergencyFileResponse ) {
        option (google.api.http) = { post: "/device/api/v1/safe_city/emergency_file", body: "*" };
    }
}
// Запрос удаления единичной сущности SafeCityEmergencyFile по ключу
message DeleteSafeCityEmergencyFileRequest {
    // Имя файла
    string file_name = 1 [
        (google.api.field_behavior) = REQUIRED,
        (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"Happy_new_year.wav\"" }
    ];
}
// Ответ на запрос удаления единичной сущности SafeCityEmergencyFile по ключу
message DeleteSafeCityEmergencyFileResponse {
    // Ошибка запроса
    message Error {
        // Причина ошибки
        oneof reason {
            // Ошибка валидации
            ValidationError validation = 1;
        }
    }
    // Тип ответа
    oneof type {
        // Ошибка
        Error error = 1;
    }
}
// Запрос получения списка файлов оповещения
message GetSafeCityEmergencyFileListRequest {
}
// Ответ на запрос получения списка файлов оповещения
message GetSafeCityEmergencyFileListResponse {
    // Список SafeCityEmergencyFile
    repeated SafeCityEmergencyFile data = 1 [
        (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) =
        {example:
            "[{\"file_name\":\"Happy_new_year.wav\"},{\"file_name\":\"Jingle_Bells.wav\"}]"}
    ];
}
// Файл оповещения
message SafeCityEmergencyFile {
    // Имя файла
    string file_name = 1 [
        (google.api.field_behavior) = REQUIRED,
        (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"Happy_new_year.wav\"" }
    ];
    // Тело файла, строка в кодировке Base64.
    // Не возвращается с сервера.
    // TODO: в генерации сваггера не показывать INPUT_ONLY поля в ответах
    bytes content = 2 [
        (google.api.field_behavior) = INPUT_ONLY,
        (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"SGVsbG8gV29ybGQh\"" }
    ];
}
// Запрос загрузки файла на устройство
message SaveSafeCityEmergencyFileRequest {
    // Файл оповещения
    SafeCityEmergencyFile data = 1 [(google.api.field_behavior) = REQUIRED];
}
// Ответ на запрос загрузки файла на устройство
message SaveSafeCityEmergencyFileResponse {
}