Fix: examples

mtojek · mtojek · commit 16774093cc1c · 2022-12-16T14:22:29.000+01:00
diff --git a/Makefile b/Makefile
@@ -458,7 +458,7 @@ docs/admin/prometheus.md: scripts/metricsdocgen/main.go scripts/metricsdocgen/me
 	cd site
 	yarn run format:write ../docs/admin/prometheus.md
 
-coderd/apidoc/swagger.json: $(shell find ./scripts/apidocgen -not \( -path './scripts/apidocgen/node_modules' -prune \) -type f) $(wildcard coderd/*.go)
+coderd/apidoc/swagger.json: $(shell find ./scripts/apidocgen -not \( -path './scripts/apidocgen/node_modules' -prune \) -type f) $(wildcard coderd/*.go) $(wildcard codersdk/*.go)
 	./scripts/apidocgen/generate.sh
 	cd site
 	yarn run format:write ../docs/api ../docs/manifest.json ../coderd/apidoc/swagger.json
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
@@ -531,10 +531,12 @@ const docTemplate = `{
             "type": "object",
             "properties": {
                 "p50": {
-                    "type": "integer"
+                    "type": "integer",
+                    "example": 123
                 },
                 "p95": {
-                    "type": "integer"
+                    "type": "integer",
+                    "example": 146
                 }
             }
         },
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
@@ -486,10 +486,12 @@
       "type": "object",
       "properties": {
         "p50": {
-          "type": "integer"
+          "type": "integer",
+          "example": 123
         },
         "p95": {
-          "type": "integer"
+          "type": "integer",
+          "example": 146
         }
       }
     },
diff --git a/codersdk/templates.go b/codersdk/templates.go
@@ -36,8 +36,8 @@ type Template struct {
 }
 
 type TransitionStats struct {
-	P50 *int64
-	P95 *int64
+	P50 *int64 `example:"123"`
+	P95 *int64 `example:"146"`
 }
 
 type TemplateBuildTimeStats map[WorkspaceTransition]TransitionStats
diff --git a/docs/api/schemas.md b/docs/api/schemas.md
@@ -161,12 +161,12 @@
   "allow_user_cancel_workspace_jobs": true,
   "build_time_stats": {
     "property1": {
-      "p50": 0,
-      "p95": 0
+      "p50": 123,
+      "p95": 146
     },
     "property2": {
-      "p50": 0,
-      "p95": 0
+      "p50": 123,
+      "p95": 146
     }
   },
   "created_at": "string",
@@ -212,12 +212,12 @@
 ```json
 {
   "property1": {
-    "p50": 0,
-    "p95": 0
+    "p50": 123,
+    "p95": 146
   },
   "property2": {
-    "p50": 0,
-    "p95": 0
+    "p50": 123,
+    "p95": 146
   }
 }
 ```
@@ -232,8 +232,8 @@
 
 ```json
 {
-  "p50": 0,
-  "p95": 0
+  "p50": 123,
+  "p95": 146
 }
 ```
 
diff --git a/docs/api/templates.md b/docs/api/templates.md
@@ -56,12 +56,12 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization-id}/tem
   "allow_user_cancel_workspace_jobs": true,
   "build_time_stats": {
     "property1": {
-      "p50": 0,
-      "p95": 0
+      "p50": 123,
+      "p95": 146
     },
     "property2": {
-      "p50": 0,
-      "p95": 0
+      "p50": 123,
+      "p95": 146
     }
   },
   "created_at": "string",
@@ -119,12 +119,12 @@ curl -X GET http://coder-server:8080/api/v2/templates/{id} \
   "allow_user_cancel_workspace_jobs": true,
   "build_time_stats": {
     "property1": {
-      "p50": 0,
-      "p95": 0
+      "p50": 123,
+      "p95": 146
     },
     "property2": {
-      "p50": 0,
-      "p95": 0
+      "p50": 123,
+      "p95": 146
     }
   },
   "created_at": "string",

Original file line number	Diff line number	Diff line change
`@@ -36,8 +36,8 @@ type Template struct {`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`type TransitionStats struct {`
`39`		`- P50 *int64`
`40`		`- P95 *int64`
	`39`	+ P50 *int64 `example:"123"`
	`40`	+ P95 *int64 `example:"146"`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`type TemplateBuildTimeStats map[WorkspaceTransition]TransitionStats`