5992b0f614
* Update go dependencies * Update S3 * Caddy plugins cannot use 1.22 * Update controller runtime signatures * Update webhook suite test * Update IPFS signatures * Update go modules * Update ipfs-cluster to v1.0.8 * Fix node-labeler build * Fix IPFS CID parsing * Update ipfs-cluster version * Update controller-runtime signature * Update statefulset signature * Disable controller-runtime metrics * Add comments
Public API Server
⚠️ Public API is currently experimental and under development. We will provide public announcements once maturity of the API moves into alpha/beta and stable.
This component holds implementation of Gitpod's public API. API specification for this server can be found in public-api.
Motivation
As more companies and engineers embrace cloud development environments, the need for a first class, managed and versioned API will grow. Providing a first class Public API enabled the community to build on top of Gitpod, automate and orchestrate use cases beyond the core focus of Gitpod. The API will act as a catalyst to further reduce toil from development environments and will enable richer integrations with Integrated Development Environments (IDEs) and platforms.
Goal
- Provide a first class Public API which is the canonical way to access Gitpod functionality programatically
- Offer a versioned API with compatibility guarantees and clear upgrade path
- Enable, and catalyze, community integrations and workflows beyond what Gitpod offers today
Usage
The public API will initially be offered as a gRPC service. Clients for various languages will be available. At the moment, the API is in early stages and clients are not available.
Architecture
- The API will be exposed on
api.gitpod.ioorapi.<domain>for Dedicated installations. - The API is structured into services with definitions available in components/public-api/gitpod/ as protobuf definitions.