Fix: rename Coderd API to Coder API

mtojek · mtojek · commit 79285d250f24 · 2022-12-15T17:20:08.000+01:00
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
@@ -857,7 +857,7 @@ var SwaggerInfo = &swag.Spec{
 	Host:             "",
 	BasePath:         "/api/v2",
 	Schemes:          []string{},
-	Title:            "Coderd API",
+	Title:            "Coder API",
 	Description:      "Coderd is the service created by running coder server. It is a thin API that connects workspaces, provisioners and users. coderd stores its state in Postgres and is the only service that communicates with Postgres.",
 	InfoInstanceName: "swagger",
 	SwaggerTemplate:  docTemplate,
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
@@ -2,7 +2,7 @@
     "swagger": "2.0",
     "info": {
         "description": "Coderd is the service created by running coder server. It is a thin API that connects workspaces, provisioners and users. coderd stores its state in Postgres and is the only service that communicates with Postgres.",
-        "title": "Coderd API",
+        "title": "Coder API",
         "termsOfService": "https://coder.com/legal/terms-of-service",
         "contact": {
             "name": "API Support",
diff --git a/coderd/coderd.go b/coderd/coderd.go
@@ -117,7 +117,7 @@ type Options struct {
 	HTTPClient *http.Client
 }
 
-// @title Coderd API
+// @title Coder API
 // @version 2.0
 // @description Coderd is the service created by running coder server. It is a thin API that connects workspaces, provisioners and users. coderd stores its state in Postgres and is the only service that communicates with Postgres.
 // @termsOfService https://coder.com/legal/terms-of-service
diff --git a/docs/api/index.md b/docs/api/index.md
@@ -1,4 +1,4 @@
-Get started with Coderd API:
+Get started with Coder API:
 
 <children>
   This page is rendered on https://coder.com/docs/coder-oss/api. Refer to the other documents in the `api/` directory.
diff --git a/scripts/apidocgen/postprocess/main.go b/scripts/apidocgen/postprocess/main.go
@@ -17,7 +17,7 @@ import (
 const (
 	apiSubdir       = "api"
 	apiIndexFile    = "index.md"
-	apiIndexContent = `Get started with Coderd API:
+	apiIndexContent = `Get started with Coder API:
 
 <children>
   This page is rendered on https://coder.com/docs/coder-oss/api. Refer to the other documents in the ` + "`" + `api/` + "`" + ` directory.

Original file line number	Diff line number	Diff line change
`@@ -117,7 +117,7 @@ type Options struct {`
`117`	`117`	`HTTPClient *http.Client`
`118`	`118`	`}`
`119`	`119`
`120`		`-// @title Coderd API`
	`120`	`+// @title Coder API`
`121`	`121`	`// @version 2.0`
`122`	`122`	`// @description Coderd is the service created by running coder server. It is a thin API that connects workspaces, provisioners and users. coderd stores its state in Postgres and is the only service that communicates with Postgres.`
`123`	`123`	`// @termsOfService https://coder.com/legal/terms-of-service`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-Get started with Coderd API:`
	`1`	`+Get started with Coder API:`
`2`	`2`
`3`	`3`	`<children>`
`4`	`4`	This page is rendered on https://coder.com/docs/coder-oss/api. Refer to the other documents in the `api/` directory.