Merge pull request #65 from AirWalk-Digital/fix/framework-endpoint-tr…

…ailing-slashes feat: trailing slashes in framework endpoints
AirWalk-Digital · Jul 4, 2023 · 4f3a5df · 4f3a5df
2 parents 956e6ab + ee7405a
commit 4f3a5df
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 22 deletions.
diff --git a/app/airview_api/controllers/frameworks.py b/app/airview_api/controllers/frameworks.py
@@ -45,7 +45,7 @@ def post(self, data):
             abort(400, message=str(e))
 
 
-@blp.route("/<int:framework_id>")
+@blp.route("/<int:framework_id>/")
 class Framework(MethodView):
     @blp.response(200, FrameworkSchema)
     @blp.role(Roles.CONTENT_READER)
@@ -54,7 +54,7 @@ def get(self, framework_id):
         return data
 
 
-@blp.route("/<int:framework_id>/sections")
+@blp.route("/<int:framework_id>/sections/")
 class FrameworkSection(MethodView):
     @blp.response(200, FrameworkSectionSchema(many=True))
     @blp.role(Roles.CONTENT_READER)
@@ -76,7 +76,7 @@ def post(self, data, framework_id):
             abort(400, message=str(e))
 
 
-@blp.route("/<int:framework_id>/sections/<int:section_id>/control_objectives")
+@blp.route("/<int:framework_id>/sections/<int:section_id>/control_objectives/")
 class FrameworkControlObjective(MethodView):
     @blp.response(200, FrameworkControlObjectiveSchema(many=True))
     @blp.role(Roles.CONTENT_READER)

diff --git a/app/client/airviewclient/client.py b/app/client/airviewclient/client.py
@@ -437,7 +437,7 @@ def create_framework(self, framework: Framework) -> Optional[Framework]:
     def get_framework_section(self, framework_section: FrameworkSection, framework_id: int) -> Optional[FrameworkSection]:
         resp = self._session.get(
             url=self.get_url(
-                f"/frameworks/{framework_id}/sections?name={framework_section.name}"
+                f"/frameworks/{framework_id}/sections/?name={framework_section.name}"
             ),
             headers=self._headers
         )
