mirror of
https://github.com/coder/coder.git
synced 2025-07-08 11:39:50 +00:00
docs: update swaggo/swag v1.8.9 (#5590)
* docs: update swaggo/swag v1.8.9 * Fix: format * swaggo: time.Duration * swaggo: provisionertype * Fix: AuthorizationObject * Fix: enums * Fix: netip.Addr * Fix: clickable response properties
This commit is contained in:
Marcin Tojek
GitHub
@ -1918,6 +1918,23 @@ const docTemplate = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"codersdk.AuditAction": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"create",
|
||||
"write",
|
||||
"delete",
|
||||
"start",
|
||||
"stop"
|
||||
],
|
||||
"x-enum-varnames": [
|
||||
"AuditActionCreate",
|
||||
"AuditActionWrite",
|
||||
"AuditActionDelete",
|
||||
"AuditActionStart",
|
||||
"AuditActionStop"
|
||||
]
|
||||
},
|
||||
"codersdk.AuditDiff": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
@ -1938,7 +1955,7 @@ const docTemplate = `{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"action": {
|
||||
"type": "string"
|
||||
"$ref": "#/definitions/codersdk.AuditAction"
|
||||
},
|
||||
"additional_fields": {
|
||||
"type": "array",
|
||||
@ -1956,7 +1973,7 @@ const docTemplate = `{
|
||||
"type": "string"
|
||||
},
|
||||
"ip": {
|
||||
"$ref": "#/definitions/netip.Addr"
|
||||
"type": "string"
|
||||
},
|
||||
"is_deleted": {
|
||||
"type": "boolean"
|
||||
@ -1981,7 +1998,7 @@ const docTemplate = `{
|
||||
"type": "string"
|
||||
},
|
||||
"resource_type": {
|
||||
"type": "string"
|
||||
"$ref": "#/definitions/codersdk.ResourceType"
|
||||
},
|
||||
"status_code": {
|
||||
"type": "integer"
|
||||
@ -2025,8 +2042,12 @@ const docTemplate = `{
|
||||
]
|
||||
},
|
||||
"object": {
|
||||
"description": "Object can represent a \"set\" of objects, such as:\n\t- All workspaces in an organization\n\t- All workspaces owned by me\n\t- All workspaces across the entire product\nWhen defining an object, use the most specific language when possible to\nproduce the smallest set. Meaning to set as many fields on 'Object' as\nyou can. Example, if you want to check if you can update all workspaces\nowned by 'me', try to also add an 'OrganizationID' to the settings.\nOmitting the 'OrganizationID' could produce the incorrect value, as\nworkspaces have both ` + "`" + `user` + "`" + ` and ` + "`" + `organization` + "`" + ` owners.",
|
||||
"$ref": "#/definitions/codersdk.AuthorizationObject"
|
||||
"description": "Object can represent a \"set\" of objects, such as: all workspaces in an organization, all workspaces owned by me, and all workspaces across the entire product.\nWhen defining an object, use the most specific language when possible to\nproduce the smallest set. Meaning to set as many fields on 'Object' as\nyou can. Example, if you want to check if you can update all workspaces\nowned by 'me', try to also add an 'OrganizationID' to the settings.\nOmitting the 'OrganizationID' could produce the incorrect value, as\nworkspaces have both ` + "`" + `user` + "`" + ` and ` + "`" + `organization` + "`" + ` owners.",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.AuthorizationObject"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
@ -2098,6 +2119,19 @@ const docTemplate = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"codersdk.BuildReason": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"initiator",
|
||||
"autostart",
|
||||
"autostop"
|
||||
],
|
||||
"x-enum-varnames": [
|
||||
"BuildReasonInitiator",
|
||||
"BuildReasonAutostart",
|
||||
"BuildReasonAutostop"
|
||||
]
|
||||
},
|
||||
"codersdk.CreateParameterRequest": {
|
||||
"description": "CreateParameterRequest is a structure used to create a new parameter value for a scope.",
|
||||
"type": "object",
|
||||
@ -2113,21 +2147,29 @@ const docTemplate = `{
|
||||
"type": "string"
|
||||
},
|
||||
"destination_scheme": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"none",
|
||||
"environment_variable",
|
||||
"provisioner_variable"
|
||||
],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.ParameterDestinationScheme"
|
||||
}
|
||||
]
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"source_scheme": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"none",
|
||||
"data"
|
||||
],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.ParameterSourceScheme"
|
||||
}
|
||||
]
|
||||
},
|
||||
"source_value": {
|
||||
@ -2182,20 +2224,23 @@ const docTemplate = `{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"action": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"create",
|
||||
"write",
|
||||
"delete",
|
||||
"start",
|
||||
"stop"
|
||||
],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.AuditAction"
|
||||
}
|
||||
]
|
||||
},
|
||||
"resource_id": {
|
||||
"type": "string"
|
||||
},
|
||||
"resource_type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"organization",
|
||||
"template",
|
||||
@ -2206,6 +2251,11 @@ const docTemplate = `{
|
||||
"git_ssh_key",
|
||||
"api_key",
|
||||
"group"
|
||||
],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.ResourceType"
|
||||
}
|
||||
]
|
||||
},
|
||||
"time": {
|
||||
@ -2243,12 +2293,16 @@ const docTemplate = `{
|
||||
"type": "string"
|
||||
},
|
||||
"transition": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"create",
|
||||
"start",
|
||||
"stop",
|
||||
"delete"
|
||||
],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.WorkspaceTransition"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
@ -2317,7 +2371,11 @@ const docTemplate = `{
|
||||
},
|
||||
"address": {
|
||||
"description": "DEPRECATED: Use HTTPAddress or TLS.Address instead.",
|
||||
"$ref": "#/definitions/codersdk.DeploymentConfigField-string"
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.DeploymentConfigField-string"
|
||||
}
|
||||
]
|
||||
},
|
||||
"agent_fallback_troubleshooting_url": {
|
||||
"$ref": "#/definitions/codersdk.DeploymentConfigField-string"
|
||||
@ -2445,7 +2503,10 @@ const docTemplate = `{
|
||||
"type": "string"
|
||||
},
|
||||
"value": {
|
||||
"$ref": "#/definitions/codersdk.GitAuthConfig"
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/codersdk.GitAuthConfig"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
@ -2480,7 +2541,10 @@ const docTemplate = `{
|
||||
"type": "string"
|
||||
},
|
||||
"value": {
|
||||
"type": "string"
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
@ -2684,6 +2748,34 @@ const docTemplate = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"codersdk.LogLevel": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"trace",
|
||||
"debug",
|
||||
"info",
|
||||
"warn",
|
||||
"error"
|
||||
],
|
||||
"x-enum-varnames": [
|
||||
"LogLevelTrace",
|
||||
"LogLevelDebug",
|
||||
"LogLevelInfo",
|
||||
"LogLevelWarn",
|
||||
"LogLevelError"
|
||||
]
|
||||
},
|
||||
"codersdk.LogSource": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"provisioner_daemon",
|
||||
"provisioner"
|
||||
],
|
||||
"x-enum-varnames": [
|
||||
"LogSourceProvisionerDaemon",
|
||||
"LogSourceProvisioner"
|
||||
]
|
||||
},
|
||||
"codersdk.OAuth2Config": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@ -2756,11 +2848,15 @@ const docTemplate = `{
|
||||
"format": "date-time"
|
||||
},
|
||||
"destination_scheme": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"none",
|
||||
"environment_variable",
|
||||
"provisioner_variable"
|
||||
],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.ParameterDestinationScheme"
|
||||
}
|
||||
]
|
||||
},
|
||||
"id": {
|
||||
@ -2771,11 +2867,15 @@ const docTemplate = `{
|
||||
"type": "string"
|
||||
},
|
||||
"scope": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"template",
|
||||
"workspace",
|
||||
"import_job"
|
||||
],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.ParameterScope"
|
||||
}
|
||||
]
|
||||
},
|
||||
"scope_id": {
|
||||
@ -2783,10 +2883,14 @@ const docTemplate = `{
|
||||
"format": "uuid"
|
||||
},
|
||||
"source_scheme": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"none",
|
||||
"data"
|
||||
],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.ParameterSourceScheme"
|
||||
}
|
||||
]
|
||||
},
|
||||
"updated_at": {
|
||||
@ -2795,6 +2899,43 @@ const docTemplate = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"codersdk.ParameterDestinationScheme": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"none",
|
||||
"environment_variable",
|
||||
"provisioner_variable"
|
||||
],
|
||||
"x-enum-varnames": [
|
||||
"ParameterDestinationSchemeNone",
|
||||
"ParameterDestinationSchemeEnvironmentVariable",
|
||||
"ParameterDestinationSchemeProvisionerVariable"
|
||||
]
|
||||
},
|
||||
"codersdk.ParameterScope": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"template",
|
||||
"workspace",
|
||||
"import_job"
|
||||
],
|
||||
"x-enum-varnames": [
|
||||
"ParameterTemplate",
|
||||
"ParameterWorkspace",
|
||||
"ParameterImportJob"
|
||||
]
|
||||
},
|
||||
"codersdk.ParameterSourceScheme": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"none",
|
||||
"data"
|
||||
],
|
||||
"x-enum-varnames": [
|
||||
"ParameterSourceSchemeNone",
|
||||
"ParameterSourceSchemeData"
|
||||
]
|
||||
},
|
||||
"codersdk.PostWorkspaceAgentVersionRequest": {
|
||||
"description": "x-apidocgen:skip",
|
||||
"type": "object",
|
||||
@ -2811,7 +2952,7 @@ const docTemplate = `{
|
||||
"description": "Healths is a map of the workspace app name and the health of the app.",
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
"$ref": "#/definitions/codersdk.WorkspaceAppHealth"
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -2886,7 +3027,6 @@ const docTemplate = `{
|
||||
"format": "date-time"
|
||||
},
|
||||
"status": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"pending",
|
||||
"running",
|
||||
@ -2894,6 +3034,11 @@ const docTemplate = `{
|
||||
"canceling",
|
||||
"canceled",
|
||||
"failed"
|
||||
],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.ProvisionerJobStatus"
|
||||
}
|
||||
]
|
||||
},
|
||||
"tags": {
|
||||
@ -2919,17 +3064,21 @@ const docTemplate = `{
|
||||
"type": "integer"
|
||||
},
|
||||
"log_level": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"trace",
|
||||
"debug",
|
||||
"info",
|
||||
"warn",
|
||||
"error"
|
||||
],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.LogLevel"
|
||||
}
|
||||
]
|
||||
},
|
||||
"log_source": {
|
||||
"type": "string"
|
||||
"$ref": "#/definitions/codersdk.LogSource"
|
||||
},
|
||||
"output": {
|
||||
"type": "string"
|
||||
@ -2939,6 +3088,25 @@ const docTemplate = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"codersdk.ProvisionerJobStatus": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"pending",
|
||||
"running",
|
||||
"succeeded",
|
||||
"canceling",
|
||||
"canceled",
|
||||
"failed"
|
||||
],
|
||||
"x-enum-varnames": [
|
||||
"ProvisionerJobPending",
|
||||
"ProvisionerJobRunning",
|
||||
"ProvisionerJobSucceeded",
|
||||
"ProvisionerJobCanceling",
|
||||
"ProvisionerJobCanceled",
|
||||
"ProvisionerJobFailed"
|
||||
]
|
||||
},
|
||||
"codersdk.PutExtendWorkspaceRequest": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
@ -2961,6 +3129,31 @@ const docTemplate = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"codersdk.ResourceType": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"organization",
|
||||
"template",
|
||||
"template_version",
|
||||
"user",
|
||||
"workspace",
|
||||
"workspace_build",
|
||||
"git_ssh_key",
|
||||
"api_key",
|
||||
"group"
|
||||
],
|
||||
"x-enum-varnames": [
|
||||
"ResourceTypeOrganization",
|
||||
"ResourceTypeTemplate",
|
||||
"ResourceTypeTemplateVersion",
|
||||
"ResourceTypeUser",
|
||||
"ResourceTypeWorkspace",
|
||||
"ResourceTypeWorkspaceBuild",
|
||||
"ResourceTypeGitSSHKey",
|
||||
"ResourceTypeAPIKey",
|
||||
"ResourceTypeGroup"
|
||||
]
|
||||
},
|
||||
"codersdk.Response": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@ -3100,7 +3293,10 @@ const docTemplate = `{
|
||||
"format": "uuid"
|
||||
},
|
||||
"provisioner": {
|
||||
"type": "string"
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"terraform"
|
||||
]
|
||||
},
|
||||
"updated_at": {
|
||||
"type": "string",
|
||||
@ -3231,13 +3427,24 @@ const docTemplate = `{
|
||||
}
|
||||
},
|
||||
"status": {
|
||||
"type": "string"
|
||||
"$ref": "#/definitions/codersdk.UserStatus"
|
||||
},
|
||||
"username": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"codersdk.UserStatus": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"active",
|
||||
"suspended"
|
||||
],
|
||||
"x-enum-varnames": [
|
||||
"UserStatusActive",
|
||||
"UserStatusSuspended"
|
||||
]
|
||||
},
|
||||
"codersdk.ValidationError": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
@ -3380,12 +3587,16 @@ const docTemplate = `{
|
||||
"type": "string"
|
||||
},
|
||||
"status": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"connecting",
|
||||
"connected",
|
||||
"disconnected",
|
||||
"timeout"
|
||||
],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.WorkspaceAgentStatus"
|
||||
}
|
||||
]
|
||||
},
|
||||
"troubleshooting_url": {
|
||||
@ -3458,6 +3669,21 @@ const docTemplate = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"codersdk.WorkspaceAgentStatus": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"connecting",
|
||||
"connected",
|
||||
"disconnected",
|
||||
"timeout"
|
||||
],
|
||||
"x-enum-varnames": [
|
||||
"WorkspaceAgentConnecting",
|
||||
"WorkspaceAgentConnected",
|
||||
"WorkspaceAgentDisconnected",
|
||||
"WorkspaceAgentTimeout"
|
||||
]
|
||||
},
|
||||
"codersdk.WorkspaceApp": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@ -3473,11 +3699,15 @@ const docTemplate = `{
|
||||
"type": "boolean"
|
||||
},
|
||||
"health": {
|
||||
"type": "string"
|
||||
"$ref": "#/definitions/codersdk.WorkspaceAppHealth"
|
||||
},
|
||||
"healthcheck": {
|
||||
"description": "Healthcheck specifies the configuration for checking app health.",
|
||||
"$ref": "#/definitions/codersdk.Healthcheck"
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.Healthcheck"
|
||||
}
|
||||
]
|
||||
},
|
||||
"icon": {
|
||||
"description": "Icon is a relative path or external URL that specifies\nan icon to be displayed in the dashboard.",
|
||||
@ -3488,11 +3718,15 @@ const docTemplate = `{
|
||||
"format": "uuid"
|
||||
},
|
||||
"sharing_level": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"owner",
|
||||
"authenticated",
|
||||
"public"
|
||||
],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.WorkspaceAppSharingLevel"
|
||||
}
|
||||
]
|
||||
},
|
||||
"slug": {
|
||||
@ -3509,6 +3743,34 @@ const docTemplate = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"codersdk.WorkspaceAppHealth": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"disabled",
|
||||
"initializing",
|
||||
"healthy",
|
||||
"unhealthy"
|
||||
],
|
||||
"x-enum-varnames": [
|
||||
"WorkspaceAppHealthDisabled",
|
||||
"WorkspaceAppHealthInitializing",
|
||||
"WorkspaceAppHealthHealthy",
|
||||
"WorkspaceAppHealthUnhealthy"
|
||||
]
|
||||
},
|
||||
"codersdk.WorkspaceAppSharingLevel": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"owner",
|
||||
"authenticated",
|
||||
"public"
|
||||
],
|
||||
"x-enum-varnames": [
|
||||
"WorkspaceAppSharingLevelOwner",
|
||||
"WorkspaceAppSharingLevelAuthenticated",
|
||||
"WorkspaceAppSharingLevelPublic"
|
||||
]
|
||||
},
|
||||
"codersdk.WorkspaceBuild": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@ -3541,11 +3803,15 @@ const docTemplate = `{
|
||||
"$ref": "#/definitions/codersdk.ProvisionerJob"
|
||||
},
|
||||
"reason": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"initiator",
|
||||
"autostart",
|
||||
"autostop"
|
||||
],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.BuildReason"
|
||||
}
|
||||
]
|
||||
},
|
||||
"resources": {
|
||||
@ -3555,7 +3821,6 @@ const docTemplate = `{
|
||||
}
|
||||
},
|
||||
"status": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"pending",
|
||||
"starting",
|
||||
@ -3567,6 +3832,11 @@ const docTemplate = `{
|
||||
"canceled",
|
||||
"deleting",
|
||||
"deleted"
|
||||
],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.WorkspaceStatus"
|
||||
}
|
||||
]
|
||||
},
|
||||
"template_version_id": {
|
||||
@ -3577,11 +3847,15 @@ const docTemplate = `{
|
||||
"type": "string"
|
||||
},
|
||||
"transition": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"start",
|
||||
"stop",
|
||||
"delete"
|
||||
],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.WorkspaceTransition"
|
||||
}
|
||||
]
|
||||
},
|
||||
"updated_at": {
|
||||
@ -3647,11 +3921,15 @@ const docTemplate = `{
|
||||
"type": "string"
|
||||
},
|
||||
"workspace_transition": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"start",
|
||||
"stop",
|
||||
"delete"
|
||||
],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.WorkspaceTransition"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
@ -3670,6 +3948,46 @@ const docTemplate = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"codersdk.WorkspaceStatus": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"pending",
|
||||
"starting",
|
||||
"running",
|
||||
"stopping",
|
||||
"stopped",
|
||||
"failed",
|
||||
"canceling",
|
||||
"canceled",
|
||||
"deleting",
|
||||
"deleted"
|
||||
],
|
||||
"x-enum-varnames": [
|
||||
"WorkspaceStatusPending",
|
||||
"WorkspaceStatusStarting",
|
||||
"WorkspaceStatusRunning",
|
||||
"WorkspaceStatusStopping",
|
||||
"WorkspaceStatusStopped",
|
||||
"WorkspaceStatusFailed",
|
||||
"WorkspaceStatusCanceling",
|
||||
"WorkspaceStatusCanceled",
|
||||
"WorkspaceStatusDeleting",
|
||||
"WorkspaceStatusDeleted"
|
||||
]
|
||||
},
|
||||
"codersdk.WorkspaceTransition": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"start",
|
||||
"stop",
|
||||
"delete"
|
||||
],
|
||||
"x-enum-varnames": [
|
||||
"WorkspaceTransitionStart",
|
||||
"WorkspaceTransitionStop",
|
||||
"WorkspaceTransitionDelete"
|
||||
]
|
||||
},
|
||||
"codersdk.WorkspacesResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@ -3684,9 +4002,6 @@ const docTemplate = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"netip.Addr": {
|
||||
"type": "object"
|
||||
},
|
||||
"tailcfg.DERPMap": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
|
||||
@ -1682,6 +1682,17 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"codersdk.AuditAction": {
|
||||
"type": "string",
|
||||
"enum": ["create", "write", "delete", "start", "stop"],
|
||||
"x-enum-varnames": [
|
||||
"AuditActionCreate",
|
||||
"AuditActionWrite",
|
||||
"AuditActionDelete",
|
||||
"AuditActionStart",
|
||||
"AuditActionStop"
|
||||
]
|
||||
},
|
||||
"codersdk.AuditDiff": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
@ -1702,7 +1713,7 @@
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"action": {
|
||||
"type": "string"
|
||||
"$ref": "#/definitions/codersdk.AuditAction"
|
||||
},
|
||||
"additional_fields": {
|
||||
"type": "array",
|
||||
@ -1720,7 +1731,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"ip": {
|
||||
"$ref": "#/definitions/netip.Addr"
|
||||
"type": "string"
|
||||
},
|
||||
"is_deleted": {
|
||||
"type": "boolean"
|
||||
@ -1745,7 +1756,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"resource_type": {
|
||||
"type": "string"
|
||||
"$ref": "#/definitions/codersdk.ResourceType"
|
||||
},
|
||||
"status_code": {
|
||||
"type": "integer"
|
||||
@ -1784,8 +1795,12 @@
|
||||
"enum": ["create", "read", "update", "delete"]
|
||||
},
|
||||
"object": {
|
||||
"description": "Object can represent a \"set\" of objects, such as:\n\t- All workspaces in an organization\n\t- All workspaces owned by me\n\t- All workspaces across the entire product\nWhen defining an object, use the most specific language when possible to\nproduce the smallest set. Meaning to set as many fields on 'Object' as\nyou can. Example, if you want to check if you can update all workspaces\nowned by 'me', try to also add an 'OrganizationID' to the settings.\nOmitting the 'OrganizationID' could produce the incorrect value, as\nworkspaces have both `user` and `organization` owners.",
|
||||
"$ref": "#/definitions/codersdk.AuthorizationObject"
|
||||
"description": "Object can represent a \"set\" of objects, such as: all workspaces in an organization, all workspaces owned by me, and all workspaces across the entire product.\nWhen defining an object, use the most specific language when possible to\nproduce the smallest set. Meaning to set as many fields on 'Object' as\nyou can. Example, if you want to check if you can update all workspaces\nowned by 'me', try to also add an 'OrganizationID' to the settings.\nOmitting the 'OrganizationID' could produce the incorrect value, as\nworkspaces have both `user` and `organization` owners.",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.AuthorizationObject"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
@ -1854,6 +1869,15 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"codersdk.BuildReason": {
|
||||
"type": "string",
|
||||
"enum": ["initiator", "autostart", "autostop"],
|
||||
"x-enum-varnames": [
|
||||
"BuildReasonInitiator",
|
||||
"BuildReasonAutostart",
|
||||
"BuildReasonAutostop"
|
||||
]
|
||||
},
|
||||
"codersdk.CreateParameterRequest": {
|
||||
"description": "CreateParameterRequest is a structure used to create a new parameter value for a scope.",
|
||||
"type": "object",
|
||||
@ -1869,15 +1893,23 @@
|
||||
"type": "string"
|
||||
},
|
||||
"destination_scheme": {
|
||||
"type": "string",
|
||||
"enum": ["none", "environment_variable", "provisioner_variable"]
|
||||
"enum": ["none", "environment_variable", "provisioner_variable"],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.ParameterDestinationScheme"
|
||||
}
|
||||
]
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"source_scheme": {
|
||||
"type": "string",
|
||||
"enum": ["none", "data"]
|
||||
"enum": ["none", "data"],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.ParameterSourceScheme"
|
||||
}
|
||||
]
|
||||
},
|
||||
"source_value": {
|
||||
"type": "string"
|
||||
@ -1928,14 +1960,17 @@
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"action": {
|
||||
"type": "string",
|
||||
"enum": ["create", "write", "delete", "start", "stop"]
|
||||
"enum": ["create", "write", "delete", "start", "stop"],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.AuditAction"
|
||||
}
|
||||
]
|
||||
},
|
||||
"resource_id": {
|
||||
"type": "string"
|
||||
},
|
||||
"resource_type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"organization",
|
||||
"template",
|
||||
@ -1946,6 +1981,11 @@
|
||||
"git_ssh_key",
|
||||
"api_key",
|
||||
"group"
|
||||
],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.ResourceType"
|
||||
}
|
||||
]
|
||||
},
|
||||
"time": {
|
||||
@ -1981,8 +2021,12 @@
|
||||
"type": "string"
|
||||
},
|
||||
"transition": {
|
||||
"type": "string",
|
||||
"enum": ["create", "start", "stop", "delete"]
|
||||
"enum": ["create", "start", "stop", "delete"],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.WorkspaceTransition"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
@ -2050,7 +2094,11 @@
|
||||
},
|
||||
"address": {
|
||||
"description": "DEPRECATED: Use HTTPAddress or TLS.Address instead.",
|
||||
"$ref": "#/definitions/codersdk.DeploymentConfigField-string"
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.DeploymentConfigField-string"
|
||||
}
|
||||
]
|
||||
},
|
||||
"agent_fallback_troubleshooting_url": {
|
||||
"$ref": "#/definitions/codersdk.DeploymentConfigField-string"
|
||||
@ -2178,7 +2226,10 @@
|
||||
"type": "string"
|
||||
},
|
||||
"value": {
|
||||
"$ref": "#/definitions/codersdk.GitAuthConfig"
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/codersdk.GitAuthConfig"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
@ -2213,7 +2264,10 @@
|
||||
"type": "string"
|
||||
},
|
||||
"value": {
|
||||
"type": "string"
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
@ -2415,6 +2469,22 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"codersdk.LogLevel": {
|
||||
"type": "string",
|
||||
"enum": ["trace", "debug", "info", "warn", "error"],
|
||||
"x-enum-varnames": [
|
||||
"LogLevelTrace",
|
||||
"LogLevelDebug",
|
||||
"LogLevelInfo",
|
||||
"LogLevelWarn",
|
||||
"LogLevelError"
|
||||
]
|
||||
},
|
||||
"codersdk.LogSource": {
|
||||
"type": "string",
|
||||
"enum": ["provisioner_daemon", "provisioner"],
|
||||
"x-enum-varnames": ["LogSourceProvisionerDaemon", "LogSourceProvisioner"]
|
||||
},
|
||||
"codersdk.OAuth2Config": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@ -2487,8 +2557,12 @@
|
||||
"format": "date-time"
|
||||
},
|
||||
"destination_scheme": {
|
||||
"type": "string",
|
||||
"enum": ["none", "environment_variable", "provisioner_variable"]
|
||||
"enum": ["none", "environment_variable", "provisioner_variable"],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.ParameterDestinationScheme"
|
||||
}
|
||||
]
|
||||
},
|
||||
"id": {
|
||||
"type": "string",
|
||||
@ -2498,16 +2572,24 @@
|
||||
"type": "string"
|
||||
},
|
||||
"scope": {
|
||||
"type": "string",
|
||||
"enum": ["template", "workspace", "import_job"]
|
||||
"enum": ["template", "workspace", "import_job"],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.ParameterScope"
|
||||
}
|
||||
]
|
||||
},
|
||||
"scope_id": {
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"source_scheme": {
|
||||
"type": "string",
|
||||
"enum": ["none", "data"]
|
||||
"enum": ["none", "data"],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.ParameterSourceScheme"
|
||||
}
|
||||
]
|
||||
},
|
||||
"updated_at": {
|
||||
"type": "string",
|
||||
@ -2515,6 +2597,32 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"codersdk.ParameterDestinationScheme": {
|
||||
"type": "string",
|
||||
"enum": ["none", "environment_variable", "provisioner_variable"],
|
||||
"x-enum-varnames": [
|
||||
"ParameterDestinationSchemeNone",
|
||||
"ParameterDestinationSchemeEnvironmentVariable",
|
||||
"ParameterDestinationSchemeProvisionerVariable"
|
||||
]
|
||||
},
|
||||
"codersdk.ParameterScope": {
|
||||
"type": "string",
|
||||
"enum": ["template", "workspace", "import_job"],
|
||||
"x-enum-varnames": [
|
||||
"ParameterTemplate",
|
||||
"ParameterWorkspace",
|
||||
"ParameterImportJob"
|
||||
]
|
||||
},
|
||||
"codersdk.ParameterSourceScheme": {
|
||||
"type": "string",
|
||||
"enum": ["none", "data"],
|
||||
"x-enum-varnames": [
|
||||
"ParameterSourceSchemeNone",
|
||||
"ParameterSourceSchemeData"
|
||||
]
|
||||
},
|
||||
"codersdk.PostWorkspaceAgentVersionRequest": {
|
||||
"description": "x-apidocgen:skip",
|
||||
"type": "object",
|
||||
@ -2531,7 +2639,7 @@
|
||||
"description": "Healths is a map of the workspace app name and the health of the app.",
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
"$ref": "#/definitions/codersdk.WorkspaceAppHealth"
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -2606,7 +2714,6 @@
|
||||
"format": "date-time"
|
||||
},
|
||||
"status": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"pending",
|
||||
"running",
|
||||
@ -2614,6 +2721,11 @@
|
||||
"canceling",
|
||||
"canceled",
|
||||
"failed"
|
||||
],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.ProvisionerJobStatus"
|
||||
}
|
||||
]
|
||||
},
|
||||
"tags": {
|
||||
@ -2639,11 +2751,15 @@
|
||||
"type": "integer"
|
||||
},
|
||||
"log_level": {
|
||||
"type": "string",
|
||||
"enum": ["trace", "debug", "info", "warn", "error"]
|
||||
"enum": ["trace", "debug", "info", "warn", "error"],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.LogLevel"
|
||||
}
|
||||
]
|
||||
},
|
||||
"log_source": {
|
||||
"type": "string"
|
||||
"$ref": "#/definitions/codersdk.LogSource"
|
||||
},
|
||||
"output": {
|
||||
"type": "string"
|
||||
@ -2653,6 +2769,25 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"codersdk.ProvisionerJobStatus": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"pending",
|
||||
"running",
|
||||
"succeeded",
|
||||
"canceling",
|
||||
"canceled",
|
||||
"failed"
|
||||
],
|
||||
"x-enum-varnames": [
|
||||
"ProvisionerJobPending",
|
||||
"ProvisionerJobRunning",
|
||||
"ProvisionerJobSucceeded",
|
||||
"ProvisionerJobCanceling",
|
||||
"ProvisionerJobCanceled",
|
||||
"ProvisionerJobFailed"
|
||||
]
|
||||
},
|
||||
"codersdk.PutExtendWorkspaceRequest": {
|
||||
"type": "object",
|
||||
"required": ["deadline"],
|
||||
@ -2673,6 +2808,31 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"codersdk.ResourceType": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"organization",
|
||||
"template",
|
||||
"template_version",
|
||||
"user",
|
||||
"workspace",
|
||||
"workspace_build",
|
||||
"git_ssh_key",
|
||||
"api_key",
|
||||
"group"
|
||||
],
|
||||
"x-enum-varnames": [
|
||||
"ResourceTypeOrganization",
|
||||
"ResourceTypeTemplate",
|
||||
"ResourceTypeTemplateVersion",
|
||||
"ResourceTypeUser",
|
||||
"ResourceTypeWorkspace",
|
||||
"ResourceTypeWorkspaceBuild",
|
||||
"ResourceTypeGitSSHKey",
|
||||
"ResourceTypeAPIKey",
|
||||
"ResourceTypeGroup"
|
||||
]
|
||||
},
|
||||
"codersdk.Response": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@ -2812,7 +2972,8 @@
|
||||
"format": "uuid"
|
||||
},
|
||||
"provisioner": {
|
||||
"type": "string"
|
||||
"type": "string",
|
||||
"enum": ["terraform"]
|
||||
},
|
||||
"updated_at": {
|
||||
"type": "string",
|
||||
@ -2938,13 +3099,18 @@
|
||||
}
|
||||
},
|
||||
"status": {
|
||||
"type": "string"
|
||||
"$ref": "#/definitions/codersdk.UserStatus"
|
||||
},
|
||||
"username": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"codersdk.UserStatus": {
|
||||
"type": "string",
|
||||
"enum": ["active", "suspended"],
|
||||
"x-enum-varnames": ["UserStatusActive", "UserStatusSuspended"]
|
||||
},
|
||||
"codersdk.ValidationError": {
|
||||
"type": "object",
|
||||
"required": ["detail", "field"],
|
||||
@ -3084,8 +3250,12 @@
|
||||
"type": "string"
|
||||
},
|
||||
"status": {
|
||||
"type": "string",
|
||||
"enum": ["connecting", "connected", "disconnected", "timeout"]
|
||||
"enum": ["connecting", "connected", "disconnected", "timeout"],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.WorkspaceAgentStatus"
|
||||
}
|
||||
]
|
||||
},
|
||||
"troubleshooting_url": {
|
||||
"type": "string"
|
||||
@ -3157,6 +3327,16 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"codersdk.WorkspaceAgentStatus": {
|
||||
"type": "string",
|
||||
"enum": ["connecting", "connected", "disconnected", "timeout"],
|
||||
"x-enum-varnames": [
|
||||
"WorkspaceAgentConnecting",
|
||||
"WorkspaceAgentConnected",
|
||||
"WorkspaceAgentDisconnected",
|
||||
"WorkspaceAgentTimeout"
|
||||
]
|
||||
},
|
||||
"codersdk.WorkspaceApp": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@ -3172,11 +3352,15 @@
|
||||
"type": "boolean"
|
||||
},
|
||||
"health": {
|
||||
"type": "string"
|
||||
"$ref": "#/definitions/codersdk.WorkspaceAppHealth"
|
||||
},
|
||||
"healthcheck": {
|
||||
"description": "Healthcheck specifies the configuration for checking app health.",
|
||||
"$ref": "#/definitions/codersdk.Healthcheck"
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.Healthcheck"
|
||||
}
|
||||
]
|
||||
},
|
||||
"icon": {
|
||||
"description": "Icon is a relative path or external URL that specifies\nan icon to be displayed in the dashboard.",
|
||||
@ -3187,8 +3371,12 @@
|
||||
"format": "uuid"
|
||||
},
|
||||
"sharing_level": {
|
||||
"type": "string",
|
||||
"enum": ["owner", "authenticated", "public"]
|
||||
"enum": ["owner", "authenticated", "public"],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.WorkspaceAppSharingLevel"
|
||||
}
|
||||
]
|
||||
},
|
||||
"slug": {
|
||||
"description": "Slug is a unique identifier within the agent.",
|
||||
@ -3204,6 +3392,25 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"codersdk.WorkspaceAppHealth": {
|
||||
"type": "string",
|
||||
"enum": ["disabled", "initializing", "healthy", "unhealthy"],
|
||||
"x-enum-varnames": [
|
||||
"WorkspaceAppHealthDisabled",
|
||||
"WorkspaceAppHealthInitializing",
|
||||
"WorkspaceAppHealthHealthy",
|
||||
"WorkspaceAppHealthUnhealthy"
|
||||
]
|
||||
},
|
||||
"codersdk.WorkspaceAppSharingLevel": {
|
||||
"type": "string",
|
||||
"enum": ["owner", "authenticated", "public"],
|
||||
"x-enum-varnames": [
|
||||
"WorkspaceAppSharingLevelOwner",
|
||||
"WorkspaceAppSharingLevelAuthenticated",
|
||||
"WorkspaceAppSharingLevelPublic"
|
||||
]
|
||||
},
|
||||
"codersdk.WorkspaceBuild": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@ -3236,8 +3443,12 @@
|
||||
"$ref": "#/definitions/codersdk.ProvisionerJob"
|
||||
},
|
||||
"reason": {
|
||||
"type": "string",
|
||||
"enum": ["initiator", "autostart", "autostop"]
|
||||
"enum": ["initiator", "autostart", "autostop"],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.BuildReason"
|
||||
}
|
||||
]
|
||||
},
|
||||
"resources": {
|
||||
"type": "array",
|
||||
@ -3246,7 +3457,6 @@
|
||||
}
|
||||
},
|
||||
"status": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"pending",
|
||||
"starting",
|
||||
@ -3258,6 +3468,11 @@
|
||||
"canceled",
|
||||
"deleting",
|
||||
"deleted"
|
||||
],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.WorkspaceStatus"
|
||||
}
|
||||
]
|
||||
},
|
||||
"template_version_id": {
|
||||
@ -3268,8 +3483,12 @@
|
||||
"type": "string"
|
||||
},
|
||||
"transition": {
|
||||
"type": "string",
|
||||
"enum": ["start", "stop", "delete"]
|
||||
"enum": ["start", "stop", "delete"],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.WorkspaceTransition"
|
||||
}
|
||||
]
|
||||
},
|
||||
"updated_at": {
|
||||
"type": "string",
|
||||
@ -3334,8 +3553,12 @@
|
||||
"type": "string"
|
||||
},
|
||||
"workspace_transition": {
|
||||
"type": "string",
|
||||
"enum": ["start", "stop", "delete"]
|
||||
"enum": ["start", "stop", "delete"],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.WorkspaceTransition"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
@ -3353,6 +3576,42 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"codersdk.WorkspaceStatus": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"pending",
|
||||
"starting",
|
||||
"running",
|
||||
"stopping",
|
||||
"stopped",
|
||||
"failed",
|
||||
"canceling",
|
||||
"canceled",
|
||||
"deleting",
|
||||
"deleted"
|
||||
],
|
||||
"x-enum-varnames": [
|
||||
"WorkspaceStatusPending",
|
||||
"WorkspaceStatusStarting",
|
||||
"WorkspaceStatusRunning",
|
||||
"WorkspaceStatusStopping",
|
||||
"WorkspaceStatusStopped",
|
||||
"WorkspaceStatusFailed",
|
||||
"WorkspaceStatusCanceling",
|
||||
"WorkspaceStatusCanceled",
|
||||
"WorkspaceStatusDeleting",
|
||||
"WorkspaceStatusDeleted"
|
||||
]
|
||||
},
|
||||
"codersdk.WorkspaceTransition": {
|
||||
"type": "string",
|
||||
"enum": ["start", "stop", "delete"],
|
||||
"x-enum-varnames": [
|
||||
"WorkspaceTransitionStart",
|
||||
"WorkspaceTransitionStop",
|
||||
"WorkspaceTransitionDelete"
|
||||
]
|
||||
},
|
||||
"codersdk.WorkspacesResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@ -3367,9 +3626,6 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"netip.Addr": {
|
||||
"type": "object"
|
||||
},
|
||||
"tailcfg.DERPMap": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
|
||||
Reference in New Issue
Block a user