feat(api): PUT api to Set permissions for a upload and GET API to fetch respective permissions of groups

[krishna9304]

Signed-off-by : Krishna Mahato krishhtrishh9304@gmail.com

Description

Now,

• There is a PUT route which is available at /api/v1/uploads/{id}/permissions that will Set permissions for a upload in a folder for different groups.
• There is a GET route which is available at /api/v1/uploads/{id}/perm-groups that will return all the groups with their respective permissions for a upload.
  Here {id} : is the upload Id.

How to test

• Use any API platform like postman.
• Pull the changes from this PR.

To test PUT /api/v1/uploads/{id}/permissions

• Provide the request body as following ----

• You can expect a response like this

To test GET /api/v1/uploads/{id}/perm-groups

• If your upload exists, you can expect a response like this.

PTAL : @GMishx @Shruti3004

This closes #2270 .

[GMishx]

@krishna9304 apologies, I pressed the wrong button an pushed the merge commit to the branch. Can you please rebase it with current master and remove the merge commit?

[krishna9304]

@krishna9304 apologies, I pressed the wrong button an pushed the merge commit to the branch. Can you please rebase it with current master and remove the merge commit?

Sure, I'll do that!

[GMishx]

Changes looks good.

[GMishx]

Please check the image for required changes in response of GET repo/api/v1/uploads/{id}/perm-groups endpoint.

The PUT repo/api/v1/uploads/{id}/permissions endpoint is working as expected.

[krishna9304]

Please check the image for required changes in response of GET repo/api/v1/uploads/{id}/perm-groups endpoint.

The PUT repo/api/v1/uploads/{id}/permissions endpoint is working as expected.

@GMishx

• Okay, I'll remove the perm_upload_pk parameter.
• Sending an indexed object for the groups with permissions response makes it easy to implement on the UI, as each group can be directly targeted through their groupId and perform edit or delete operation for the UI purposes. Handling this with an array will increase complexity on the UI and can result in behavioural delays (not good from UX perspective).

[GMishx]

@GMishx

* Okay, I'll remove the `perm_upload_pk` parameter.

* Sending an indexed object for the groups with permissions response makes it easy to implement on the UI, as each group can be directly targeted through their `groupId` and perform edit or delete operation for the UI purposes. Handling this with an array will increase complexity on the UI and can result in behavioural delays (not good from UX perspective).

@krishna9304

Please keep in mind the REST API is not designed solely for the purpose of UI implementation. It can be consumed by others as well. Using indexed array can cause issues with some programming languages. However, simple array can be iterated over and filtered based on inner group_pk.

Moreover, I am not sure the array will be so big for a single upload that it will cause significant computational delay if all the elements have to be iterated over.

[krishna9304]

@GMishx

* Okay, I'll remove the `perm_upload_pk` parameter.

* Sending an indexed object for the groups with permissions response makes it easy to implement on the UI, as each group can be directly targeted through their `groupId` and perform edit or delete operation for the UI purposes. Handling this with an array will increase complexity on the UI and can result in behavioural delays (not good from UX perspective).

@krishna9304

Please keep in mind the REST API is not designed solely for the purpose of UI implementation. It can be consumed by others as well. Using indexed array can cause issues with some programming languages. However, simple array can be iterated over and filtered based on inner group_pk.

Moreover, I am not sure the array will be so big for a single upload that it will cause significant computational delay if all the elements have to be iterated over.

Sure then, I'm changing the response to be an array. @GMishx

[GMishx]

@krishna9304 some changes are required in open api docs

diff --git a/src/www/ui/api/documentation/openapi.yaml b/src/www/ui/api/documentation/openapi.yaml
index 82e1a7e5d..7d3598c43 100644
--- a/src/www/ui/api/documentation/openapi.yaml
+++ b/src/www/ui/api/documentation/openapi.yaml
@@ -677,7 +677,7 @@ paths:
         Set permissions for a upload in a folder for different groups
       requestBody:
         content:
-          application/x-www-form-urlencoded:
+          application/json:
             schema:
               type: object
               properties:
@@ -2351,18 +2351,17 @@ components:
           type: string
           description: Public permission for the upload
         permGroups:
-          type: object
+          type: array
           description: Indexed Object of GroupIds with their respective permissions for a upload
-          properties:
-            groupId:
-              type: object
-              properties:
-                perm:
-                  type: string
-                group_pk:
-                  type: string
-                group_name:
-                  type: string
+          items:
+            type: object
+            properties:
+              perm:
+                type: string
+              group_pk:
+                type: string
+              group_name:
+                type: string
     UrlUpload:
       description: To create an upload from a URL
       type: object

[krishna9304]

@krishna9304 some changes are required in open api docs

diff --git a/src/www/ui/api/documentation/openapi.yaml b/src/www/ui/api/documentation/openapi.yaml
index 82e1a7e5d..7d3598c43 100644
--- a/src/www/ui/api/documentation/openapi.yaml
+++ b/src/www/ui/api/documentation/openapi.yaml
@@ -677,7 +677,7 @@ paths:
         Set permissions for a upload in a folder for different groups
       requestBody:
         content:
-          application/x-www-form-urlencoded:
+          application/json:
             schema:
               type: object
               properties:
@@ -2351,18 +2351,17 @@ components:
           type: string
           description: Public permission for the upload
         permGroups:
-          type: object
+          type: array
           description: Indexed Object of GroupIds with their respective permissions for a upload
-          properties:
-            groupId:
-              type: object
-              properties:
-                perm:
-                  type: string
-                group_pk:
-                  type: string
-                group_name:
-                  type: string
+          items:
+            type: object
+            properties:
+              perm:
+                type: string
+              group_pk:
+                type: string
+              group_name:
+                type: string
     UrlUpload:
       description: To create an upload from a URL
       type: object

yes, may be I missed that, I'm fixing it right away.

[krishna9304]

@GMishx Fixed api docs.

[GMishx]

Changes looks good.
Tested, working as expected.