Cloud API

This repo contains the API specification for the proof-of-concept of Sourcegraph Cloud API. See RFC 765 for context. The Cloud API server implementation is being developed in sourcegraph/controller/cmd/apiserver.

This API is only used internally at Sourcegraph - the specification is public for ease of use.

Contents

• cloudapi/v1/: The Cloud API v1 proto specification.
• cmd/: Example programs and utilities.
• go/cloudapi: Generated Go bindings for the Cloud API.

Development

To update or add endpoints, edit cloudapi/v1/cloudapi.proto.

Code generation is configured in buf.yaml and buf.gen.yaml. To update or regenerate the language bindings:

make generate

Note that this will also install tools into ./bin - to remove them for a reinstall, run:

make clean

See cmd/example-client for a simple example of a client connecting to an implementation of the Cloud API.