enums

mtojek · mtojek · commit b928fff0649c · 2022-12-21T18:41:06.000+01:00
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
@@ -1193,13 +1193,31 @@ const docTemplate = `{
             "type": "object",
             "properties": {
                 "action": {
-                    "type": "string"
+                    "type": "string",
+                    "enum": [
+                        "create",
+                        "write",
+                        "delete",
+                        "start",
+                        "stop"
+                    ]
                 },
                 "resource_id": {
                     "type": "string"
                 },
                 "resource_type": {
-                    "type": "string"
+                    "type": "string",
+                    "enum": [
+                        "organization",
+                        "template",
+                        "template_version",
+                        "user",
+                        "workspace",
+                        "workspace_build",
+                        "git_ssh_key",
+                        "api_key",
+                        "group"
+                    ]
                 },
                 "time": {
                     "type": "string"
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
@@ -1059,13 +1059,25 @@
       "type": "object",
       "properties": {
         "action": {
-          "type": "string"
+          "type": "string",
+          "enum": ["create", "write", "delete", "start", "stop"]
         },
         "resource_id": {
           "type": "string"
         },
         "resource_type": {
-          "type": "string"
+          "type": "string",
+          "enum": [
+            "organization",
+            "template",
+            "template_version",
+            "user",
+            "workspace",
+            "workspace_build",
+            "git_ssh_key",
+            "api_key",
+            "group"
+          ]
         },
         "time": {
           "type": "string"
diff --git a/codersdk/audit.go b/codersdk/audit.go
@@ -121,8 +121,8 @@ type AuditLogResponse struct {
 }
 
 type CreateTestAuditLogRequest struct {
-	Action       AuditAction  `json:"action,omitempty"`
-	ResourceType ResourceType `json:"resource_type,omitempty"`
+	Action       AuditAction  `json:"action,omitempty" enums:"create,write,delete,start,stop"`
+	ResourceType ResourceType `json:"resource_type,omitempty" enums:"organization,template,template_version,user,workspace,workspace_build,git_ssh_key,api_key,group"`
 	ResourceID   uuid.UUID    `json:"resource_id,omitempty"`
 	Time         time.Time    `json:"time,omitempty"`
 }
diff --git a/docs/api/audit.md b/docs/api/audit.md
@@ -107,9 +107,9 @@ curl -X POST http://coder-server:8080/api/v2/audit/testgenerate \
 
 ```json
 {
-  "action": "string",
+  "action": "create",
   "resource_id": "string",
-  "resource_type": "string",
+  "resource_type": "organization",
   "time": "string"
 }
 ```
diff --git a/docs/api/schemas.md b/docs/api/schemas.md
@@ -386,9 +386,9 @@ CreateParameterRequest is a structure used to create a new parameter value for a
 
 ```json
 {
-  "action": "string",
+  "action": "create",
   "resource_id": "string",
-  "resource_type": "string",
+  "resource_type": "organization",
   "time": "string"
 }
 ```
@@ -402,6 +402,25 @@ CreateParameterRequest is a structure used to create a new parameter value for a
 | `resource_type` | string | false    |              |             |
 | `time`          | string | false    |              |             |
 
+#### Enumerated Values
+
+| Property        | Value              |
+| --------------- | ------------------ |
+| `action`        | `create`           |
+| `action`        | `write`            |
+| `action`        | `delete`           |
+| `action`        | `start`            |
+| `action`        | `stop`             |
+| `resource_type` | `organization`     |
+| `resource_type` | `template`         |
+| `resource_type` | `template_version` |
+| `resource_type` | `user`             |
+| `resource_type` | `workspace`        |
+| `resource_type` | `workspace_build`  |
+| `resource_type` | `git_ssh_key`      |
+| `resource_type` | `api_key`          |
+| `resource_type` | `group`            |
+
 ## codersdk.DERP
 
 ```json

Original file line number	Diff line number	Diff line change
`@@ -121,8 +121,8 @@ type AuditLogResponse struct {`
`121`	`121`	`}`
`122`	`122`
`123`	`123`	`type CreateTestAuditLogRequest struct {`
`124`		- Action AuditAction `json:"action,omitempty"`
`125`		- ResourceType ResourceType `json:"resource_type,omitempty"`
	`124`	+ Action AuditAction `json:"action,omitempty" enums:"create,write,delete,start,stop"`
	`125`	+ ResourceType ResourceType `json:"resource_type,omitempty" enums:"organization,template,template_version,user,workspace,workspace_build,git_ssh_key,api_key,group"`
`126`	`126`	ResourceID uuid.UUID `json:"resource_id,omitempty"`
`127`	`127`	Time time.Time `json:"time,omitempty"`
`128`	`128`	`}`
Original file line number	Diff line number	Diff line change
`@@ -107,9 +107,9 @@ curl -X POST http://coder-server:8080/api/v2/audit/testgenerate \`
`107`	`107`
`108`	`108`	```json
`109`	`109`	`{`
`110`		`- "action": "string",`
	`110`	`+ "action": "create",`
`111`	`111`	`"resource_id": "string",`
`112`		`- "resource_type": "string",`
	`112`	`+ "resource_type": "organization",`
`113`	`113`	`"time": "string"`
`114`	`114`	`}`
`115`	`115`	```