Adjust docs

Signed-off-by: Daniel Kastl <[email protected]>

Author: dkastl

doc/broker_scripts.md

@@ -1,7 +1,10 @@
-# Broker Scripts
+# FIWARE Broker Scripts
 
 This document describes the scripts available in the `scripts` directory that
-help manage the context broker.
+help manage the FIWARE context broker.
+
+- [Register All Subscriptions](#register-all-subscriptions)
+- [Delete All Subscriptions](#delete-all-subscriptions)
 
 ## Register All Subscriptions
 
@@ -27,22 +30,22 @@ URL specified in the header for each subscription.
 
 - `REDMINE_API_KEY`: The API key for your Redmine instance. This is used if the
   `api_key` argument is not provided.
-- `ORION_URL`: The base URL for your Orion Context Broker. Defaults to
+- `BROKER_URL`: The base URL for your Orion Context Broker. Defaults to
   `http://app.local:1026` if not set.
 
-**Note:** Make sure to set the `REDMINE_API_KEY` and `ORION_URL` environment
-variables before running this script if you're not providing them as arguments.
+**Note:** Make sure to set the `BROKER_URL` environment variable to your context
+broker URL before running this script.
 
 To prepend an environment variable to a command in the terminal, you can do so
 like this:
 
 ```bash
-REDMINE_API_KEY=your_api_key ORION_URL=your_orion_url ./scripts/register_all_subscriptions.sh
+BROKER_URL=your_broker_url ./scripts/register_all_subscriptions.sh <your_api_key>
 ```
 
-Replace `your_api_key` with your actual Redmine API key and `your_orion_url`
-with the correct URL. This will set the `REDMINE_API_KEY` and `ORION_URL`
-environment variables for the duration of the `register_all_subscriptions.sh` script.
+Replace `your_api_key` with your actual Redmine API key and `your_broker_url`
+with the correct URL. This will set the `BROKER_URL` environment variables for
+the duration of the `register_all_subscriptions.sh` script.
 
 ## Delete All Subscriptions
 
@@ -61,19 +64,19 @@ subscriptions, and then makes DELETE requests to the
 
 **Environment Variables:**
 
-- `ORION_URL`: The base URL for your Orion Context Broker. Defaults to
+- `BROKER_URL`: The base URL for your Orion Context Broker. Defaults to
   `http://app.local:1026` if not set.
 
 **Note:** This script does not require any arguments. Make sure to set the
-`ORION_URL` environment variable to your context broker URL before running this script.
+`BROKER_URL` environment variable to your context broker URL before running this script.
 
 To prepend an environment variable to a command in the terminal, you can do so
 like this:
 
 ```bash
-ORION_URL=your_orion_url ./scripts/delete_all_subscriptions.sh
+BROKER_URL=your_broker_url ./scripts/delete_all_subscriptions.sh
 ```
 
-Replace `your_orion_url` with your actual Redmine API key. This will set the
-`ORION_URL` environment variable for the duration of the
+Replace `your_broker_url` with your actual Redmine API key. This will set the
+`BROKER_URL` environment variable for the duration of the
 `delete_all_subscriptions.sh` script.

doc/index.md

@@ -7,8 +7,8 @@ FIWARE plugin and its API endpoints.
 
 - Make sure REST web services is enabled: <http://localhost:3000/settings?tab=api>
 - Enable the plugin in project settings
-- Don't select a user with admin rights for the FIWARE subscriptions. Instead,
-  create a new user with the necessary permissions.
+- For security reasons don't select a user with admin rights for the FIWARE
+  subscriptions. Instead, create a new user with the necessary permissions.
 
 ### Redmine Permissions
 

doc/plugin_settings.md

@@ -5,10 +5,10 @@ FIWARE plugin. The plugin is designed to manage subscriptions for a FIWARE
 context broker, allowing the creation of Redmine issues through FIWARE
 notifications.
 
-## General Settings
-
 ![Plugin Settings Screenshot](plugin_settings.png)
 
+## General Settings
+
 ### Default NGSI-LD Format
 
 - **Description**: Specifies the format of the NGSI-LD data.

doc/scripts/delete_all_subscriptions.sh

@@ -1,11 +1,11 @@
 #!/bin/bash
 
 # The base URL for your Orion Context Broker
-ORION_URL=${ORION_URL:-"http://app.local:1026"}
+BROKER_URL=${BROKER_URL:-"http://app.local:1026"}
 
 # Fetch all subscription IDs using a GET request
 # Include additional headers as needed, e.g., for multi-tenant setups or authentication
-subscription_ids=$(curl -s -X GET "${ORION_URL}/v2/subscriptions" \
+subscription_ids=$(curl -s -X GET "${BROKER_URL}/v2/subscriptions" \
 -H "Accept: application/json" | jq -r '.[].id')
 
 # Check if there are any subscriptions to delete
@@ -16,7 +16,7 @@ fi
 
 # Loop through the subscription IDs and delete each one
 for id in $subscription_ids; do
-    curl -X DELETE "${ORION_URL}/v2/subscriptions/${id}" \
+    curl -X DELETE "${BROKER_URL}/v2/subscriptions/${id}" \
     -H "Accept: application/json"
     echo "Deleted subscription $id"
 done

doc/scripts/register_all_subscriptions.sh

@@ -11,10 +11,10 @@ then
 fi
 
 # The base URL for your Orion Context Broker
-ORION_URL=${ORION_URL:-"http://app.local:1026"}
+BROKER_URL=${BROKER_URL:-"http://app.local:1026"}
 
 # Fetch all subscriptions using a GET request
-subscriptions=$(curl -s -X GET "${ORION_URL}/v2/subscriptions" -H "Accept: application/json")
+subscriptions=$(curl -s -X GET "${BROKER_URL}/v2/subscriptions" -H "Accept: application/json")
 
 # Use jq to parse the JSON response and filter subscriptions with the "X-Redmine-GTT-Subscription-Template-URL" header
 filtered_subscriptions=$(echo "$subscriptions" | jq -c '.[] | select(.notification.httpCustom.headers."X-Redmine-GTT-Subscription-Template-URL" != null)')