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.app.registry.v1beta1;

option csharp_namespace = "Cs3.App.Registry.V1Beta1";
option go_package = "registryv1beta1";
option java_multiple_files = true;
option java_outer_classname = "ResourcesProto";
option java_package = "com.cs3.app.registry.v1beta1";
option objc_class_prefix = "CAR";
option php_namespace = "Cs3\\App\\Registry\\V1Beta1";

import "cs3/types/v1beta1/types.proto";

// Represents the information of the app provider.
message ProviderInfo {
  // OPTIONAL.
  // Opaque information.
  cs3.types.v1beta1.Opaque opaque = 1;
  // REQUIRED.
  // The mimetypes handled by this provider.
  repeated string mime_types = 2;
  // REQUIRED.
  // The address where the app provider can be reached.
  // For example, tcp://localhost:1099.
  string address = 3;
  // OPTIONAL.
  // A human-readable name of the app provider.
  string name = 4;
  // OPTIONAL.
  // Information to describe the functionalities
  // offered by the app provider. Meant to be read
  // by humans.
  string description = 5;
  // OPTIONAL.
  // A URI to a static asset which represents the app icon.
  string icon = 6;
  // OPTIONAL.
  // Whether the app can be opened only on desktop
  bool desktop_only = 7;
}

// Holds a list of app providers which can open a particular mime type.
message AppProviderList {
  repeated ProviderInfo app_providers = 1;
}