@@ -27,29 +27,30 @@ make run
27
27
If you want to use a different port:
28
28
29
29
``` shell
30
- make run PORT=8000
30
+ make run PORT=8000
31
31
```
32
32
33
33
### Endpoints
34
34
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 |
53
54
54
55
### Sample local calls
55
56
@@ -128,6 +129,13 @@ Get a Workspace:
128
129
curl -i localhost:4000/api/v1/workspaces/default/dora
129
130
```
130
131
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
+
131
139
Delete a Workspace:
132
140
133
141
``` shell
0 commit comments