Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 33d93d6

Browse files
mtojekmtojek
committed
Fix: cover workspaceagents
1 parent 2f70137 commit 33d93d6

File tree

5 files changed

+828
-0
lines changed

5 files changed

+828
-0
lines changed

‎coderd/apidoc/docs.go

Lines changed: 212 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3842,6 +3842,169 @@ const docTemplate = `{
38423842
}
38433843
}
38443844
},
3845+
"/workspaceagents/{workspaceagent}": {
3846+
"get": {
3847+
"security": [
3848+
{
3849+
"CoderSessionToken": []
3850+
}
3851+
],
3852+
"produces": [
3853+
"application/json"
3854+
],
3855+
"tags": [
3856+
"Agents"
3857+
],
3858+
"summary": "Get workspace agent by ID",
3859+
"operationId": "get-workspace-agent-by-id",
3860+
"parameters": [
3861+
{
3862+
"type": "string",
3863+
"format": "uuid",
3864+
"description": "Workspace agent ID",
3865+
"name": "workspaceagent",
3866+
"in": "path",
3867+
"required": true
3868+
}
3869+
],
3870+
"responses": {
3871+
"200": {
3872+
"description": "OK",
3873+
"schema": {
3874+
"$ref": "#/definitions/codersdk.WorkspaceAgent"
3875+
}
3876+
}
3877+
}
3878+
}
3879+
},
3880+
"/workspaceagents/{workspaceagent}/connection": {
3881+
"get": {
3882+
"security": [
3883+
{
3884+
"CoderSessionToken": []
3885+
}
3886+
],
3887+
"produces": [
3888+
"application/json"
3889+
],
3890+
"tags": [
3891+
"Agents"
3892+
],
3893+
"summary": "Get connection info for workspace agent",
3894+
"operationId": "get-connection-info-for-workspace-agent",
3895+
"parameters": [
3896+
{
3897+
"type": "string",
3898+
"format": "uuid",
3899+
"description": "Workspace agent ID",
3900+
"name": "workspaceagent",
3901+
"in": "path",
3902+
"required": true
3903+
}
3904+
],
3905+
"responses": {
3906+
"200": {
3907+
"description": "OK",
3908+
"schema": {
3909+
"$ref": "#/definitions/codersdk.WorkspaceAgentConnectionInfo"
3910+
}
3911+
}
3912+
}
3913+
}
3914+
},
3915+
"/workspaceagents/{workspaceagent}/coordinate": {
3916+
"get": {
3917+
"security": [
3918+
{
3919+
"CoderSessionToken": []
3920+
}
3921+
],
3922+
"tags": [
3923+
"Agents"
3924+
],
3925+
"summary": "Coordinate workspace agent",
3926+
"operationId": "coordinate-workspace-agent",
3927+
"parameters": [
3928+
{
3929+
"type": "string",
3930+
"format": "uuid",
3931+
"description": "Workspace agent ID",
3932+
"name": "workspaceagent",
3933+
"in": "path",
3934+
"required": true
3935+
}
3936+
],
3937+
"responses": {
3938+
"101": {
3939+
"description": "Switching Protocols"
3940+
}
3941+
}
3942+
}
3943+
},
3944+
"/workspaceagents/{workspaceagent}/listening-ports": {
3945+
"get": {
3946+
"security": [
3947+
{
3948+
"CoderSessionToken": []
3949+
}
3950+
],
3951+
"produces": [
3952+
"application/json"
3953+
],
3954+
"tags": [
3955+
"Agents"
3956+
],
3957+
"summary": "Get listening ports for workspace agent",
3958+
"operationId": "get-listening-ports-for-workspace-agent",
3959+
"parameters": [
3960+
{
3961+
"type": "string",
3962+
"format": "uuid",
3963+
"description": "Workspace agent ID",
3964+
"name": "workspaceagent",
3965+
"in": "path",
3966+
"required": true
3967+
}
3968+
],
3969+
"responses": {
3970+
"200": {
3971+
"description": "OK",
3972+
"schema": {
3973+
"$ref": "#/definitions/codersdk.ListeningPortsResponse"
3974+
}
3975+
}
3976+
}
3977+
}
3978+
},
3979+
"/workspaceagents/{workspaceagent}/pty": {
3980+
"get": {
3981+
"security": [
3982+
{
3983+
"CoderSessionToken": []
3984+
}
3985+
],
3986+
"tags": [
3987+
"Agents"
3988+
],
3989+
"summary": "Open PTY to workspace agent",
3990+
"operationId": "open-pty-to-workspace agent",
3991+
"parameters": [
3992+
{
3993+
"type": "string",
3994+
"format": "uuid",
3995+
"description": "Workspace agent ID",
3996+
"name": "workspaceagent",
3997+
"in": "path",
3998+
"required": true
3999+
}
4000+
],
4001+
"responses": {
4002+
"101": {
4003+
"description": "Switching Protocols"
4004+
}
4005+
}
4006+
}
4007+
},
38454008
"/workspacebuilds/{workspacebuild}": {
38464009
"get": {
38474010
"security": [
@@ -5851,6 +6014,47 @@ const docTemplate = `{
58516014
}
58526015
}
58536016
},
6017+
"codersdk.ListeningPort": {
6018+
"type": "object",
6019+
"properties": {
6020+
"network": {
6021+
"description": "only \"tcp\" at the moment",
6022+
"allOf": [
6023+
{
6024+
"$ref": "#/definitions/codersdk.ListeningPortNetwork"
6025+
}
6026+
]
6027+
},
6028+
"port": {
6029+
"type": "integer"
6030+
},
6031+
"process_name": {
6032+
"description": "may be empty",
6033+
"type": "string"
6034+
}
6035+
}
6036+
},
6037+
"codersdk.ListeningPortNetwork": {
6038+
"type": "string",
6039+
"enum": [
6040+
"tcp"
6041+
],
6042+
"x-enum-varnames": [
6043+
"ListeningPortNetworkTCP"
6044+
]
6045+
},
6046+
"codersdk.ListeningPortsResponse": {
6047+
"type": "object",
6048+
"properties": {
6049+
"ports": {
6050+
"description": "If there are no ports in the list, nothing should be displayed in the UI.\nThere must not be a \"no ports available\" message or anything similar, as\nthere will always be no ports displayed on platforms where our port\ndetection logic is unsupported.",
6051+
"type": "array",
6052+
"items": {
6053+
"$ref": "#/definitions/codersdk.ListeningPort"
6054+
}
6055+
}
6056+
}
6057+
},
58546058
"codersdk.LogLevel": {
58556059
"type": "string",
58566060
"enum": [
@@ -7222,6 +7426,14 @@ const docTemplate = `{
72227426
}
72237427
}
72247428
},
7429+
"codersdk.WorkspaceAgentConnectionInfo": {
7430+
"type": "object",
7431+
"properties": {
7432+
"derp_map": {
7433+
"$ref": "#/definitions/tailcfg.DERPMap"
7434+
}
7435+
}
7436+
},
72257437
"codersdk.WorkspaceAgentGitAuthResponse": {
72267438
"type": "object",
72277439
"properties": {

0 commit comments

Comments
 (0)