Skip to content

Commit 9a2493b

Browse files
committed
WIP
1 parent 484f1e9 commit 9a2493b

File tree

3 files changed

+11
-16
lines changed

3 files changed

+11
-16
lines changed

coderd/apidocs/docs.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ const docTemplate = `{
2929

3030
// SwaggerInfo holds exported Swagger Info so clients can modify it
3131
var SwaggerInfo = &swag.Spec{
32-
Version: "1.0",
33-
Host: "dev.coder.com",
34-
BasePath: "/v2",
32+
Version: "2.0",
33+
Host: "",
34+
BasePath: "",
3535
Schemes: []string{},
36-
Title: "Coder API",
37-
Description: "Coderd API",
36+
Title: "Coderd API",
37+
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.",
3838
InfoInstanceName: "swagger",
3939
SwaggerTemplate: docTemplate,
4040
}

coderd/apidocs/swagger.json

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"swagger": "2.0",
33
"info": {
4-
"description": "Coderd API",
5-
"title": "Coder API",
4+
"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.",
5+
"title": "Coderd API",
66
"termsOfService": "https://coder.com/legal/terms-of-service",
77
"contact": {
88
"name": "API Support",
@@ -13,9 +13,7 @@
1313
"name": "AGPL-3.0",
1414
"url": "https://github.com/coder/coder/blob/main/LICENSE"
1515
},
16-
"version": "1.0"
16+
"version": "2.0"
1717
},
18-
"host": "dev.coder.com",
19-
"basePath": "/v2",
2018
"paths": {}
2119
}

coderd/coderd.go

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -111,9 +111,9 @@ type Options struct {
111111
UpdateCheckOptions *updatecheck.Options // Set non-nil to enable update checking.
112112
}
113113

114-
// @title Coder API
115-
// @version 1.0
116-
// @description Coderd API
114+
// @title Coderd API
115+
// @version 2.0
116+
// @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.
117117
// @termsOfService https://coder.com/legal/terms-of-service
118118

119119
// @contact.name API Support
@@ -122,9 +122,6 @@ type Options struct {
122122

123123
// @license.name AGPL-3.0
124124
// @license.url https://github.com/coder/coder/blob/main/LICENSE
125-
126-
// @host dev.coder.com
127-
// @BasePath /v2
128125
// New constructs a Coder API handler.
129126
func New(options *Options) *API {
130127
if options == nil {

0 commit comments

Comments
 (0)