package cs3.app.registry.v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

App Registry API The App Registry API is meant to as registry that contains mappings between mime types and app providers. The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119. The following are global requirements that apply to all methods: Any method MUST return CODE_OK on a succesful operation. Any method MAY return NOT_IMPLEMENTED. Any method MAY return INTERNAL. Any method MAY return UNKNOWN. Any method MAY return UNAUTHENTICATED.

• rpc AddAppProvider (AddAppProviderRequest, AddAppProviderResponse)

  registry_api.proto:57

  Registers a new app provider to the registry.

• rpc GetAppProviders (GetAppProvidersRequest, GetAppProvidersResponse)

  registry_api.proto:55

  Returns the app providers that are capable of handling this resource info. MUST return CODE_NOT_FOUND if no providers are available.

• rpc GetDefaultAppProviderForMimeType (GetDefaultAppProviderForMimeTypeRequest, GetDefaultAppProviderForMimeTypeResponse)

  registry_api.proto:63

  Returns the default app provider which serves a specified mime type.

• rpc ListAppProviders (ListAppProvidersRequest, ListAppProvidersResponse)

  registry_api.proto:59

  Returns a list of the available app providers known by this registry.

• rpc ListSupportedMimeTypes (ListSupportedMimeTypesRequest, ListSupportedMimeTypesResponse)

  registry_api.proto:61

  Returns a list of the supported mime types along with the apps which they can be opened with.

• rpc SetDefaultAppProviderForMimeType (SetDefaultAppProviderForMimeTypeRequest, SetDefaultAppProviderForMimeTypeResponse)

  registry_api.proto:65

  Sets the default app provider for a specified mime type.

Used as request type in: RegistryAPI.AddAppProvider, gateway.v1beta1.GatewayAPI.AddAppProvider

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

• optional ProviderInfo provider = 2

  REQUIRED. The app provider to be registered.

Used as response type in: RegistryAPI.AddAppProvider, gateway.v1beta1.GatewayAPI.AddAppProvider

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.

Used as request type in: RegistryAPI.GetAppProviders, gateway.v1beta1.GatewayAPI.GetAppProviders

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

• optional storage.provider.v1beta1.ResourceInfo resource_info = 2

  REQUIRED. The resource information.

Used as response type in: RegistryAPI.GetAppProviders, gateway.v1beta1.GatewayAPI.GetAppProviders

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.

• repeated ProviderInfo providers = 3

  REQUIRED. The app providers available for the given resource info.

Used as request type in: RegistryAPI.GetDefaultAppProviderForMimeType, gateway.v1beta1.GatewayAPI.GetDefaultAppProviderForMimeType

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

• string mime_type = 2

  REQUIRED. The mimetype for which the default app has to be returned.

Used as response type in: RegistryAPI.GetDefaultAppProviderForMimeType, gateway.v1beta1.GatewayAPI.GetDefaultAppProviderForMimeType

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.

• optional ProviderInfo provider = 3

  REQUIRED. The default app provider for the specified mime type.

Used as request type in: RegistryAPI.ListAppProviders, gateway.v1beta1.GatewayAPI.ListAppProviders

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

Used as response type in: RegistryAPI.ListAppProviders, gateway.v1beta1.GatewayAPI.ListAppProviders

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.

• repeated ProviderInfo providers = 3

  REQUIRED. The list of app providers this registry knows about.

Used as request type in: RegistryAPI.ListSupportedMimeTypes, gateway.v1beta1.GatewayAPI.ListSupportedMimeTypes

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

Used as response type in: RegistryAPI.ListSupportedMimeTypes, gateway.v1beta1.GatewayAPI.ListSupportedMimeTypes

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.

• repeated MimeTypeInfo mime_types = 3

  REQUIRED. The list of supported mime types and their properties.

Represents a mime type and its corresponding file extension.

Used in: ListSupportedMimeTypesResponse

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

• string mime_type = 2

  REQUIRED. The mime type.

• string ext = 3

  REQUIRED. The file extension mapped to this mime type.

• repeated ProviderInfo app_providers = 4

  REQUIRED. The list of app providers which can open this mime type

• string name = 5

  OPTIONAL. The friendly name of this mime type.

• string description = 6

  OPTIONAL. Human-readable information to describe the mime type.

• string icon = 7

  OPTIONAL. A URI to a static asset which represents the mime type icon.

• bool allow_creation = 8

  OPTIONAL. Whether the mime type is eligible for file creation in the web UI. Defaults to false, i.e. files with this mime type can be opened but not directly created from the web UI.

• string default_application = 9

  OPTIONAL. name of the default application to open this mime type

Represents the information of the app provider.

Used in: AddAppProviderRequest, GetAppProvidersResponse, GetDefaultAppProviderForMimeTypeResponse, ListAppProvidersResponse, MimeTypeInfo, SetDefaultAppProviderForMimeTypeRequest

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

• repeated string mime_types = 2

  REQUIRED. The mimetypes handled by this provider.

• string address = 3

  REQUIRED. The address where the app provider can be reached. For example, localhost:1099.

• ProviderInfo.Capability capability = 4

• string name = 5

  OPTIONAL. A human-readable name of the underlying app.

• string description = 6

  OPTIONAL. Information to describe the functionalities offered by the underlying app. Meant to be read by humans.

• string icon = 7

  OPTIONAL. A URI to a static asset which represents the app icon.

• bool desktop_only = 8

  OPTIONAL. Whether the app can be opened only on desktop

• string action = 9

  OPTIONAL. The action to be displayed to the user on the context menu. By default this is "Open with".

• string product_name = 10

  REQUIRED. The product name of the underlying app, to be used to handle product-specific differences. For example: Collabora, OnlyOffice, Microsoft365 or MicrosoftOfficeOnline

REQUIRED. The capability of the underlying app.

Used in: ProviderInfo

• CAPABILITY_INVALID = 0

• CAPABILITY_VIEWER = 1

  The app is a simple viewer.

• CAPABILITY_EDITOR = 2

  The app is a full editor.

Used as request type in: RegistryAPI.SetDefaultAppProviderForMimeType, gateway.v1beta1.GatewayAPI.SetDefaultAppProviderForMimeType

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

• string mime_type = 2

  REQUIRED. The mimetype for which the default app has to be returned.

• optional ProviderInfo provider = 3

  REQUIRED. The app provider to be marked as default for the specified mime type.

Used as response type in: RegistryAPI.SetDefaultAppProviderForMimeType, gateway.v1beta1.GatewayAPI.SetDefaultAppProviderForMimeType

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.