CS3 APIs (gRPC)
The gRPC APIs that the reva services implement.
The CS3 APIs are the protocol between all reva services. They are Protocol Buffers definitions, so you can write clients and services in any language that gRPC supports.
- API reference on the Buf Schema Registry
- Source of the definitions
- Generated client libraries: Go, Python, JavaScript
Main APIs
| API | Package | Served by |
|---|---|---|
| Gateway | cs3.gateway.v1beta1 | gateway |
| Storage provider | cs3.storage.provider.v1beta1 | storageprovider |
| Storage registry | cs3.storage.registry.v1beta1 | storageregistry |
| Auth provider | cs3.auth.provider.v1beta1 | authprovider |
| Users | cs3.identity.user.v1beta1 | userprovider |
| Groups | cs3.identity.group.v1beta1 | groupprovider |
| Collaboration (shares) | cs3.sharing.collaboration.v1beta1 | usershareprovider |
| Public links | cs3.sharing.link.v1beta1 | publicshareprovider |
| OCM | cs3.sharing.ocm.v1beta1 | ocmshareprovider |
| App provider | cs3.app.provider.v1beta1 | appprovider |
Clients call the gateway, which forwards to the providers. Run revad with enable_reflection = true in [grpc] to explore a running server with tools such as grpcurl.