resources.proto

// Copyright 2018-2019 CERN
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// In applying this license, CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.

syntax = "proto3";

package cs3.ocm.provider.v1beta1;

option csharp_namespace = "Cs3.Ocm.Provider.V1Beta1";
option go_package = "providerv1beta1";
option java_multiple_files = true;
option java_outer_classname = "ResourcesProto";
option java_package = "com.cs3.ocm.provider.v1beta1";
option objc_class_prefix = "COP";
option php_namespace = "Cs3\\Ocm\\Provider\\V1Beta1";

//  Identifier for various types of services offered by sync'n'share system providers.
message ServiceType {
  // REQUIRED
  // The name of the service type.
  string name = 1;
  // REQUIRED
  // The description of the service type.
  string description = 2;
}

// The endpoints exposed by particular services.
message ServiceEndpoint {
  // REQUIRED.
  // The type of service.
  ServiceType type = 1;
  // REQUIRED.
  // The name of the service.
  string name = 2;
  // REQUIRED.
  // The path at which the service is hosted.
  string path = 3;
  // OPTIONAL.
  // Whether the service is monitored.
  bool is_monitored = 4;
  // OPTIONAL.
  // Additional properties about the service.
  map<string, string> properties = 5;
}

// The services offered by sync'n'share system providers.
message Service {
  // REQUIRED.
  // The URL at which the service is hosted.
  string host = 1;
  // REQUIRED.
  // The primary endpoint of the service.
  ServiceEndpoint endpoint = 2;
  // REQUIRED.
  // The API version of the provided service.
  string api_version = 3;
  // OPTIONAL.
  // Additional endpoints at which the service is exposed.
  repeated ServiceEndpoint additional_endpoints = 4;
}

// Details of the sync'n'share system provider.
message ProviderInfo {
  // REQUIRED.
  // The name of the provider.
  string name = 1;
  // REQUIRED.
  // The full name of the provider.
  string full_name = 2;
  // OPTIONAL.
  // A description of the provider.
  string description = 3;
  // OPTIONAL.
  // The organization to which the provider belongs.
  string organization = 4;
  // REQUIRED.
  // The domain of the sync'n'share provider.
  string domain = 5;
  // OPTIONAL.
  // The homepage of the provider.
  string homepage = 6;
  // OPTIONAL.
  // The email at which the provider can be reached.
  string email = 7;
  // REQUIRED.
  // The list of services provided by the provider.
  repeated Service services = 8;
  // OPTIONAL.
  // Additional properties about the service.
  map<string, string> properties = 9;
}