Fix: string uuid

mtojek · mtojek · commit 8a0aa363e103 · 2022-12-15T17:42:29.000+01:00
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
@@ -98,6 +98,7 @@ const docTemplate = `{
                 "parameters": [
                     {
                         "type": "string",
+                        "format": "uuid",
                         "description": "Template ID",
                         "name": "id",
                         "in": "path",
@@ -219,6 +220,7 @@ const docTemplate = `{
                 "parameters": [
                     {
                         "type": "string",
+                        "format": "uuid",
                         "description": "Workspace ID",
                         "name": "id",
                         "in": "path",
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
@@ -90,6 +90,7 @@
                 "parameters": [
                     {
                         "type": "string",
+                        "format": "uuid",
                         "description": "Template ID",
                         "name": "id",
                         "in": "path",
@@ -211,6 +212,7 @@
                 "parameters": [
                     {
                         "type": "string",
+                        "format": "uuid",
                         "description": "Workspace ID",
                         "name": "id",
                         "in": "path",
diff --git a/coderd/templates.go b/coderd/templates.go
@@ -39,7 +39,7 @@ const (
 // @Security CoderSessionToken
 // @Produce json
 // @Tags Templates
-// @Param id path string true "Template ID"
+// @Param id path string true "Template ID" format(uuid)
 // @Success 200 {object} codersdk.Template
 // @Failure 404 {object} codersdk.Response
 // @Failure 500 {object} codersdk.Response
diff --git a/coderd/workspaces.go b/coderd/workspaces.go
@@ -48,7 +48,7 @@ var (
 // @Security CoderSessionToken
 // @Produce json
 // @Tags Workspaces
-// @Param id path string true "Workspace ID"
+// @Param id path string true "Workspace ID" format(uuid)
 // @Param include_deleted query string false "Include deleted"
 // @Success 200 {object} codersdk.Workspace
 // @Failure 400 {object} codersdk.Response
diff --git a/docs/api/templates.md b/docs/api/templates.md
@@ -106,9 +106,9 @@ curl -X GET http://coder-server:8080/api/v2/templates/{id} \
 
 ### Parameters
 
-| Name | In   | Type   | Required | Description |
-| ---- | ---- | ------ | -------- | ----------- |
-| id   | path | string | true     | Template ID |
+| Name | In   | Type         | Required | Description |
+| ---- | ---- | ------------ | -------- | ----------- |
+| id   | path | string(uuid) | true     | Template ID |
 
 ### Example responses
 
diff --git a/docs/api/workspaces.md b/docs/api/workspaces.md
@@ -187,10 +187,10 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{id} \
 
 ### Parameters
 
-| Name            | In    | Type   | Required | Description     |
-| --------------- | ----- | ------ | -------- | --------------- |
-| id              | path  | string | true     | Workspace ID    |
-| include_deleted | query | string | false    | Include deleted |
+| Name            | In    | Type         | Required | Description     |
+| --------------- | ----- | ------------ | -------- | --------------- |
+| id              | path  | string(uuid) | true     | Workspace ID    |
+| include_deleted | query | string       | false    | Include deleted |
 
 ### Example responses
 
