package cs3.ocm.incoming.v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

OCM Incoming API The OCM Incoming API is used to persist in the local system the incoming remote shares that are sent via the Open Cloud Mesh (OCM) sharing protocol. Implementations are expected to expose the `/ocm` endpoints according to the OCM API, and in response to those endpoints call the following API. Support for multi-protocol shares is included, if the remote sender supplies a multi-protocol share. 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 CreateOCMIncomingShare (CreateOCMIncomingShareRequest, CreateOCMIncomingShareResponse)

  ocm_incoming_api.proto:60

  Creates a new OCM share in response to a call from remote to `/ocm/shares`. See: https://cs3org.github.io/OCM-API/docs.html?branch=v1.2.0&repo=OCM-API&user=cs3org#/paths/~1shares/post

• rpc DeleteOCMIncomingShare (DeleteOCMIncomingShareRequest, DeleteOCMIncomingShareResponse)

  ocm_incoming_api.proto:66

  Deletes an OCM share in response to a notification from remote to `/ocm/notifications`. See: https://cs3org.github.io/OCM-API/docs.html?branch=v1.2.0&repo=OCM-API&user=cs3org#/paths/~1notifications/post

• rpc UpdateOCMIncomingShare (UpdateOCMIncomingShareRequest, UpdateOCMIncomingShareResponse)

  ocm_incoming_api.proto:63

  Updates an OCM share in response to a notification from remote to `/ocm/notifications`. See: https://cs3org.github.io/OCM-API/docs.html?branch=v1.2.0&repo=OCM-API&user=cs3org#/paths/~1notifications/post

Used as request type in: gateway.v1beta1.GatewayAPI.CreateOCMIncomingShare, OcmIncomingAPI.CreateOCMIncomingShare

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

• string description = 2

  OPTIONAL. Description for the share.

• string name = 3

  REQUIRED. Name of the resource (file or folder).

• string resource_id = 4

  REQUIRED. Identifier to identify the resource at the provider side. This is unique per provider.

• optional identity.user.v1beta1.UserId owner = 5

  REQUIRED. Provider specific identifier of the owner of the resource.

• optional identity.user.v1beta1.UserId sender = 6

  REQUIRED. Provider specific identifier of the user that wants to share the resource.

• optional identity.user.v1beta1.UserId share_with = 7

  REQUIRED. Consumer specific identifier of the user or group the provider wants to share the resource with. This is known in advance, for example using the OCM invitation flow. Please note that the consumer service endpoint is known in advance as well, so this is no part of the request body. TODO: this field needs to represent either a user or group in the future, not only a user.

• storage.provider.v1beta1.ResourceType resource_type = 8

  REQUIRED. Resource type. Deprecated: a resource might not always be a storage resource, use shared_resource_type instead.

• sharing.ocm.v1beta1.ShareType share_type = 9

  REQUIRED. Recipient share type. Deprecated: use recipient_type instead.

• optional types.v1beta1.Timestamp expiration = 10

  OPTIONAL. The expiration time for the OCM share.

• repeated sharing.ocm.v1beta1.Protocol protocols = 11

  REQUIRED. The protocols which are used to establish synchronisation, with their access rights. See also cs3/sharing/ocm/v1beta1/resources.proto for how to map this to the OCM share payload.

• string code = 12

  OPTIONAL. A nonce to be exchanged for a (potentially short-lived) bearer token. Deprecated in OCM 1.3.

• sharing.ocm.v1beta1.SharedResourceType shared_resource_type = 13

  REQUIRED. Shared resource type.

• sharing.ocm.v1beta1.RecipientType recipient_type = 14

  REQUIRED. Recipient type, e.g. user or group.

Used as response type in: gateway.v1beta1.GatewayAPI.CreateOCMIncomingShare, OcmIncomingAPI.CreateOCMIncomingShare

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.

• string id = 3

  REQUIRED. Unique ID to identify the share at the consumer side.

• optional types.v1beta1.Timestamp created = 4

  REQUIRED.

Used as request type in: gateway.v1beta1.GatewayAPI.DeleteOCMIncomingShare, OcmIncomingAPI.DeleteOCMIncomingShare

• string id = 1

  REQUIRED. Unique ID to identify the share at the consumer side.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.

Used as response type in: gateway.v1beta1.GatewayAPI.DeleteOCMIncomingShare, OcmIncomingAPI.DeleteOCMIncomingShare

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.

Used as request type in: gateway.v1beta1.GatewayAPI.UpdateOCMIncomingShare, OcmIncomingAPI.UpdateOCMIncomingShare

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

• string ocm_share_id = 2

  REQUIRED. Unique ID to identify the share at the consumer side.

• string description = 3

  OPTIONAL. Description for the share.

• sharing.ocm.v1beta1.ShareType share_type = 5

  OPTIONAL. Recipient share type. Deprecated: use recipient_type instead.

• optional types.v1beta1.Timestamp expiration = 6

  OPTIONAL. The expiration time for the OCM share.

• repeated sharing.ocm.v1beta1.Protocol protocols = 7

  OPTIONAL. The protocols which are used to establish synchronisation, with their access rights.

• sharing.ocm.v1beta1.RecipientType recipient_type = 8

  OPTIONAL. Recipient type.

Used as response type in: gateway.v1beta1.GatewayAPI.UpdateOCMIncomingShare, OcmIncomingAPI.UpdateOCMIncomingShare

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.