improve swaggerparser

defelmnq · defelmnq · commit 5bdae832a17b · 2024-11-26T04:36:04.000Z
diff --git a/coderd/coderdtest/swaggerparser.go b/coderd/coderdtest/swaggerparser.go
@@ -300,6 +300,11 @@ func assertPathParametersDefined(t *testing.T, comment SwaggerComment) {
 }
 
 func assertSecurityDefined(t *testing.T, comment SwaggerComment) {
+	var authorizedSecurityTags = []string{
+		"CoderSessionToken",
+		"ProvisionerKey",
+	}
+
 	if comment.router == "/updatecheck" ||
 		comment.router == "/buildinfo" ||
 		comment.router == "/" ||
@@ -308,7 +313,7 @@ func assertSecurityDefined(t *testing.T, comment SwaggerComment) {
 		comment.router == "/users/otp/change-password" {
 		return // endpoints do not require authorization
 	}
-	assert.Equal(t, "CoderSessionToken", comment.security, "@Security must be equal CoderSessionToken")
+	assert.Containsf(t, authorizedSecurityTags, comment.security, "@Security must be in %v", authorizedSecurityTags)
 }
 
 func assertAccept(t *testing.T, comment SwaggerComment) {
diff --git a/enterprise/coderd/provisionerkeys.go b/enterprise/coderd/provisionerkeys.go
@@ -202,7 +202,7 @@ func (api *API) deleteProvisionerKey(rw http.ResponseWriter, r *http.Request) {
 
 // @Summary Fetch provisioner key details
 // @ID fetch-provisioner-key-details
-// @Security CoderSessionToken
+// @Security ProvisionerKey
 // @Produce json
 // @Tags Enterprise
 // @Param provisionerkey path string true "Provisioner Key"

Original file line number	Diff line number	Diff line change
`@@ -300,6 +300,11 @@ func assertPathParametersDefined(t *testing.T, comment SwaggerComment) {`
`300`	`300`	`}`
`301`	`301`
`302`	`302`	`func assertSecurityDefined(t *testing.T, comment SwaggerComment) {`
	`303`	`+ var authorizedSecurityTags = []string{`
	`304`	`+ "CoderSessionToken",`
	`305`	`+ "ProvisionerKey",`
	`306`	`+ }`
	`307`	`+`
`303`	`308`	`if comment.router == "/updatecheck" \|\|`
`304`	`309`	`comment.router == "/buildinfo" \|\|`
`305`	`310`	`comment.router == "/" \|\|`
`@@ -308,7 +313,7 @@ func assertSecurityDefined(t *testing.T, comment SwaggerComment) {`
`308`	`313`	`comment.router == "/users/otp/change-password" {`
`309`	`314`	`return // endpoints do not require authorization`
`310`	`315`	`}`
`311`		`- assert.Equal(t, "CoderSessionToken", comment.security, "@Security must be equal CoderSessionToken")`
	`316`	`+ assert.Containsf(t, authorizedSecurityTags, comment.security, "@Security must be in %v", authorizedSecurityTags)`
`312`	`317`	`}`
`313`	`318`
`314`	`319`	`func assertAccept(t *testing.T, comment SwaggerComment) {`