Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Dashboard] Document the usage of the che-server API #21848

Closed
Tracked by #21925 ...
ibuziuk opened this issue Nov 29, 2022 · 3 comments
Closed
Tracked by #21925 ...

[Dashboard] Document the usage of the che-server API #21848

ibuziuk opened this issue Nov 29, 2022 · 3 comments
Assignees
Labels
area/dashboard area/doc Issues related to documentation kind/task Internal things, technical debt, and to-do tasks to be performed. severity/P1 Has a major impact to usage or development of the system. sprint/current
Milestone

Comments

@ibuziuk
Copy link
Member

ibuziuk commented Nov 29, 2022

Is your task related to a problem? Please describe

Currently, the dashboard is the only component that uses che-server REST API. The vast majority of the endpoints are not used anymore with the DevWorkspace flow, and will be removed in the upcoming versions of the project see:

As part of this issue in the the-dashboard README.md we need to document which endpoints are still used and are not planned to be deprecated e.g. factory / kubernetes-namespace

Describe the solution you'd like

README.md should contain a section with info about the che-server endpoints that are still used

Describe alternatives you've considered

N/A

Additional context

No response

@ibuziuk ibuziuk added the kind/task Internal things, technical debt, and to-do tasks to be performed. label Nov 29, 2022
@ibuziuk
Copy link
Member Author

ibuziuk commented Nov 29, 2022

@azatsarynnyy @svor @tolusha folks, could you please confirm that the dashboard is the only operand that still uses Che-Server API

@ibuziuk ibuziuk added area/dashboard area/doc Issues related to documentation severity/P1 Has a major impact to usage or development of the system. sprint/next labels Nov 29, 2022
@azatsarynnyy
Copy link
Member

@ibuziuk None of the Che-Server APIs are used by the Che editors: Theia, IDEA, VS Code.

@tolusha
Copy link
Contributor

tolusha commented Nov 29, 2022

chectl uses system/state request to check che-server state.
But it can be easily removed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/dashboard area/doc Issues related to documentation kind/task Internal things, technical debt, and to-do tasks to be performed. severity/P1 Has a major impact to usage or development of the system. sprint/current
Projects
None yet
Development

No branches or pull requests

4 participants