From bf353d96224da62e1df966d98ae8e7285e73618a Mon Sep 17 00:00:00 2001
From: Bernd Bestel <bernd@berrnd.de>
Date: Sat, 1 Feb 2025 09:34:16 +0100
Subject: [PATCH] API: Expose permission_hierarchy read only via generic entity
 interactions (closes #2662)

---
 changelog/79_UNRELEASED_xx-xx-xxxx.md | 57 +++++++++++++++++++++++++++
 grocy.openapi.json                    | 12 ++++--
 2 files changed, 66 insertions(+), 3 deletions(-)
 create mode 100644 changelog/79_UNRELEASED_xx-xx-xxxx.md

diff --git a/changelog/79_UNRELEASED_xx-xx-xxxx.md b/changelog/79_UNRELEASED_xx-xx-xxxx.md
new file mode 100644
index 00000000..12582126
--- /dev/null
+++ b/changelog/79_UNRELEASED_xx-xx-xxxx.md
@@ -0,0 +1,57 @@
+> ⚠️ xxxBREAKING CHANGESxxx
+
+> ❗ xxxImportant upgrade informationXXX
+
+> 💡 xxxMinor upgrade informationXXX
+
+### New Feature: xxxx
+
+- xxx
+
+### Stock
+
+- xxx
+
+### Shopping list
+
+- xxx
+
+### Recipes
+
+- xxx
+
+### Meal plan
+
+- xxx
+
+### Chores
+
+- xxx
+
+### Calendar
+
+- xxx
+
+### Tasks
+
+- xxx
+
+### Batteries
+
+- xxx
+
+### Equipment
+
+- xxx
+
+### Userfields
+
+- xxx
+
+### General
+
+- xxx
+
+### API
+
+- Exposed the `permission_hierarchy` entity (read only, => `GET /objects/permission_hierarchy`) to provide a permission name / id mapping
diff --git a/grocy.openapi.json b/grocy.openapi.json
index e0b483e1..c33be4c2 100644
--- a/grocy.openapi.json
+++ b/grocy.openapi.json
@@ -1063,6 +1063,7 @@
 		"/users/{userId}/permissions": {
 			"get": {
 				"summary": "Returns the assigned permissions of the given user",
+				"description": "See \"GET /objects/permission_hierarchy\" for a permission name / id mapping",
 				"tags": [
 					"User management"
 				],
@@ -1113,6 +1114,7 @@
 			},
 			"post": {
 				"summary": "Adds a permission to the given user",
+				"description": "See \"GET /objects/permission_hierarchy\" for a permission name / id mapping",
 				"tags": [
 					"User management"
 				],
@@ -1161,6 +1163,7 @@
 			},
 			"put": {
 				"summary": "Replaces the assigned permissions of the given user",
+				"description": "See \"GET /objects/permission_hierarchy\" for a permission name / id mapping",
 				"tags": [
 					"User management"
 				],
@@ -5906,7 +5909,8 @@
 					"quantity_unit_conversions_resolved",
 					"recipes_pos_resolved",
 					"battery_charge_cycles",
-					"product_barcodes_view"
+					"product_barcodes_view",
+					"permission_hierarchy"
 				]
 			},
 			"ExposedEntityNoListing": {
@@ -5928,7 +5932,8 @@
 					"quantity_unit_conversions_resolved",
 					"recipes_pos_resolved",
 					"battery_charge_cycles",
-					"product_barcodes_view"
+					"product_barcodes_view",
+					"permission_hierarchy"
 				]
 			},
 			"ExposedEntityNoDelete": {
@@ -5943,7 +5948,8 @@
 					"quantity_unit_conversions_resolved",
 					"recipes_pos_resolved",
 					"battery_charge_cycles",
-					"product_barcodes_view"
+					"product_barcodes_view",
+					"permission_hierarchy"
 				]
 			},
 			"ExposedEntityEditRequiresAdmin": {