From 469dcefc7ae9b65a7de041da29dc51799e43d302 Mon Sep 17 00:00:00 2001 From: Bernd Bestel Date: Thu, 23 Jan 2020 20:05:44 +0100 Subject: [PATCH] Don't show not listable entites in Swagger UI (fixes #510) --- controllers/GenericEntityApiController.php | 2 +- grocy.openapi.json | 26 ++++++++++++++++++---- 2 files changed, 23 insertions(+), 5 deletions(-) diff --git a/controllers/GenericEntityApiController.php b/controllers/GenericEntityApiController.php index 991a7f58..0d836686 100644 --- a/controllers/GenericEntityApiController.php +++ b/controllers/GenericEntityApiController.php @@ -171,6 +171,6 @@ class GenericEntityApiController extends BaseApiController private function IsEntityWithPreventedListing($entity) { - return in_array($entity, $this->OpenApiSpec->components->internalSchemas->ExposedEntitiesPreventListing->enum); + return !in_array($entity, $this->OpenApiSpec->components->internalSchemas->ExposedEntityButNoListing->enum); } } diff --git a/grocy.openapi.json b/grocy.openapi.json index 5ddbeaa9..c49ce067 100644 --- a/grocy.openapi.json +++ b/grocy.openapi.json @@ -129,7 +129,7 @@ "required": true, "description": "A valid entity name", "schema": { - "$ref": "#/components/internalSchemas/ExposedEntity" + "$ref": "#/components/internalSchemas/ExposedEntityButNoListing" } } ], @@ -274,7 +274,7 @@ "required": true, "description": "A valid entity name", "schema": { - "$ref": "#/components/internalSchemas/ExposedEntity" + "$ref": "#/components/internalSchemas/ExposedEntityButNoListing" } }, { @@ -3275,10 +3275,28 @@ "meal_plan" ] }, - "ExposedEntitiesPreventListing": { + "ExposedEntityButNoListing": { "type": "string", "enum": [ - "api_keys" + "products", + "chores", + "batteries", + "locations", + "quantity_units", + "quantity_unit_conversions", + "shopping_list", + "shopping_lists", + "recipes", + "recipes_pos", + "recipes_nestings", + "tasks", + "task_categories", + "product_groups", + "equipment", + "userfields", + "userentities", + "userobjects", + "meal_plan" ] }, "StockTransactionType": {