Tweaks

coder · BrunoQuaresma · Sep 16, 2024 · Sep 11, 2024 · Sep 12, 2024 · Sep 16, 2024
commit 4015216374bfb8986ba491dd1349d27a1aa495ca
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/workspaces.go b/coderd/workspaces.go
@@ -1740,8 +1740,8 @@ func (api *API) watchWorkspace(rw http.ResponseWriter, r *http.Request) {
 	}
 }
 
-// @Summary Return workspace timings by ID
-// @ID workspace-timings-by-id
+// @Summary Get workspace timings by ID
+// @ID get-workspace-timings-by-id
 // @Security CoderSessionToken
 // @Produce json
 // @Tags Workspaces

diff --git a/coderd/workspaces_test.go b/coderd/workspaces_test.go
@@ -3659,7 +3659,7 @@ func TestWorkspaceTimings(t *testing.T) {
 	}
 
 	// Given
-	tests := []struct {
+	testCases := []struct {
 		name               string
 		provisionerTimings int
 		workspace          workspaceWithBuild
@@ -3688,27 +3688,28 @@ func TestWorkspaceTimings(t *testing.T) {
 		},
 	}
 
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
+	for _, tc := range testCases {
+		tc := tc
+		t.Run(tc.name, func(t *testing.T) {
 			t.Parallel()
 
 			// Generate timings based on test config
-			generatedTimings := make([]database.ProvisionerJobTiming, tt.provisionerTimings)
-			if tt.provisionerTimings > 0 {
-				generatedTimings = makeProvisionerTimings(tt.workspace.build.JobID, tt.provisionerTimings)
+			generatedTimings := make([]database.ProvisionerJobTiming, tc.provisionerTimings)
+			if tc.provisionerTimings > 0 {
+				generatedTimings = makeProvisionerTimings(tc.workspace.build.JobID, tc.provisionerTimings)
 			}
-			res, err := client.WorkspaceTimings(context.Background(), tt.workspace.ID)
+			res, err := client.WorkspaceTimings(context.Background(), tc.workspace.ID)
 
 			// When error is expected, than an error is returned
-			if tt.error {
+			if tc.error {
 				require.Error(t, err)
 				return
 			}
 
 			// When success is expected, than no error is returned and the length and
 			// fields are correctly returned
 			require.NoError(t, err)
-			require.Len(t, res, tt.provisionerTimings)
+			require.Len(t, res, tc.provisionerTimings)
 			for i := range res.ProvisionerTimings {
 				timingRes := res.ProvisionerTimings[i]
 				require.Equal(t, generatedTimings[i].Resource, timingRes.Resource)

diff --git a/codersdk/workspaces.go b/codersdk/workspaces.go
@@ -638,6 +638,7 @@ type ProvisionerTiming struct {
 
 type WorkspaceTimings struct {
 	ProvisionerTimings []ProvisionerTiming `json:"provisioner_timings"`
+	// TODO: Add AgentScriptTimings when it is done https://github.com/coder/coder/issues/14630
 }
 
 func (c *Client) WorkspaceTimings(ctx context.Context, id uuid.UUID) (WorkspaceTimings, error) {

diff --git a/docs/reference/api/workspaces.md b/docs/reference/api/workspaces.md