From 00979497ac6ff17994fc9098d166bdc892c30ca4 Mon Sep 17 00:00:00 2001 From: Rbillon59 Date: Thu, 27 Apr 2023 11:54:33 +0200 Subject: [PATCH] chore(badges): Add warning about endpoint exposition Signed-off-by: Rbillon59 --- plugins/badges-backend/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/plugins/badges-backend/README.md b/plugins/badges-backend/README.md index 5e9b8dd3cc..4a5eb8f07e 100644 --- a/plugins/badges-backend/README.md +++ b/plugins/badges-backend/README.md @@ -127,6 +127,8 @@ app: obfuscate: true ``` +:warning: **Warning**: The only endpoint to be publicly available is the `/entity/:entityUuid/:badgeId` endpoint. The other endpoints are meant to be called from the frontend plugin. + > Note that you cannot use env vars to set the `obfuscate` value. It must be a boolean value and env vars are always strings. ## API