From 94be94e0e87192a3de73983cb0e6b25ff0bf46d8 Mon Sep 17 00:00:00 2001 From: Colin Adler Date: Wed, 23 Oct 2024 19:51:56 +0000 Subject: [PATCH 1/2] fix scim swagger --- coderd/apidoc/docs.go | 13 +++++++++---- coderd/apidoc/swagger.json | 13 +++++++++---- coderd/coderd.go | 4 ++++ coderd/database/models.go | 2 +- coderd/database/querier.go | 2 +- coderd/database/queries.sql.go | 2 +- docs/reference/api/enterprise.md | 8 ++++---- enterprise/coderd/scim.go | 8 ++++---- 8 files changed, 33 insertions(+), 19 deletions(-) diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go index 37afc0ec80653..33d94b4cdead4 100644 --- a/coderd/apidoc/docs.go +++ b/coderd/apidoc/docs.go @@ -3627,7 +3627,7 @@ const docTemplate = `{ "get": { "security": [ { - "CoderSessionToken": [] + "Authorization": [] } ], "produces": [ @@ -3647,7 +3647,7 @@ const docTemplate = `{ "post": { "security": [ { - "CoderSessionToken": [] + "Authorization": [] } ], "produces": [ @@ -3683,7 +3683,7 @@ const docTemplate = `{ "get": { "security": [ { - "CoderSessionToken": [] + "Authorization": [] } ], "produces": [ @@ -3713,7 +3713,7 @@ const docTemplate = `{ "patch": { "security": [ { - "CoderSessionToken": [] + "Authorization": [] } ], "produces": [ @@ -16050,6 +16050,11 @@ const docTemplate = `{ } }, "securityDefinitions": { + "Authorization": { + "type": "apiKey", + "name": "Authorizaiton", + "in": "header" + }, "CoderSessionToken": { "type": "apiKey", "name": "Coder-Session-Token", diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json index 9c511d9f07068..5f83206f2509e 100644 --- a/coderd/apidoc/swagger.json +++ b/coderd/apidoc/swagger.json @@ -3193,7 +3193,7 @@ "get": { "security": [ { - "CoderSessionToken": [] + "Authorization": [] } ], "produces": ["application/scim+json"], @@ -3209,7 +3209,7 @@ "post": { "security": [ { - "CoderSessionToken": [] + "Authorization": [] } ], "produces": ["application/json"], @@ -3241,7 +3241,7 @@ "get": { "security": [ { - "CoderSessionToken": [] + "Authorization": [] } ], "produces": ["application/scim+json"], @@ -3267,7 +3267,7 @@ "patch": { "security": [ { - "CoderSessionToken": [] + "Authorization": [] } ], "produces": ["application/scim+json"], @@ -14685,6 +14685,11 @@ } }, "securityDefinitions": { + "Authorization": { + "type": "apiKey", + "name": "Authorizaiton", + "in": "header" + }, "CoderSessionToken": { "type": "apiKey", "name": "Coder-Session-Token", diff --git a/coderd/coderd.go b/coderd/coderd.go index 2cb2388fa77a0..d916b0bbc5897 100644 --- a/coderd/coderd.go +++ b/coderd/coderd.go @@ -263,6 +263,10 @@ type Options struct { // @BasePath /api/v2 +// @securitydefinitions.apiKey Authorization +// @in header +// @name Authorizaiton + // @securitydefinitions.apiKey CoderSessionToken // @in header // @name Coder-Session-Token diff --git a/coderd/database/models.go b/coderd/database/models.go index a5a1679b5b55c..5026e5ff89235 100644 --- a/coderd/database/models.go +++ b/coderd/database/models.go @@ -1,6 +1,6 @@ // Code generated by sqlc. DO NOT EDIT. // versions: -// sqlc v1.25.0 +// sqlc v1.27.0 package database diff --git a/coderd/database/querier.go b/coderd/database/querier.go index cad3df1cd6834..bf939397473f5 100644 --- a/coderd/database/querier.go +++ b/coderd/database/querier.go @@ -1,6 +1,6 @@ // Code generated by sqlc. DO NOT EDIT. // versions: -// sqlc v1.25.0 +// sqlc v1.27.0 package database diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go index 74990ab1103bd..2ff93bceeaeb5 100644 --- a/coderd/database/queries.sql.go +++ b/coderd/database/queries.sql.go @@ -1,6 +1,6 @@ // Code generated by sqlc. DO NOT EDIT. // versions: -// sqlc v1.25.0 +// sqlc v1.27.0 package database diff --git a/docs/reference/api/enterprise.md b/docs/reference/api/enterprise.md index 32dab3dc43ac5..fef0fd9d19c7d 100644 --- a/docs/reference/api/enterprise.md +++ b/docs/reference/api/enterprise.md @@ -2014,7 +2014,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio ```shell # Example request using curl curl -X GET http://coder-server:8080/api/v2/scim/v2/Users \ - -H 'Coder-Session-Token: API_KEY' + -H 'Authorizaiton: API_KEY' ``` `GET /scim/v2/Users` @@ -2036,7 +2036,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio curl -X POST http://coder-server:8080/api/v2/scim/v2/Users \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ - -H 'Coder-Session-Token: API_KEY' + -H 'Authorizaiton: API_KEY' ``` `POST /scim/v2/Users` @@ -2118,7 +2118,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio ```shell # Example request using curl curl -X GET http://coder-server:8080/api/v2/scim/v2/Users/{id} \ - -H 'Coder-Session-Token: API_KEY' + -H 'Authorizaiton: API_KEY' ``` `GET /scim/v2/Users/{id}` @@ -2146,7 +2146,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio curl -X PATCH http://coder-server:8080/api/v2/scim/v2/Users/{id} \ -H 'Content-Type: application/json' \ -H 'Accept: application/scim+json' \ - -H 'Coder-Session-Token: API_KEY' + -H 'Authorizaiton: API_KEY' ``` `PATCH /scim/v2/Users/{id}` diff --git a/enterprise/coderd/scim.go b/enterprise/coderd/scim.go index 45390b6014a6a..fad02455a0bab 100644 --- a/enterprise/coderd/scim.go +++ b/enterprise/coderd/scim.go @@ -46,7 +46,7 @@ func (api *API) scimVerifyAuthHeader(r *http.Request) bool { // // @Summary SCIM 2.0: Get users // @ID scim-get-users -// @Security CoderSessionToken +// @Security Authorization // @Produce application/scim+json // @Tags Enterprise // @Success 200 @@ -73,7 +73,7 @@ func (api *API) scimGetUsers(rw http.ResponseWriter, r *http.Request) { // // @Summary SCIM 2.0: Get user by ID // @ID scim-get-user-by-id -// @Security CoderSessionToken +// @Security Authorization // @Produce application/scim+json // @Tags Enterprise // @Param id path string true "User ID" format(uuid) @@ -124,7 +124,7 @@ var SCIMAuditAdditionalFields = map[string]string{ // // @Summary SCIM 2.0: Create new user // @ID scim-create-new-user -// @Security CoderSessionToken +// @Security Authorization // @Produce json // @Tags Enterprise // @Param request body coderd.SCIMUser true "New user" @@ -260,7 +260,7 @@ func (api *API) scimPostUser(rw http.ResponseWriter, r *http.Request) { // // @Summary SCIM 2.0: Update user account // @ID scim-update-user-status -// @Security CoderSessionToken +// @Security Authorization // @Produce application/scim+json // @Tags Enterprise // @Param id path string true "User ID" format(uuid) From 136d98a895f359345be7dae7124fb663e43c1f21 Mon Sep 17 00:00:00 2001 From: Colin Adler Date: Fri, 25 Oct 2024 16:36:33 +0000 Subject: [PATCH 2/2] fixup! fix scim swagger --- coderd/database/models.go | 2 +- coderd/database/querier.go | 2 +- coderd/database/queries.sql.go | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/coderd/database/models.go b/coderd/database/models.go index 5026e5ff89235..a5a1679b5b55c 100644 --- a/coderd/database/models.go +++ b/coderd/database/models.go @@ -1,6 +1,6 @@ // Code generated by sqlc. DO NOT EDIT. // versions: -// sqlc v1.27.0 +// sqlc v1.25.0 package database diff --git a/coderd/database/querier.go b/coderd/database/querier.go index bf939397473f5..cad3df1cd6834 100644 --- a/coderd/database/querier.go +++ b/coderd/database/querier.go @@ -1,6 +1,6 @@ // Code generated by sqlc. DO NOT EDIT. // versions: -// sqlc v1.27.0 +// sqlc v1.25.0 package database diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go index 2ff93bceeaeb5..74990ab1103bd 100644 --- a/coderd/database/queries.sql.go +++ b/coderd/database/queries.sql.go @@ -1,6 +1,6 @@ // Code generated by sqlc. DO NOT EDIT. // versions: -// sqlc v1.27.0 +// sqlc v1.25.0 package database pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy