diff --git a/docs/How-to guides/How to update device firmware.md b/docs/How-to guides/How to update device firmware.md index 841cb5c..10cc6df 100644 --- a/docs/How-to guides/How to update device firmware.md +++ b/docs/How-to guides/How to update device firmware.md @@ -29,10 +29,14 @@ The reason why the firmware update message is sent with the MQTT Retained flag s The payload of the MQTT message is a UTF-8 encoded string, that holds a JSON object with the following content: -``` +```json { - "firmware-name": "firmware name", - "download-url": "https://firmware-download-url" + "name": "firmware name", + "download-url": "https://firmware-download-url", + "size": 0, + "md5": "hash", + "sha1": "hash", + "sha256": "hash" } ``` diff --git a/docs/Tutorials/Getting started/Step 5 - Authenticating a device.md b/docs/Tutorials/Getting started/Step 5 - Authenticating a device.md index 37dbf77..6e4c051 100644 --- a/docs/Tutorials/Getting started/Step 5 - Authenticating a device.md +++ b/docs/Tutorials/Getting started/Step 5 - Authenticating a device.md @@ -20,7 +20,7 @@ However in order to call the **http-forwarder** service you have to identify you With that information you can craft an HTTP request for this simulation to get the token. In this tutorial, it is assumed you have some experience working the terminal. As said at the beginning of this tutorial, **HTTPie** and **cURL** tools will be used to provide examples for HTTP requests. Here is the request to retrieve the token using both tools (please make sure to adjust the request with your own credentials): -```jsx title="HTTPie" +```bash title="HTTPie" http --form POST \ https://auth.biotz.io/realms/biotz-platform/protocol/openid-connect/token \ username=~HTTP USER FROM CSV~ \ @@ -31,7 +31,7 @@ scope=openid ```

-```jsx title="cURL" +```bash title="cURL" curl --request POST \ --url https://auth.biotz.io/realms/biotz-platform/protocol/openid-connect/token \ --data-urlencode username=~HTTP USERNAME FROM CSV~ \ diff --git a/docs/Tutorials/Getting started/Step 6 - Sending a data ingestion request.md b/docs/Tutorials/Getting started/Step 6 - Sending a data ingestion request.md index 4c36e6f..a8c181e 100644 --- a/docs/Tutorials/Getting started/Step 6 - Sending a data ingestion request.md +++ b/docs/Tutorials/Getting started/Step 6 - Sending a data ingestion request.md @@ -17,7 +17,7 @@ In this case the **Object** is an JSON object since the **mytestmessag** definit

Now, the request is very simple, you will send just a single sample of data (a single request in this case) to the platform. Here is an example using both HTTPie and cURL. -```jsx title="HTTPie" +```bash title="HTTPie" http --auth-type bearer \ --auth ~YOUR ID_TOKEN~ \ POST https://ingestion-http.biotz.io/api/device/publish/data/mytestmessag \ @@ -25,7 +25,7 @@ hum=20.5 temp=25.6 ```

-```jsx title="cURL" +```bash title="cURL" curl --header "Content-Type: application/json" \ --header "Authorization: Bearer ~YOUR ID_TOKEN~" \ --request POST \ @@ -35,7 +35,7 @@ https://ingestion-http.biotz.io/api/device/publish/data/~INTERNAL NAME OF MESSAG

The response should look like this: -``` +```json { "success?": true, "details": {} diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 3b7fca4..6f3ddee 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -127,6 +127,7 @@ const config: Config = { prism: { theme: prismThemes.github, darkTheme: prismThemes.dracula, + additionalLanguages: ['clojure','json','bash'], }, } satisfies Preset.ThemeConfig, };