Skip to content

fix: Swagger API web user interface links #2915

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.

Sign up for GitHub

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

Merged
deerskindoll merged 4 commits into from
Jun 17, 2025
Merged

fix: Swagger API web user interface links #2915

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
92f1b02
fix: Swagger API web user interface links
olexii4 Jun 2, 2025
6322a01
fixup! fix: Swagger API web user interface links
olexii4 Jun 3, 2025
60bc4f2
Update modules/administration-guide/pages/managing-workloads-using-th…
ibuziuk Jun 9, 2025
91e2322
Update modules/administration-guide/pages/managing-workloads-using-th…
olexii4 Jun 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions ...les/administration-guide/pages/managing-workloads-using-the-che-server-api.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
:_content-type: PROCEDURE
:description: Managing {prod-short} server workloads using the {prod-short} server API
:description: Managing {prod-short} server and {prod-short} dashboard workloads using the API
:keywords: administration-guide, api
:navtitle: Using the {prod-short} server API
:page-aliases:

[id="managing-workloads-using-the-{prod-id-short}-server-api"]
= Managing {prod-short} server workloads using the {prod-short} server API
= Managing {prod-short} server and {prod-short} dashboard workloads using the API

To manage {prod-short} server workloads, use the Swagger web user interface to navigate {prod-short} server API.
To manage {prod-short} server and {prod-short} dashboard workloads, use the Swagger web user interface to navigate the API.

.Procedure

* Navigate to the Swagger API web user interface: `pass:c,a,q[{prod-url}]/swagger`.
* Navigate to the Swagger API web user interface:
- `pass:c,a,q[{prod-url}]/swagger` ({prod-short} server)
- `pass:c,a,q[{prod-url}]/dashboard/api/swagger` ({prod-short} dashboard)

IMPORTANT: DevWorkspace is a k8s object and manipulations should happen on the Kubernetes API level - xref:end-user-guide:managing-workspaces-with-apis.adoc[]

.Additional resources

Expand Down