@@ -455,7 +455,7 @@ def get_framework_section(self, framework_section: FrameworkSection, framework_i
     def create_framework_section(self, framework_section: FrameworkSection, framework_id: int) -> Optional[FrameworkSection]:
         resp = self._session.post(
             url=self.get_url(
-                f"/frameworks/{framework_id}/sections"
+                f"/frameworks/{framework_id}/sections/"
             ),
             json={
                 "name": framework_section.name,
@@ -474,7 +474,7 @@ def create_framework_section(self, framework_section: FrameworkSection, framewor
     def get_framework_control_objective(self, framework_control_objective: FrameworkControlObjective, framework_section_id: int, framework_id: int) -> Optional[FrameworkControlObjective]:
         resp = self._session.get(
             url=self.get_url(
-                f"/frameworks/{framework_id}/sections/{framework_section_id}/control_objectives?name={framework_control_objective.name}"
+                f"/frameworks/{framework_id}/sections/{framework_section_id}/control_objectives/?name={framework_control_objective.name}"
             ),
             headers=self._headers
         )
@@ -492,7 +492,7 @@ def get_framework_control_objective(self, framework_control_objective: Framework
     def create_framework_control_objective(self, framework_control_objective: FrameworkControlObjective, framework_section_id: int, framework_id: int) -> Optional[FrameworkControlObjective]:
         resp = self._session.post(
             url=self.get_url(
-                f"/frameworks/{framework_id}/sections/{framework_section_id}/control_objectives"
+                f"/frameworks/{framework_id}/sections/{framework_section_id}/control_objectives/"
             ),
             json={
                 "name": framework_control_objective.name,

diff --git a/app/tests/api_tests/test_frameworks.py b/app/tests/api_tests/test_frameworks.py
@@ -156,7 +156,7 @@ def test_framework_sections_post_ok(client):
 
     # Act
     resp = client.post(
-        "/frameworks/1/sections",
+        "/frameworks/1/sections/",
         json={
             "name": "Access Control",
             "link": "/nisttest/access_control",
@@ -217,7 +217,7 @@ def test_framework_sections_get_ok(client):
 
     # Act
     resp = client.get(
-        "/frameworks/1/sections",
+        "/frameworks/1/sections/",
     )
     data = resp.get_json()
     # Assert
@@ -265,7 +265,7 @@ def test_framework_sections_get_by_name(client):
 
     # Act
     resp = client.get(
-        "/frameworks/1/sections?name=Logging",
+        "/frameworks/1/sections/?name=Logging",
     )
     data = resp.get_json()
     # Assert
@@ -314,7 +314,7 @@ def test_framework_sections_get_missing_by_name(client):
 
     # Act
     resp = client.get(
-        "/frameworks/1/sections?name=Monitoring",
+        "/frameworks/1/sections/?name=Monitoring",
     )
     data = resp.get_json()
     # Assert
@@ -346,7 +346,7 @@ def test_framework_control_objective_post_ok(client):
 
     # Act
     resp = client.post(
-        "/frameworks/1/sections/1/control_objectives",
+        "/frameworks/1/sections/1/control_objectives/",
         json={
             "name": "Ensure 2FA is enabled",
             "link": "/nisttest/access_control/ensure_2fa_is_enabled",
@@ -430,7 +430,7 @@ def test_framework_control_objective_get_ok(client):
 
     # Act
     resp = client.get(
-        "/frameworks/2/sections/3/control_objectives",
+        "/frameworks/2/sections/3/control_objectives/",
     )
     data = resp.get_json()
     # Assert
@@ -500,7 +500,7 @@ def test_framework_control_objective_get_by_name(client):
 
     # Act
     resp = client.get(
-        "/frameworks/2/sections/1/control_objectives?name=Users password must be at least 20 characters long",
+        "/frameworks/2/sections/1/control_objectives/?name=Users password must be at least 20 characters long",
     )
     data = resp.get_json()
     # Assert
@@ -567,7 +567,7 @@ def test_framework_control_objective_get_missing_by_name(client):
 
     # Act
     resp = client.get(
-         "/frameworks/2/sections/1/control_objectives?name=Users password must be at least 20 characters long",
+         "/frameworks/2/sections/1/control_objectives/?name=Users password must be at least 20 characters long",
     )
     data = resp.get_json()
     # Assert

diff --git a/docs/openapi.json b/docs/openapi.json
@@ -1114,7 +1114,7 @@
         "x-api-rbac-role": "ContentWriter"
       }
     },
-    "/frameworks/{framework_id}": {
+    "/frameworks/{framework_id}/": {
       "get": {
         "responses": {
           "200": {
@@ -1148,7 +1148,7 @@
         }
       ]
     },
-    "/frameworks/{framework_id}/sections": {
+    "/frameworks/{framework_id}/sections/": {
       "get": {
         "responses": {
           "200": {
@@ -1219,7 +1219,7 @@
         "x-api-rbac-role": "ContentWriter"
       }
     },
-    "/frameworks/{framework_id}/sections/{section_id}/control_objectives": {
+    "/frameworks/{framework_id}/sections/{section_id}/control_objectives/": {
       "get": {
         "responses": {
           "200": {
@@ -1304,15 +1304,15 @@
         "parameters": [
           {
             "in": "query",
-            "name": "resourceId",
+            "name": "technicalControlId",
             "required": true,
             "schema": {
               "type": "integer"
             }
           },
           {
             "in": "query",
-            "name": "technicalControlId",
+            "name": "resourceId",
             "required": true,
             "schema": {
               "type": "integer"
@@ -1352,15 +1352,15 @@
         "parameters": [
           {
             "in": "query",
-            "name": "type",
+            "name": "reference",
             "required": false,
             "schema": {
               "type": "string"
             }
           },
           {
             "in": "query",
-            "name": "reference",
+            "name": "type",
             "required": false,
             "schema": {
               "type": "string"