Skip to content

Commit 752e138

Browse files
committed
update README with new endpoint
1 parent 25cbf01 commit 752e138

File tree

1 file changed

+27
-19
lines changed

1 file changed

+27
-19
lines changed

workspaces/backend/README.md

Lines changed: 27 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -27,29 +27,30 @@ make run
2727
If you want to use a different port:
2828

2929
```shell
30-
make run PORT=8000
30+
make run PORT=8000
3131
```
3232

3333
### Endpoints
3434

35-
| URL Pattern | Handler | Action |
36-
|----------------------------------------------|------------------------|-----------------------------------------|
37-
| GET /api/v1/healthcheck | healthcheck_handler | Show application information |
38-
| GET /api/v1/namespaces | namespaces_handler | Get all Namespaces |
39-
| GET /api/v1/swagger/ | swagger_handler | Swagger API documentation |
40-
| GET /api/v1/workspaces | workspaces_handler | Get all Workspaces |
41-
| GET /api/v1/workspaces/{namespace} | workspaces_handler | Get all Workspaces from a namespace |
42-
| POST /api/v1/workspaces/{namespace} | workspaces_handler | Create a Workspace in a given namespace |
43-
| GET /api/v1/workspaces/{namespace}/{name} | workspaces_handler | Get a Workspace entity |
44-
| PATCH /api/v1/workspaces/{namespace}/{name} | TBD | Patch a Workspace entity |
45-
| PUT /api/v1/workspaces/{namespace}/{name} | TBD | Update a Workspace entity |
46-
| DELETE /api/v1/workspaces/{namespace}/{name} | workspaces_handler | Delete a Workspace entity |
47-
| GET /api/v1/workspacekinds | workspacekinds_handler | Get all WorkspaceKind |
48-
| POST /api/v1/workspacekinds | TBD | Create a WorkspaceKind |
49-
| GET /api/v1/workspacekinds/{name} | workspacekinds_handler | Get a WorkspaceKind entity |
50-
| PATCH /api/v1/workspacekinds/{name} | TBD | Patch a WorkspaceKind entity |
51-
| PUT /api/v1/workspacekinds/{name} | TBD | Update a WorkspaceKind entity |
52-
| DELETE /api/v1/workspacekinds/{name} | TBD | Delete a WorkspaceKind entity |
35+
| URL Pattern | Handler | Action |
36+
|-----------------------------------------------------------|---------------------------|-----------------------------------------|
37+
| GET /api/v1/healthcheck | healthcheck_handler | Show application information |
38+
| GET /api/v1/namespaces | namespaces_handler | Get all Namespaces |
39+
| GET /api/v1/swagger/ | swagger_handler | Swagger API documentation |
40+
| GET /api/v1/workspaces | workspaces_handler | Get all Workspaces |
41+
| GET /api/v1/workspaces/{namespace} | workspaces_handler | Get all Workspaces from a namespace |
42+
| POST /api/v1/workspaces/{namespace} | workspaces_handler | Create a Workspace in a given namespace |
43+
| GET /api/v1/workspaces/{namespace}/{name} | workspaces_handler | Get a Workspace entity |
44+
| PATCH /api/v1/workspaces/{namespace}/{name} | TBD | Patch a Workspace entity |
45+
| PUT /api/v1/workspaces/{namespace}/{name} | TBD | Update a Workspace entity |
46+
| DELETE /api/v1/workspaces/{namespace}/{name} | workspaces_handler | Delete a Workspace entity |
47+
| POST /api/v1/workspaces/{namespace}/{name}/actions/pause | workspace_actions_handler | Pause a running workspace |
48+
| GET /api/v1/workspacekinds | workspacekinds_handler | Get all WorkspaceKind |
49+
| POST /api/v1/workspacekinds | TBD | Create a WorkspaceKind |
50+
| GET /api/v1/workspacekinds/{name} | workspacekinds_handler | Get a WorkspaceKind entity |
51+
| PATCH /api/v1/workspacekinds/{name} | TBD | Patch a WorkspaceKind entity |
52+
| PUT /api/v1/workspacekinds/{name} | TBD | Update a WorkspaceKind entity |
53+
| DELETE /api/v1/workspacekinds/{name} | TBD | Delete a WorkspaceKind entity |
5354

5455
### Sample local calls
5556

@@ -128,6 +129,13 @@ Get a Workspace:
128129
curl -i localhost:4000/api/v1/workspaces/default/dora
129130
```
130131

132+
Pause a Workspace:
133+
134+
```shell
135+
# POST /api/v1/workspaces/{namespace}/{name}/actions/pause
136+
curl -X POST localhost:4000/api/v1/workspaces/default/dora/actions/pause
137+
```
138+
131139
Delete a Workspace:
132140

133141
```shell

0 commit comments

Comments
 (0)