/*
Сервис управления настройками FTP
*/
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 "google/protobuf/field_mask.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";
// Сервис управления настройками FTP
service FtpService {
    // Метод редактирования настроек FTP
    rpc EditFtp ( EditFtpRequest ) returns ( EditFtpResponse ) {
        option (google.api.http) = { patch: "/device/api/v1/ftp", body: "data" };
    }
    // Метод получения настроек FTP
    rpc GetFtp ( GetFtpRequest ) returns ( GetFtpResponse ) {
        option (google.api.http) = { get: "/device/api/v1/ftp" };
    }
    // Создать бэкап и положить на FTP папку
    rpc PostFtpBackup ( PostFtpBackupRequest ) returns ( PostFtpBackupResponse ) {
        option (google.api.http) = { post: "/device/api/v1/ftp/backup", body: "*" };
    }
    // Скачать бэкап из FTP папки и применить
    rpc PostFtpBackupApply ( PostFtpBackupApplyRequest ) returns ( PostFtpBackupApplyResponse ) {
        option (google.api.http) = { post: "/device/api/v1/ftp/backup/apply", body: "*" };
    }
}
// Запрос редактирования настроек FTP
message EditFtpRequest {
    // Настройки FTP
    Ftp data = 1 [(google.api.field_behavior) = REQUIRED];
    // Маска полей обновления
    google.protobuf.FieldMask update_mask = 2;
}
// Ответ на запрос редактирования настроек FTP
message EditFtpResponse {
    // Ошибка запроса
    message Error {
        // Причина ошибки
        oneof reason {
            // Ошибка валидации
            ValidationError validation = 1;
        }
    }
    // Тип ответа
    oneof type {
        // Настройки FTP
        Ftp data = 1;
        // Ошибка
        Error error = 2;
    }
}
// Настройки FTP
message Ftp {
    // Адрес FTP сервера.
    // Сетевой адрес и порт.
    // Пример: 192.168.0.1:21, ftp.acme.io:21
    string reg_server_address = 1 [
        (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"ftp.acme.io:21\"", min_length: 5 }
    ];
    // Логин
    string login = 2 [
        (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"admin\"" }
    ];
    // Пароль.
    // Не возвращается с сервера.
    // TODO: в генерации сваггера не показывать INPUT_ONLY поля в ответах
    string password = 3 [
        (google.api.field_behavior) = INPUT_ONLY,
        (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"pwd_admin\"" }
    ];
}
// Запрос получения настроек FTP
message GetFtpRequest {
}
// Ответ на запрос получения настроек FTP
message GetFtpResponse {
    // Тип ответа
    oneof type {
        // Настройки FTP
        Ftp data = 1;
    }
}
// Запрос применения бекапа
message PostFtpBackupApplyRequest {
    // Имя FTP папки
    string ftp_path = 1 [
        (google.api.field_behavior) = REQUIRED,
        (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"backups/annual\"" }
    ];
    // Имя файла бекапа
    string file_name = 2 [
        (google.api.field_behavior) = REQUIRED,
        (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"backup01012000.gz\"" }
    ];
    // Опции восстановления
    string restore_options = 3 [
        (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"after_reboot\"" }
    ];
}
// Ответ на запрос применения бекапа
message PostFtpBackupApplyResponse {
    // Ошибка запроса создания бекапа
    message Error {
        // Причина ошибки
        oneof reason {
            // Ошибка валидации
            ValidationError validation = 1;
        }
    }
    // Тип ответа
    oneof type {
        // Ошибка
        Error error = 1;
    }
}
// Запрос создания бекапа
message PostFtpBackupRequest {
    // Имя FTP папки
    string ftp_path = 1 [
        (google.api.field_behavior) = REQUIRED,
        (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"backups/annual\"" }
    ];
    // Имя файла бекапа
    string file_name = 2 [
        (google.api.field_behavior) = REQUIRED,
        (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"backup01012000.gz\"" }
    ];
    // Тип бекапа
    string backup_type = 3 [
        (google.api.field_behavior) = REQUIRED,
        (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"annual\"" }
    ];
}
// Ответ на запрос создания бекапа
message PostFtpBackupResponse {
    // Ошибка запроса создания бекапа
    message Error {
        // Причина ошибки
        oneof reason {
            // Ошибка валидации
            ValidationError validation = 1;
        }
    }
    // Тип ответа
    oneof type {
        // Ошибка
        Error error = 1;
    }
}