From 9f4b8286aa9c3d3d4b4bfe76cfe5247033d8ed59 Mon Sep 17 00:00:00 2001 From: foo-git <53096886+foo-git@users.noreply.github.com> Date: Mon, 5 Aug 2024 08:15:08 +0200 Subject: [PATCH] Update grocy.openapi.json Add general usage/developing hint at the top. Add hint about adding note-only shoppinglist entries. --- grocy.openapi.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/grocy.openapi.json b/grocy.openapi.json index 03b0051d..901aa221 100644 --- a/grocy.openapi.json +++ b/grocy.openapi.json @@ -2,7 +2,7 @@ "openapi": "3.1.0", "info": { "title": "Grocy REST API", - "description": "Authentication is done via API keys (header *GROCY-API-KEY* or same named query parameter), which you can manage [here](PlaceHolderManageApiKeysUrl).
Additionally requests from within the frontend are also valid (via session cookie).", + "description": "Authentication is done via API keys (header *GROCY-API-KEY* or same named query parameter), which you can manage [here](PlaceHolderManageApiKeysUrl).
Additionally requests from within the frontend are also valid (via session cookie).
Hint: To find the right request and request body, use the browser web developer tools while using the Grocy Frontend.", "version": "xxx", "license": { "name": "grocy.info", @@ -3042,7 +3042,7 @@ "/stock/shoppinglist/add-product": { "post": { "summary": "Adds the given amount of the given product to the given shopping list", - "description": "If the product is already on the shopping list, the given amount will increase the amount of the already existing item, otherwise a new item will be added", + "description": "If the product is already on the shopping list, the given amount will increase the amount of the already existing item, otherwise a new item will be added. If you want to add only a note to a shopping list, you need to use the /objects/shoppinglist request.", "tags": [ "Stock" ],