Slightly modified new recipe stock fulfillment API endpoints (references #289)

changelog/50_2.4.3_2019-xx-xx.md

@@ -2,3 +2,4 @@
 - Fixed that "Track date only" chores were always tracked today, regardless of the given date
 - Fixed that the "week costs" were wrong after removing a meal plan entry
 - Fixed wrong recipes costs calculation with nested recipes when the base recipe servings are > 1 (also affected the meal plan when adding such a recipe there)
+- Improved recipes API - added new endpoints to get stock fulfillment information (thanks @Aerex)

controllers/RecipesApiController.php

@@ -41,20 +41,25 @@ class RecipesApiController extends BaseApiController
 		}
 	}
 
-  public function GetRecipeRequirements(\Slim\Http\Request $request, \Slim\Http\Response $response, array $args)
+	public function GetRecipeFulfillment(\Slim\Http\Request $request, \Slim\Http\Response $response, array $args)
+	{
+		try
+		{ 
+			if(!isset($args['recipeId']))
 			{
-    try { 
-      if(!$args['recipeId']){
 				return $this->ApiResponse($this->RecipesService->GetRecipesResolved());
 			}
+
 			$recipeResolved = FindObjectInArrayByPropertyValue($this->RecipesService->GetRecipesResolved(), 'recipe_id', $args['recipeId']);
-      if(!$recipeResolved) {
+			if(!$recipeResolved)
-        $errorMsg ='Recipe requirments do not exist for recipe_id ' . $args['recipe_id'];
+			{
-        $GenericError = $this->GenericErrorResponse($response, $errorMsg);
+				throw new \Exception('Recipe does not exist');
-        return $GenericError;
 			}
+			else
+			{
 				return $this->ApiResponse($recipeResolved);
 			}
+		} 
 		catch (\Exception $ex)
 		{
 			return $this->GenericErrorResponse($response, $ex->getMessage());

grocy.openapi.json

@@ -1663,6 +1663,47 @@
 				}
 			}
 		},
+		"/recipes/{recipeId}/fulfillment": {
+			"get": {
+				"summary": "Get stock fulfillment information for the given recipe",
+				"tags": [
+					"Recipes"
+				],
+				"parameters": [
+					{
+						"in": "path",
+						"name": "recipeId",
+						"required": true,
+						"description": "A valid recipe id",
+						"schema": {
+							"type": "string"
+						}
+					}
+				],
+				"responses": {
+					"200": {
+						"description": "A RecipeFulfillmentResponse object",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/RecipeFulfillmentResponse"
+								}
+							}
+						}
+					},
+					"400": {
+						"description": "The operation was not successful",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/GenericErrorResponse"
+								}
+							}
+						}
+					}
+				}
+			}
+		},
 		"/recipes/{recipeId}/consume": {
 			"post": {
 				"summary": "Consumes all products of the given recipe",
@@ -1687,66 +1728,21 @@
 				}
 			}
 		},
-        "/recipes/{recipeId}/requirements": {
+		"/recipes/fulfillment": {
 			"get": {
-        "summary": "Get requirements for recipe",
+				"summary": "Get stock fulfillment information for all recipe",
-        "tags": [
-          "Recipes"
-        ],
-        "parameters": [
-          {
-            "in": "path",
-            "name": "recipeId",
-            "required": true,
-            "description": "A valid recipe id",
-            "schema": {
-              "type": "string"
-            }
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "A requirements recipe object",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/RecipeRequirements"
-                }
-              }
-            }
-          },
-          "400": {
-            "description": "The operation was not successful",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/GenericErrorResponse"
-                }
-              }
-            }
-          }
-        }
-      }
-    },
-    "/recipes/requirements": {
-      "get": {
-        "summary": "Get all requirements for recipes",
 				"tags": [
 					"Recipes"
 				],
 				"responses": {
 					"200": {
-            "description": "An array of requirements recipe objects",
+						"description": "An array of RecipeFulfillmentResponse objects",
 						"content": {
 							"application/json": {
 								"schema": {
 									"type": "array",
 									"items": {
-                    "oneOf": [
+										"$ref": "#/components/schemas/RecipeFulfillmentResponse"
-                      {
-                        "$ref": "#/components/schemas/RecipeRequirements"
-                      }
-                    ]	
 									}
 								}
 							}
@@ -2453,7 +2449,7 @@
 					"location_id": "4"
 				}
 			},
-       "RecipeRequirements": {
+			"RecipeFulfillmentResponse": {
 				"type": "object",
 				"properties": {
 					"recipe_id": {

routes.php

@@ -173,9 +173,9 @@ $app->group('/api', function()
 	if (GROCY_FEATURE_FLAG_RECIPES)
 	{
 		$this->post('/recipes/{recipeId}/add-not-fulfilled-products-to-shoppinglist', '\Grocy\Controllers\RecipesApiController:AddNotFulfilledProductsToShoppingList');
-		$this->get('/recipes/{recipeId}/requirements', '\Grocy\Controllers\RecipesApiController:GetRecipeRequirements');
+		$this->get('/recipes/{recipeId}/fulfillment', '\Grocy\Controllers\RecipesApiController:GetRecipeFulfillment');
-		$this->get('/recipes/requirements', '\Grocy\Controllers\RecipesApiController:GetRecipeRequirements');
 		$this->post('/recipes/{recipeId}/consume', '\Grocy\Controllers\RecipesApiController:ConsumeRecipe');
+		$this->get('/recipes/fulfillment', '\Grocy\Controllers\RecipesApiController:GetRecipeFulfillment');
 	}
 
 	// Chores