Skip to content

Commit

Permalink
Add tips
Browse files Browse the repository at this point in the history
  • Loading branch information
jason-fox committed Jul 25, 2023
1 parent 3f4fcbd commit 2f645ad
Show file tree
Hide file tree
Showing 14 changed files with 31 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/big-data-flink.md
Original file line number Diff line number Diff line change
Expand Up @@ -325,6 +325,8 @@ curl -X GET \

#### Response:

> **Tip:** Use[jq](https://www.digitalocean.com/community/tutorials/how-to-transform-json-data-with-jq) to format the JSON responses in this tutorial

```json
[
{
Expand Down
2 changes: 2 additions & 0 deletions docs/big-data-spark.md
Original file line number Diff line number Diff line change
Expand Up @@ -310,6 +310,8 @@ curl -X GET \

#### Response:

> **Tip:** Use[jq](https://www.digitalocean.com/community/tutorials/how-to-transform-json-data-with-jq) to format the JSON responses in this tutorial

```json
[
{
Expand Down
2 changes: 2 additions & 0 deletions docs/concise.md
Original file line number Diff line number Diff line change
Expand Up @@ -470,6 +470,8 @@ curl -G -iX GET 'http://localhost:1026/ngsi-ld/v1/entities/urn:ngsi-ld:Temperatu

#### Response:

> **Tip:** Use[jq](https://www.digitalocean.com/community/tutorials/how-to-transform-json-data-with-jq) to format the JSON responses in this tutorial
TemperatureSensor `urn:ngsi-ld:TemperatureSensor:001` is returned as _concise_ NGSI-LD. Additional metadata is returned
because `options=sysAttrs`. By default the `@context` is returned in the payload body (although this could be moved due
to content negotiation if the `Accept:application/json` had been set). The full response is shown below:
Expand Down
2 changes: 2 additions & 0 deletions docs/entity-relationships.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,8 @@ curl -X GET 'http://localhost:1026/ngsi-ld/v1/entities/?type=TemperatureSensor,F

#### Response:

> **Tip:** Use[jq](https://www.digitalocean.com/community/tutorials/how-to-transform-json-data-with-jq) to format the JSON responses in this tutorial
```json
[
{
Expand Down
2 changes: 2 additions & 0 deletions docs/identity-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,8 @@ curl -iX POST \

#### Response:

> **Tip:** Use[jq](https://www.digitalocean.com/community/tutorials/how-to-transform-json-data-with-jq) to format the JSON responses in this tutorial

The response header returns an `X-Subject-token` which identifies who has logged on the application. This token is
required in all subsequent requests to gain access.

Expand Down
5 changes: 5 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,11 @@ the concept of a project object model (POM), Maven can manage a project's build,
central piece of information. Maven can be used to define and download our dependencies and to build and package Java or
Scala code into a JAR file.

### JQ <img src="https://jqlang.github.io/jq/jq.png" align="left" height="30" width="30" style="border-right-style:solid; border-right-width:10px; border-color:transparent; background: transparent">

[jq](https://jqlang.github.io/jq/) is a lightweight and flexible command-line JSON processor which can be used
to format the JSON responses received from the context broker and other FIWARE components. More information about how to use jq can be found [here](https://www.digitalocean.com/community/tutorials/how-to-transform-json-data-with-jq)

## Data models

The tutorials define a series of data-models to be used within the `@context`. More information about the classes and
Expand Down
2 changes: 2 additions & 0 deletions docs/iot-agent-json.md
Original file line number Diff line number Diff line change
Expand Up @@ -613,6 +613,8 @@ curl -G -iX GET 'http://localhost:1026/ngsi-ld/v1/entities/urn:ngsi-ld:Device:te

#### Response:

> **Tip:** Use[jq](https://www.digitalocean.com/community/tutorials/how-to-transform-json-data-with-jq) to format the JSON responses in this tutorial

```json
{
"@context": "http://context/ngsi-context.jsonld",
Expand Down
2 changes: 2 additions & 0 deletions docs/iot-agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -602,6 +602,8 @@ curl -G -iX GET 'http://localhost:1026/ngsi-ld/v1/entities/urn:ngsi-ld:Device:te

#### Response:

> **Tip:** Use[jq](https://www.digitalocean.com/community/tutorials/how-to-transform-json-data-with-jq) to format the JSON responses in this tutorial

```json
{
"@context": "http://context/ngsi-context.jsonld",
Expand Down
2 changes: 2 additions & 0 deletions docs/merge-patch.md
Original file line number Diff line number Diff line change
Expand Up @@ -329,6 +329,8 @@ the entities have changed after each operation.

#### 5 Request:

> **Tip:** Use[jq](https://www.digitalocean.com/community/tutorials/how-to-transform-json-data-with-jq) to format the JSON responses in this tutorial
```console
curl -L -X GET \
'http://localhost:1026/ngsi-ld/v1/entities/urn:ngsi-ld:City:001' \
Expand Down
2 changes: 2 additions & 0 deletions docs/ngsi-ld-operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -413,6 +413,8 @@ curl -G -iX GET 'http://localhost:1026/ngsi-ld/v1/entities/urn:ngsi-ld:Temperatu

#### Response:

> **Tip:** Use[jq](https://www.digitalocean.com/community/tutorials/how-to-transform-json-data-with-jq) to format the JSON responses in this tutorial

TemperatureSensor `urn:ngsi-ld:TemperatureSensor:001` is returned as _normalized_ NGSI-LD. Additional metadata is
returned because `options=sysAttrs`. By default, the `@context` is returned in the payload body (although this could be
moved due to content negotiation if the `Accept:application/json` had been set). The full response is shown below:
Expand Down
2 changes: 2 additions & 0 deletions docs/roles-permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -361,6 +361,8 @@ curl -iX POST \

#### Response:

> **Tip:** Use[jq](https://www.digitalocean.com/community/tutorials/how-to-transform-json-data-with-jq) to format the JSON responses in this tutorial

```text
HTTP/1.1 201 Created
X-Subject-Token: d848eb12-889f-433b-9811-6a4fbf0b86ca
Expand Down
2 changes: 2 additions & 0 deletions docs/short-term-history.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,8 @@ curl -L -X GET \

#### Response:

> **Tip:** Use[jq](https://www.digitalocean.com/community/tutorials/how-to-transform-json-data-with-jq) to format the JSON responses in this tutorial

The response will look similar to the following:

```json
Expand Down
2 changes: 2 additions & 0 deletions docs/time-series-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -312,6 +312,8 @@ curl -X GET \

#### Response:

> **Tip:** Use[jq](https://www.digitalocean.com/community/tutorials/how-to-transform-json-data-with-jq) to format the JSON responses in this tutorial

```json
[
{
Expand Down
2 changes: 2 additions & 0 deletions docs/[email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,8 @@ curl -X GET \

#### Response:

> **Tip:** Use[jq](https://www.digitalocean.com/community/tutorials/how-to-transform-json-data-with-jq) to format the JSON responses in this tutorial

The response will look similar to the following:

```json
Expand Down

0 comments on commit 2f645ad

Please sign in to comment.