/*
  Сервис управления обновлениями
*/
syntax = "proto3";

import "google/api/annotations.proto";
import "google/api/field_behavior.proto";
import "deviceapis/device/v1/deviceapis_device_common_v1.proto";
import "protoc-gen-openapiv2/options/annotations.proto";

package deviceapis.device.v1;

option java_package = "ru.deviceapis.device.v1";
option java_outer_classname = "DeviceapisDeviceV1Proto";
option java_multiple_files = false;
option java_string_check_utf8 = true;
option go_package = "/deviceapis_device_v1";
option cc_enable_arenas = true;
option csharp_namespace = "Deviceapis.Device.V1";
option objc_class_prefix = "DEVICEAPISDEVICEV1";
option php_namespace = "Deviceapis\\Device\\V1";
option ruby_package = "Deviceapis::Device::V1";
option optimize_for = LITE_RUNTIME;

// Сервис управления обновлениями
service UpdateService {
  // Скачать прошивку для обновления
  rpc PostUpdateDownload(PostUpdateDownloadRequest) returns (PostUpdateDownloadResponse) {
    option (google.api.http) = {
      post: "/device/api/v1/update/download"
      body: "*"
    };
  }
  // Запустить обновление домофона
  rpc PostUpdateApply(PostUpdateApplyRequest) returns (PostUpdateApplyResponse) {
    option (google.api.http) = {
      post: "/device/api/v1/update/apply"
      body: "*"
    };
  }
}

// Запрос скачивания обновления
message PostUpdateDownloadRequest {
  // Имя FTP папки
  string ftp_path = 1 [
    (google.api.field_behavior) = REQUIRED,
    (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
      example: "\"updates/v2.215.15/\""
    }
  ];
  // Имя файла обновления
  string file_name = 2 [
    (google.api.field_behavior) = REQUIRED,
    (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
      example: "\"firmware01012000.gz\""
    }
  ];
  // Режим обновления
  string update_mode = 3 [
    (google.api.field_behavior) = REQUIRED,
    (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
      example: "\"full_override_update\""
    }
  ];
}

// Ответ на запрос скачивания обновления
message PostUpdateDownloadResponse {
  // Ошибка запроса
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка валидации
      ValidationError validation = 1;
    }
  }
  // Тип ответа
  oneof type {
    // Ошибка
    Error error = 1;
  }
}

// Запрос применения обновления
message PostUpdateApplyRequest {}

// Ответ на запрос применения обновления
message PostUpdateApplyResponse {}