WIP

mtojek · mtojek · commit eef09e64191a · 2022-12-12T15:30:46.000+01:00
diff --git a/coderd/apidocs/docs.go b/coderd/apidocs/docs.go
@@ -38,7 +38,7 @@ const docTemplate = `{
                 "tags": [
                     "Workspaces"
                 ],
-                "summary": "List workspaces.",
+                "summary": "List workspaces",
                 "operationId": "get-workspaces",
                 "parameters": [
                     {
@@ -113,7 +113,7 @@ const docTemplate = `{
                 "tags": [
                     "Workspaces"
                 ],
-                "summary": "Get workspace metadata.",
+                "summary": "Get workspace metadata",
                 "operationId": "get-workspace",
                 "parameters": [
                     {
diff --git a/coderd/apidocs/swagger.json b/coderd/apidocs/swagger.json
@@ -30,7 +30,7 @@
                 "tags": [
                     "Workspaces"
                 ],
-                "summary": "List workspaces.",
+                "summary": "List workspaces",
                 "operationId": "get-workspaces",
                 "parameters": [
                     {
@@ -105,7 +105,7 @@
                 "tags": [
                     "Workspaces"
                 ],
-                "summary": "Get workspace metadata.",
+                "summary": "Get workspace metadata",
                 "operationId": "get-workspace",
                 "parameters": [
                     {
diff --git a/coderd/workspaces.go b/coderd/workspaces.go
@@ -43,7 +43,7 @@ var (
 	errDeadlineBeforeStart = xerrors.New("new deadline must be before workspace start time")
 )
 
-// @Summary Get workspace metadata.
+// @Summary Get workspace metadata
 // @ID get-workspace
 // @Security CoderSessionToken
 // @Produce json
@@ -105,7 +105,7 @@ func (api *API) workspace(rw http.ResponseWriter, r *http.Request) {
 	))
 }
 
-// @Summary List workspaces.
+// @Summary List workspaces
 // @ID get-workspaces
 // @Security CoderSessionToken
 // @Produce json
diff --git a/docs/api.md b/docs/api.md
@@ -21,7 +21,7 @@ License: <a href="https://github.com/coder/coder/blob/main/LICENSE">AGPL-3.0</a>
 
 <h1 id="coderd-api-workspaces">Workspaces</h1>
 
-## List workspaces.
+## List workspaces
 
 <a id="opIdget-workspaces"></a>
 
@@ -37,7 +37,7 @@ curl -X GET /api/v2/workspaces \
 
 `GET /workspaces`
 
-<h3 id="list-workspaces.-parameters">Parameters</h3>
+<h3 id="list-workspaces-parameters">Parameters</h3>
 
 |Name|In|Type|Required|Description|
 |---|---|---|---|---|
@@ -182,7 +182,7 @@ curl -X GET /api/v2/workspaces \
 }
 ```
 
-<h3 id="list-workspaces.-responses">Responses</h3>
+<h3 id="list-workspaces-responses">Responses</h3>
 
 |Status|Meaning|Description|Schema|
 |---|---|---|---|
@@ -195,7 +195,7 @@ To perform this operation, you must be authenticated by means of one of the foll
 CoderSessionToken
 </aside>
 
-## Get workspace metadata.
+## Get workspace metadata
 
 <a id="opIdget-workspace"></a>
 
@@ -211,7 +211,7 @@ curl -X GET /api/v2/workspaces/{id} \
 
 `GET /workspaces/{id}`
 
-<h3 id="get-workspace-metadata.-parameters">Parameters</h3>
+<h3 id="get-workspace-metadata-parameters">Parameters</h3>
 
 |Name|In|Type|Required|Description|
 |---|---|---|---|---|
@@ -351,7 +351,7 @@ curl -X GET /api/v2/workspaces/{id} \
 }
 ```
 
-<h3 id="get-workspace-metadata.-responses">Responses</h3>
+<h3 id="get-workspace-metadata-responses">Responses</h3>
 
 |Status|Meaning|Description|Schema|
 |---|---|---|---|
