archive-gh-me/gitpod
1
0
Fork 0
mirror of https://github.com/gitpod-io/gitpod.git synced 2025-12-08 17:36:30 +00:00
Code Issues Projects Releases Wiki Activity
gitpod/components/public-api
History
Anton Kosyakov 2f14d7a2fe
decouple gitpod-protocol from public-api (#19151) 
to prevent rebuilding of components which dependent on gitpod-protocol, but not public-api on an API change
2023-11-29 10:36:06 +02:00
..
.vscode
[public-api] First workspaces draft
2022-03-26 15:31:09 +05:30
gitpod
Migrate gRPC VerificationService (#19143)
2023-11-28 17:56:06 +02:00
go
Migrate gRPC VerificationService (#19143)
2023-11-28 17:56:06 +02:00
typescript
decouple gitpod-protocol from public-api (#19151)
2023-11-29 10:36:06 +02:00
typescript-common
decouple gitpod-protocol from public-api (#19151)
2023-11-29 10:36:06 +02:00
buf.gen.yaml
Update connect libraries (#18886)
2023-10-09 22:49:17 +03:00
buf.yaml
[public-api] align with API guidelines (#19038)
2023-11-14 13:09:51 +02:00
generate.sh
[papi] add user.proto and GetAuthenticatedUser – EXP-845 (#19132)
2023-11-28 12:42:06 +02:00
README.md
[public-api] Define stable and experimental packages
2022-10-18 08:46:33 +02:00

README.md

Public-API

This component contains the Gitpod (Public) API.

⚠️ This API is currently in development and may change frequently before it reaches General Availability

API Structure

The API is structured into two packages:

  • stable
  • experimenetal

For each package, we provide different guarantees on compatiblity and evolution of the APIs.

Stable

APIs defined in the stable package provide the following guarantees:

  • Services, calls, types and fields are not removed without following a deprecation policy (TBD).
  • Services, calls, types fields are not renamed.
  • Non succesfull responses are described exhaustively.

Experimental

APIs in defined in the experimental package provide no guarantees. You should not rely on them for any functionality.