update open api doc,

API/parameters should be equal over http verbs
campudus · Oct 11, 2023 · 42f494c · 42f494c
1 parent 6ff3a5b
commit 42f494c
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 44 deletions.
diff --git a/.github/workflows/main_ci.yml b/.github/workflows/main_ci.yml
@@ -125,6 +125,6 @@ jobs:
           path: artifacts
 
       - name: Publish Unit Test Results
-        uses: EnricoMi/publish-unit-test-result-action@v1
+        uses: EnricoMi/publish-unit-test-result-action@v2
         with:
           files: artifacts/test-results/**/*.xml
diff --git a/src/main/resources/swagger.json b/src/main/resources/swagger.json
@@ -1750,7 +1750,7 @@
         }
       }
     },
-    "/tables/{tableId}/rows/{rowId}/permissions/{rowPermission}": {
+    "/tables/{tableId}/rows/{rowId}/permissions": {
       "parameters": [
         {
           "$ref": "#/parameters/tableId"
@@ -1759,16 +1759,16 @@
           "$ref": "#/parameters/rowId"
         },
         {
-          "$ref": "#/parameters/rowPermission"
+          "$ref": "#/parameters/rowPermissionBody"
         }
       ],
       "patch": {
-        "summary": "Add a permission to this row.",
-        "description": "Adds a new permission to this row.",
+        "summary": "Add permissions to this row.",
+        "description": "Add permissions to this row.",
         "tags": [
           "permission"
         ],
-        "operationId": "add-row-permission",
+        "operationId": "add-row-permissions",
         "responses": {
           "200": {
             "$ref": "#/responses/ok-empty-body"
@@ -1779,12 +1779,12 @@
         }
       },
       "delete": {
-        "summary": "Delete a permission of this row.",
-        "description": "Deletes a permission of this row.",
+        "summary": "Deletes permissions of this row.",
+        "description": "Deletes permissions of this row.",
         "tags": [
           "permission"
         ],
-        "operationId": "clear-row-permission",
+        "operationId": "remove-row-permissions",
         "responses": {
           "200": {
             "$ref": "#/responses/ok-empty-body"
@@ -1793,41 +1793,14 @@
             "$ref": "#/responses/not-found-in-database"
           }
         }
-      }
-    },
-    "/tables/{tableId}/rows/{rowId}/permissions": {
-      "parameters": [
-        {
-          "$ref": "#/parameters/tableId"
-        },
-        {
-          "$ref": "#/parameters/rowId"
-        }
-      ],
+      },
       "put": {
         "summary": "Replace permissions of this row.",
         "description": "Replace current permissions of this row. This overwrites all permissions of this row with the new provided permission array.",
         "tags": [
           "permission"
         ],
         "operationId": "replace-row-permissions",
-        "parameters": [
-          {
-            "name": "value",
-            "in": "body",
-            "required": true,
-            "schema": {
-              "type": "array",
-              "items": {
-                "type": "string"
-              },
-              "example": [
-                "onlyUserGroupA",
-                "onlyUserGroupB"
-              ]
-            }
-          }
-        ],
         "responses": {
           "200": {
             "$ref": "#/responses/ok-empty-body"
@@ -3847,14 +3820,20 @@
       "format": "int64",
       "required": false
     },
-    "rowPermission": {
-      "name": "rowPermission",
-      "description": "A row permission.",
-      "in": "path",
+    "rowPermissionBody": {
+      "name": "value",
+      "description": "An array of row permission to add, remove or replace.",
+      "in": "body",
       "required": true,
-      "type": "string",
-      "items": {
-        "$ref": "#/definitions/RowPermission"
+      "schema": {
+        "type": "array",
+        "items": {
+          "type": "string"
+        },
+        "example": [
+          "onlyUserGroupA",
+          "onlyUserGroupB"
+        ]
       }
     }
   },