PROGX-837: Documentation for permissions API

Author: AdrienSyPro

content/files/Akeneo PIM API.postman_collection.json

@@ -5133,6 +5133,79 @@
 				}
 			]
 		},
+		{
+			"name": "Permissions (Channels)",
+			"item": [
+				{
+					"name": "Get User Channels Permissions",
+					"request": {
+						"method": "GET",
+						"header": [
+						{
+							"key": "Authorization",
+							"value": "Bearer {{token}}"
+						},
+						{
+							"key": "Content-type",
+							"value": "application/json"
+						}
+						],
+						"url": {
+						"raw": "{{url}}/api/rest/v1/permissions/{{userId}}/channels",
+						"host": [
+							"{{url}}"
+						],
+						"path": [
+							"api",
+							"rest",
+							"v1",
+							"permissions",
+							"{{userId}}",
+							"channels"
+						]
+						}
+					},
+					"response": []
+				}
+			]
+		},
+
+		{
+			"name": "Permissions (Locales)",
+			"item": [
+				{
+					"name": "Get User Locales Permissions",
+					"request": {
+						"method": "GET",
+						"header": [
+						{
+							"key": "Authorization",
+							"value": "Bearer {{token}}"
+						},
+						{
+							"key": "Content-type",
+							"value": "application/json"
+						}
+						],
+						"url": {
+						"raw": "{{url}}/api/rest/v1/permissions/{{userId}}/locales",
+						"host": [
+							"{{url}}"
+						],
+						"path": [
+							"api",
+							"rest",
+							"v1",
+							"permissions",
+							"{{userId}}",
+							"locales"
+						]
+						}
+					},
+					"response": []
+				}
+			]
+		},
 		{
 			"name": "Extensions",
 			"item": [
@@ -5972,4 +6045,4 @@
 			}
 		}
 	]
-}
+}

content/swagger/akeneo-web-api.json

@@ -44,6 +44,11 @@
 /api/rest/v1/jobs/import/{code}:
   $ref: ./resources/jobs/routes/import.yaml
 
+/api/rest/v1/permissions/{user_id}/locales:
+  $ref: ./resources/permissions/routes/locales.yaml
+/api/rest/v1/permissions/{user_id}/channels:
+  $ref: ./resources/permissions/routes/channels.yaml
+
 /api/rest/v1/families:
   $ref: ./resources/families/routes/families.yaml
 /api/rest/v1/families/{code}:

content/swagger/paths.yaml

@@ -0,0 +1,37 @@
+get:
+  summary: Get user's channels permissions
+  operationId: get_permissions_channels
+  description: This endpoint allows you to get the channels' permissions for a given user.
+  tags:
+    - Permissions
+  x-versions:
+    - "SaaS"
+  parameters:
+    - name: user_id
+      in: path
+      type: string
+      description: User ID
+      required: true
+  responses:
+    200:
+      description: OK
+      x-details: Returns the user's channels permissions
+      x-examples-per-version:
+        - x-version: 'SaaS'
+          x-example:
+            userId: "12345"
+            channels:
+              ecommerce:
+                canView: "true"
+                canEdit: "false"
+              mobile:
+                canView: "false"
+                canEdit: "true"
+    401:
+      $ref: "#/responses/401Error"
+    403:
+      $ref: "#/responses/403Error"
+    404:
+      $ref: "#/responses/404Error"
+    406:
+      $ref: "#/responses/406Error"

content/swagger/resources/permissions/routes/channels.yaml

@@ -0,0 +1,37 @@
+get:
+  summary: Get user's locales permissions
+  operationId: "get_permissions_locales"
+  description: This endpoint allows you to get the locales' permissions about a given user.
+  tags:
+    - Permissions
+  x-versions:
+    - "SaaS"
+  parameters:
+    - name: user_id
+      in: path
+      type: string
+      description: User ID
+      required: true
+  responses:
+    200:
+      description: OK
+      x-details: Returns the User's locales permissions
+      x-examples-per-version:
+        - x-version: 'SaaS'
+          x-example:
+            userId: "12345"
+            locales:
+              en_US:
+                canView: "true"
+                canEdit: "false"
+              fr_FR:
+                canView: "false"
+                canEdit: "true"
+    401:
+      $ref: "#/responses/401Error"
+    403:
+      $ref: "#/responses/403Error"
+    404:
+      $ref: "#/responses/404Error"
+    406:
+      $ref: "#/responses/406Error"

content/swagger/resources/permissions/routes/locales.yaml

@@ -84,6 +84,8 @@ function determineCategory(tag){
             return 'Extensions';
         case 'Jobs':
             return 'Jobs';
+        case 'Permissions':
+            return 'Permissions';
         case 'Workflow':
         case 'Workflow execution':
         case 'Workflow task':