Make machine types and available IDEs accessible via the API
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 13.8k
- Forks
- 1.4k
- Avg merge
- 17h 58m
- Merged PRs (30d)
- 5
Description
Is your feature request related to a problem? Please describe
Clients may want to have their own "start a workspace" experience. Practically speaking, for the https://github.com/gitpod-samples/Gitpod-Raycast-Extension, IDEs and machine types have to be hard-coded into the code to be able to start workspaces properly.
This though itself is problematic (not just because of the problems arising with maintaining) - for other installation hosts like in a Gitpod Dedicated scenario, these machine types just cannot be gotten.
Describe the behaviour you'd like
Two read-only API endpoints:
- for listing all IDEs along with their versions (similar to what we implement in
ide-service, but in the Public API) -getIDEOptions - for listing all machine types available on the install for the currently logged-in user -
getSupportedWorkspaceClasses
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing ide-service implementation and the Public API entry points mentioned in the issue. Trace how IDE versions and user-available machine types are obtained, then define the two read-only endpoints, getIDEOptions and getSupportedWorkspaceClasses. Done means clients can retrieve current IDE options and machine types for the logged-in user without hard-coding them.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100