Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 59de7a0

Browse files
committed
Rephrased
1 parent 6c6c509 commit 59de7a0

File tree

5 files changed

+17
-22
lines changed

5 files changed

+17
-22
lines changed

coderd/apidoc/docs.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -898,7 +898,7 @@ const docTemplate = `{
898898
"type": "object",
899899
"properties": {
900900
"external_url": {
901-
"description": "ExternalURL is a URL referencing the current Coder version. For production\nbuilds, this will link directly to a release. For development builds, this\nwill link to a commit.",
901+
"description": "ExternalURL is a URL referencing the current Coder version.\nFor production builds, this will link directly to a release. For development builds, this will link to a commit.",
902902
"type": "string"
903903
},
904904
"version": {
@@ -1188,15 +1188,15 @@ const docTemplate = `{
11881188
"type": "object",
11891189
"properties": {
11901190
"current": {
1191-
"description": "Current is a boolean indicating whether the\nserver version is the same as the latest.",
1191+
"description": "Current indicates whether the server version is the same as the latest.",
11921192
"type": "boolean"
11931193
},
11941194
"url": {
11951195
"description": "URL to download the latest release of Coder.",
11961196
"type": "string"
11971197
},
11981198
"version": {
1199-
"description": "Version is the semantic version for the latest\nrelease of Coder.",
1199+
"description": "Version is the semantic version for the latest release of Coder.",
12001200
"type": "string"
12011201
}
12021202
}

coderd/apidoc/swagger.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -784,7 +784,7 @@
784784
"type": "object",
785785
"properties": {
786786
"external_url": {
787-
"description": "ExternalURL is a URL referencing the current Coder version. For production\nbuilds, this will link directly to a release. For development builds, this\nwill link to a commit.",
787+
"description": "ExternalURL is a URL referencing the current Coder version.\nFor production builds, this will link directly to a release. For development builds, this will link to a commit.",
788788
"type": "string"
789789
},
790790
"version": {
@@ -1064,15 +1064,15 @@
10641064
"type": "object",
10651065
"properties": {
10661066
"current": {
1067-
"description": "Current is a boolean indicating whether the\nserver version is the same as the latest.",
1067+
"description": "Current indicates whether the server version is the same as the latest.",
10681068
"type": "boolean"
10691069
},
10701070
"url": {
10711071
"description": "URL to download the latest release of Coder.",
10721072
"type": "string"
10731073
},
10741074
"version": {
1075-
"description": "Version is the semantic version for the latest\nrelease of Coder.",
1075+
"description": "Version is the semantic version for the latest release of Coder.",
10761076
"type": "string"
10771077
}
10781078
}

codersdk/buildinfo.go

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,8 @@ import (
1111

1212
// BuildInfoResponse contains build information for this instance of Coder.
1313
type BuildInfoResponse struct {
14-
// ExternalURL is a URL referencing the current Coder version. For production
15-
// builds, this will link directly to a release. For development builds, this
16-
// will link to a commit.
14+
// ExternalURL is a URL referencing the current Coder version.
15+
// For production builds, this will link directly to a release. For development builds, this will link to a commit.
1716
ExternalURL string `json:"external_url"`
1817
// Version returns the semantic version of the build.
1918
Version string `json:"version"`

codersdk/updatecheck.go

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,17 @@ import (
66
"net/http"
77
)
88

9-
// UpdateCheckResponse contains information
10-
// on the latest release of Coder.
9+
// UpdateCheckResponse contains information on the latest release of Coder.
1110
type UpdateCheckResponse struct {
12-
// Current is a boolean indicating whether the
13-
// server version is the same as the latest.
11+
// Current indicates whether the server version is the same as the latest.
1412
Current bool `json:"current"`
15-
// Version is the semantic version for the latest
16-
// release of Coder.
13+
// Version is the semantic version for the latest release of Coder.
1714
Version string `json:"version"`
1815
// URL to download the latest release of Coder.
1916
URL string `json:"url"`
2017
}
2118

22-
// UpdateCheck returns information about the latest release version of
23-
// Coder and whether or not the server is running the latest release.
19+
// UpdateCheck returns information about the latest release version of Coder and whether or not the server is running the latest release.
2420
func (c *Client) UpdateCheck(ctx context.Context) (UpdateCheckResponse, error) {
2521
res, err := c.Request(ctx, http.MethodGet, "/api/v2/updatecheck", nil)
2622
if err != nil {

docs/api/schemas.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -429,11 +429,11 @@ CreateParameterRequest is a structure used to create a new parameter value for a
429429

430430
### Properties
431431

432-
| Name | Type | Required | Restrictions | Description |
433-
| --------- | ------- | -------- | ------------ | ------------------------------------------------------------------------------------- |
434-
| `current` | boolean | false | | Current is a boolean indicating whether the server version is the same as the latest. |
435-
| `url` | string | false | | Url to download the latest release of Coder. |
436-
| `version` | string | false | | Version is the semantic version for the latest release of Coder. |
432+
| Name | Type | Required | Restrictions | Description |
433+
| --------- | ------- | -------- | ------------ | ----------------------------------------------------------------------- |
434+
| `current` | boolean | false | | Current indicates whether the server version is the same as the latest. |
435+
| `url` | string | false | | Url to download the latest release of Coder. |
436+
| `version` | string | false | | Version is the semantic version for the latest release of Coder. |
437437

438438
## codersdk.UpdateWorkspaceAutostartRequest
439439

0 commit comments

Comments
 (0)