glo03-666: initial commit

Author: oglowa

README.md

@@ -15,10 +15,19 @@ Containing examples for the [Confluence REST API](https://developer.atlassian.co
 - Linux / Unix Shell
   or
 - Windows Shell
-- Cygwin + curl
+- Cygwin + Curl
     - Intune-Client or
     - https://curl.se/windows/
 
+# How to use it
+
+1. copy the file `common/my.cfg.tpl` to `~/.restapi`
+2. rename the file to `~/.restapi\my.cfg`
+3. edit the file `~/.restapi/my.cfg`
+    - set the variables
+        - `CONF_BASE_URL_*` = URL's of your Confluence instance
+        - `CONF_PAT_*` = Personal access token for authentication
+
 # Notice
 
 __Examples are working with privat access token (PAT) only!__

browse.sh

@@ -7,6 +7,9 @@
 #
 # (c) 2024 Oliver Glowa (glo03) / Arvato Systems GmbH
 #
+# Call:
+# ./browse.sh
+#
 
 source ./common/env-restapi.sh
 

read-children.sh

@@ -7,6 +7,9 @@
 #
 # (c) 2024 Oliver Glowa (glo03) / Arvato Systems GmbH
 #
+# Call:
+# ./read-children.sh <PAGE_ID>
+#
 
 source ./common/env-restapi.sh
 

read.sh

@@ -7,6 +7,9 @@
 #
 # (c) 2024 Oliver Glowa (glo03) / Arvato Systems GmbH
 #
+# Call:
+# ./read.sh
+#
 
 source ./common/env-restapi.sh
 

upload.sh

@@ -8,9 +8,23 @@
 # (c) 2024 Oliver Glowa (glo03) / Arvato Systems GmbH
 #
 # - https://confluence.atlassian.com/confkb/using-the-confluence-rest-api-to-upload-an-attachment-to-one-or-more-pages-1014274390.html
+#
+# Call:
+# ./upload.sh <PAGE_ID> <ATTACHMENT_FILE>
+#
+
+source ./common/env-restapi.sh
+
+if [ "$1" != "" ]; then
+  PAGE_ID=$1
+fi
 
-source ./env-restapi.sh
+if [ "$2" != "" ]; then
+  ATTACHMENT_FILE=$2
+fi
 
-echo -e "\bDo the upload\n"
+echo "Do the upload"
+echo "Page ID: ${PAGE_ID}"
+echo "File: ${ATTACHMENT_FILE}"
 
-curl -s -H "Authorization: Bearer ${CONF_AUTH}" -X POST -H "X-Atlassian-Token: no-check" -F "file=@${ATTACHMENT_FILE}" -F "comment=attached at ${TS}" ${CONF_RESTAPI_URL}/${PAGE_ID}/child/attachment?allowDuplicated=true | jq -r
+curl -s -H "${CONF_AUTH}" -X POST -H "X-Atlassian-Token: no-check" -F "file=@${ATTACHMENT_FILE}" -F "comment=attached at ${TS}" ${CONF_RESTAPI_URL}/${PAGE_ID}/child/attachment?allowDuplicated=true | jq -r