NotificationsYou must be signed in to change notification settings
Fork1k
Star11.1k

Commit8afb10e

authored

chore: improve validation of Security tag in swaggerparser (#15660)

Aims toresolve#15605 There's currently one option valid for the `@Security` tag inswaggerparser - which fails in the CI if we try to put any other value.At least one of our endpoints does not accept `CoderSessionToken` as anoption for the authentication and so we need to add new possibilities inorder to keep the documentation up-to-date.In this PR , I added `ProvisionerKey` which is the way our provisionerdaemon can authenticate to the backend - also modified a bit the code tosimplify other options later.

1 parent60ddcf5 commit8afb10eCopy full SHA for 8afb10e

File tree

5 files changed

+10

-6

lines changed

coderd
- apidoc
  - docs.go
  - swagger.json
- coderdtest
  - swaggerparser.go
docs/reference/api
- enterprise.md
enterprise/coderd
- provisionerkeys.go

5 files changed

+10

-6

lines changed

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`	`funcassertSecurityDefined(t*testing.T,commentSwaggerComment) {`
	`303`	`+authorizedSecurityTags:= []string{`
	`304`	`+"CoderSessionToken",`
	`305`	`+"CoderProvisionerKey",`
	`306`	`+}`
	`307`	`+`
`303`	`308`	`ifcomment.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 beequal CoderSessionToken")`
	`316`	`+assert.Containsf(t,authorizedSecurityTags,comment.security,"@Security must beeither of these options: %v",authorizedSecurityTags)`
`312`	`317`	`}`
`313`	`318`
`314`	`319`	`funcassertAccept(t*testing.T,commentSwaggerComment) {`

`‎docs/reference/api/enterprise.md‎`

Lines changed: 1 addition & 2 deletions

Some generated files are not rendered by default. Learn more aboutcustomizing how changed files appear on GitHub.

`‎enterprise/coderd/provisionerkeys.go‎`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -202,7 +202,7 @@ func (api API) deleteProvisionerKey(rw http.ResponseWriter, r http.Request) {`
`202`	`202`
`203`	`203`	`// @Summary Fetch provisioner key details`
`204`	`204`	`// @ID fetch-provisioner-key-details`
`205`		`-// @SecurityCoderSessionToken`
	`205`	`+// @SecurityCoderProvisionerKey`
`206`	`206`	`// @Produce json`
`207`	`207`	`// @Tags Enterprise`
`208`	`208`	`// @Param provisionerkey path string true "Provisioner Key"`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit8afb10e

File tree

5 files changed

5 files changed

`‎coderd/apidoc/docs.go‎`

`‎coderd/apidoc/swagger.json‎`

`‎coderd/coderdtest/swaggerparser.go‎`

`‎docs/reference/api/enterprise.md‎`

`‎enterprise/coderd/provisionerkeys.go‎`

0 commit comments