/*
  Сервис синхронизации с Dadata
*/
syntax = "proto3";

import "google/api/annotations.proto";
import "google/api/field_behavior.proto";

package keyapis.dadata.v1;

option java_package = "ru.keyapis.dadata.v1";
option java_outer_classname = "KeyapisDadataV1Proto";
option java_multiple_files = false;
option java_string_check_utf8 = true;
option go_package = "/keyapis_dadata_v1";
option cc_enable_arenas = true;
option csharp_namespace = "Keyapis.Dadata.V1";
option objc_class_prefix = "KEYAPISDADATAV1";
option php_namespace = "Keyapis\\Dadata\\V1";
option ruby_package = "Keyapis::Dadata::V1";
option optimize_for = LITE_RUNTIME;

// Сервис синхронизации с Dadata
service DaDataSyncService {
  // Метод синхронизации дома по ОРПОНу.
  // Метод доступен для: admin, service
  rpc PostSyncOrpon(PostSyncOrponRequest) returns (PostSyncOrponResponse) {
    option (google.api.http) = {
      post: "/dadata/api/v1/sync/orpon/{orpon}"
    };
  }
}

// Запрос синхронизации дома по ОРПОНу
message PostSyncOrponRequest {
  // ОРПОН дома.
  // # Диапазон: 1..9223372036854775807
  int64 orpon = 1 [(google.api.field_behavior) = REQUIRED];
}

// Ответ на запрос синхронизации дома по ОРПОНу
message PostSyncOrponResponse {
  // Ошибка
  message Error {
    // Причина ошибки
    oneof reason {
      // Ошибка валидации
      ValidationError validation = 1;
    }
  }
  // Тип результата
  oneof type {
    // Ошибка
    Error error = 1;
  }
}

// Ошибки валидации.
// Эти проверки выполняются до обращения в базу данных
message ValidationError {
  // Путь к полю в формате наименования прото
  string path = 1 [(google.api.field_behavior) = REQUIRED];
  // Валидационное сообщение
  string message = 2 [(google.api.field_behavior) = REQUIRED];
}