opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-21 12:44:32 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix swagger documentation for DELETE port share endpoint (#18426)

Browse Source 
Co-authored-by: blink-so[bot] <211532188+blink-so[bot]@users.noreply.github.com>
Co-authored-by: matifali <10648092+matifali@users.noreply.github.com>
Co-authored-by: Cian Johnston <cian@coder.com>
This commit is contained in:
blink-so[bot]
2025-06-18 14:07:53 +00:00
committed by GitHub
co-authored by matifali Cian Johnston
parent 529fb5083c
commit 98a9aa19ce
4 changed files with 70 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files
coderd/apidoc/docs.go
Generated
+2 -2
View File
@@ -10192,8 +10192,8 @@ const docTemplate = `{
"tags": [
"PortSharing"
],
"summary": "Get workspace agent port shares",
"operationId": "get-workspace-agent-port-shares",
"summary": "Delete workspace agent port share",
"operationId": "delete-workspace-agent-port-share",
"parameters": [
{
"type": "string",
coderd/apidoc/swagger.json
Generated
+2 -2
View File
@@ -9021,8 +9021,8 @@
],
"consumes": ["application/json"],
"tags": ["PortSharing"],
"summary": "Get workspace agent port shares",
"operationId": "get-workspace-agent-port-shares",
"summary": "Delete workspace agent port share",
"operationId": "delete-workspace-agent-port-share",
"parameters": [
{
"type": "string",
coderd/workspaceagentportshare.go
+2 -2
View File
@@ -135,8 +135,8 @@ func (api *API) workspaceAgentPortShares(rw http.ResponseWriter, r *http.Request
})
}
// @Summary Get workspace agent port shares
// @ID get-workspace-agent-port-shares
// @Summary Delete workspace agent port share
// @ID delete-workspace-agent-port-share
// @Security CoderSessionToken
// @Accept json
// @Tags PortSharing
docs/reference/api/portsharing.md
Generated
+64 -19
View File
@@ -6,34 +6,42 @@
```shell
# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/workspaces/{workspace}/port-share \
-H 'Content-Type: application/json' \
curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/port-share \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
```
`DELETE /workspaces/{workspace}/port-share`
> Body parameter
```json
{
"agent_name": "string",
"port": 0
}
```
`GET /workspaces/{workspace}/port-share`
### Parameters
| Name | In | Type | Required | Description |
|-------------|------|----------------------------------------------------------------------------------------------------------|----------|-----------------------------------|
| `workspace` | path | string(uuid) | true | Workspace ID |
| `body` | body | [codersdk.DeleteWorkspaceAgentPortShareRequest](schemas.md#codersdkdeleteworkspaceagentportsharerequest) | true | Delete port sharing level request |
| Name | In | Type | Required | Description |
|-------------|------|--------------|----------|--------------|
| `workspace` | path | string(uuid) | true | Workspace ID |
### Example responses
> 200 Response
```json
{
"shares": [
{
"agent_name": "string",
"port": 0,
"protocol": "http",
"share_level": "owner",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"
}
]
}
```
### Responses
| Status | Meaning | Description | Schema |
|--------|---------------------------------------------------------|-------------|--------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | |
| Status | Meaning | Description | Schema |
|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceAgentPortShares](schemas.md#codersdkworkspaceagentportshares) |
To perform this operation, you must be authenticated. [Learn more](authentication.md).
@@ -90,3 +98,40 @@ curl -X POST http://coder-server:8080/api/v2/workspaces/{workspace}/port-share \
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceAgentPortShare](schemas.md#codersdkworkspaceagentportshare) |
To perform this operation, you must be authenticated. [Learn more](authentication.md).
## Delete workspace agent port share
### Code samples
```shell
# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/workspaces/{workspace}/port-share \
-H 'Content-Type: application/json' \
-H 'Coder-Session-Token: API_KEY'
```
`DELETE /workspaces/{workspace}/port-share`
> Body parameter
```json
{
"agent_name": "string",
"port": 0
}
```
### Parameters
| Name | In | Type | Required | Description |
|-------------|------|----------------------------------------------------------------------------------------------------------|----------|-----------------------------------|
| `workspace` | path | string(uuid) | true | Workspace ID |
| `body` | body | [codersdk.DeleteWorkspaceAgentPortShareRequest](schemas.md#codersdkdeleteworkspaceagentportsharerequest) | true | Delete port sharing level request |
### Responses
| Status | Meaning | Description | Schema |
|--------|---------------------------------------------------------|-------------|--------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | |
To perform this operation, you must be authenticated. [Learn more](authentication.md).