CS3 APIs is a set of APIs to interconnect storage, sync and share and application providers in a standard and performant way using gRPC and protocol buffers.

https://cs3org.github.io/cs3apis/

You need to have Go, git and make installed.

$ git clone https://github.com/cernbox/cs3apis
$ make deps # only supported on Darwin and Linux OS.
$ make

This repository contains the interface definitions of public CS3 APIs that support both REST and gRPC protocols. You can also use these definitions with open source tools to generate client libraries, documentation, and other artifacts.

CS3 APIs follows Google API design guidelines, specially on error handling and naming convention. You can read more about these guidelines at https://cloud.google.com/apis/design/.

This repository structure is very similar to https://github.com/googleapis/googleapis.

CS3 APIs use Protocol Buffers version 3 (proto3) as their Interface Definition Language (IDL) to define the API interface and the structure of the payload messages. The same interface definition is used for both REST and RPC versions of the API, which can be accessed over different wire protocols.

There are several ways of accessing CS3 APIs:

1. Protocol Buffers over gRPC: You can access CS3 APIs published in this repository through GRPC, which is a high-performance binary RPC protocol over HTTP/2. It offers many useful features, including request/response multiplex and full-duplex streaming.

2. JSON over HTTP: You can access all CS3 APIs directly using JSON over HTTP, using generated client libraries from the api definitions or or third-party API client libraries.

This repository uses a directory hierarchy that reflects the CS3 feature set. In general, every API has its own root directory, and each major version of the API has its own subdirectory. The proto package names exactly match the directory: this makes it easy to locate the proto definitions and ensures that the generated client libraries have idiomatic namespaces in most programming languages.

NOTE: The major version of an API is used to indicate breaking change to the API.

CS3 APIs are distributed under Apache 2.0 license.