assertUniqueRoutes

mtojek · mtojek · commit 1bc855616645 · 2023-01-12T14:56:17.000+01:00
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
@@ -1573,6 +1573,26 @@ const docTemplate = `{
             }
         },
         "/scim/v2/Users": {
+            "get": {
+                "security": [
+                    {
+                        "CoderSessionToken": []
+                    }
+                ],
+                "produces": [
+                    "application/scim+json"
+                ],
+                "tags": [
+                    "Enterprise"
+                ],
+                "summary": "SCIM 2.0: Get users",
+                "operationId": "scim-get-users",
+                "responses": {
+                    "200": {
+                        "description": "OK"
+                    }
+                }
+            },
             "post": {
                 "security": [
                     {
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
@@ -1373,6 +1373,22 @@
       }
     },
     "/scim/v2/Users": {
+      "get": {
+        "security": [
+          {
+            "CoderSessionToken": []
+          }
+        ],
+        "produces": ["application/scim+json"],
+        "tags": ["Enterprise"],
+        "summary": "SCIM 2.0: Get users",
+        "operationId": "scim-get-users",
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      },
       "post": {
         "security": [
           {
diff --git a/coderd/coderdtest/swaggerparser.go b/coderd/coderdtest/swaggerparser.go
@@ -118,6 +118,8 @@ func parseSwaggerComment(commentGroup *ast.CommentGroup) SwaggerComment {
 }
 
 func VerifySwaggerDefinitions(t *testing.T, router chi.Router, swaggerComments []SwaggerComment) {
+	assertUniqueRoutes(t, swaggerComments)
+
 	err := chi.Walk(router, func(method, route string, handler http.Handler, middlewares ...func(http.Handler) http.Handler) error {
 		method = strings.ToLower(method)
 		if route != "/" && strings.HasSuffix(route, "/") {
@@ -223,3 +225,16 @@ func assertSecurityDefined(t *testing.T, comment SwaggerComment) {
 	}
 	assert.Equal(t, "CoderSessionToken", comment.security, "@Security must be equal CoderSessionToken")
 }
+
+func assertUniqueRoutes(t *testing.T, comments []SwaggerComment) {
+	m := map[string]struct{}{}
+
+	for _, c := range comments {
+		key := c.method + " " + c.router
+		_, alreadyDefined := m[key]
+		assert.False(t, alreadyDefined, "defined route must be unique (method: %s, route: %s)", c.method, c.router)
+		if !alreadyDefined {
+			m[key] = struct{}{}
+		}
+	}
+}
diff --git a/docs/api/enterprise.md b/docs/api/enterprise.md
@@ -787,6 +787,26 @@ Status Code **200**
 
 To perform this operation, you must be authenticated. [Learn more](authentication.md).
 
+## SCIM 2.0: Get users
+
+### Code samples
+
+```shell
+# Example request using curl
+curl -X GET http://coder-server:8080/api/v2/scim/v2/Users \
+  -H 'Coder-Session-Token: API_KEY'
+```
+
+`GET /scim/v2/Users`
+
+### Responses
+
+| Status | Meaning                                                 | Description | Schema |
+| ------ | ------------------------------------------------------- | ----------- | ------ |
+| 200    | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK          |        |
+
+To perform this operation, you must be authenticated. [Learn more](authentication.md).
+
 ## SCIM 2.0: Create new user
 
 ### Code samples
diff --git a/enterprise/coderd/scim.go b/enterprise/coderd/scim.go
@@ -49,7 +49,7 @@ func (api *API) scimVerifyAuthHeader(r *http.Request) bool {
 // @Produce application/scim+json
 // @Tags Enterprise
 // @Success 200
-// @Router /scim/v2/Users [post]
+// @Router /scim/v2/Users [get]
 //
 //nolint:revive
 func (api *API) scimGetUsers(rw http.ResponseWriter, r *http.Request) {
