gitpod/components/ws-manager-api
Kyle Brennan 7e085ed5ad
[ws-manager-api] remove unused SSHKey field (#19287)
* [ws-manager-api] remove SSHKey field

It's no longer needed

* Ran kubebuilder `make generate`

* Ran kubebuilder's `make manifests`

* Update readme

* Cleanup
2024-01-03 17:00:41 +02:00
..
2021-06-04 16:26:37 -04:00
2023-09-26 17:52:05 +03:00

Overview

The ws-manager-api component hosts the api component of ws-manager-mk2.

Making changes to the api

There are two types of changes, changes to:

  1. proto files, like core.proto
  2. API clients (we have Go and TypeScript clients)

Changing the proto file

Say you change core.proto. Please run generate.sh from ws-manager-api to re-generate the Go and TypeScript clients.

Changing API clients

Say you plan to remove a field from a struct in our Go client. After doing, then run:

  1. make manifests from components/ws-manager-mk2, and preserve the copyright headers, to update YAML specifications
  2. make generate from components/ws-manager-mk2, and preserve the copyright headers, to generate code