Skip to content

Commit 526da03

Browse files
authored
Update README.md
1 parent 635740a commit 526da03

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ The tutorial uses [cUrl](https://ec.haxx.se/) commands throughout, but is also a
2121
[português](https://github.com/FIWARE/tutorials.Getting-Started/blob/master/README.pt.md) <br/> 🇪🇸 Este tutorial también
2222
está disponible en [español](https://github.com/FIWARE/tutorials.Getting-Started/blob/master/README.es.md)
2323

24+
2425
## Contents
2526

2627
<details>
@@ -126,7 +127,8 @@ docker run -d --name fiware-orion -h orion --network=fiware_default \
126127
-p 1026:1026 fiware/orion -dbhost mongo-db
127128
```
128129

129-
> **Note:** If you want to clean up and start again you can do so with the following commands
130+
> [!NOTE]
131+
> If you want to clean up and start again you can do so with the following commands
130132
>
131133
> ```
132134
> docker stop fiware-orion
@@ -151,7 +153,8 @@ export $(cat .env | grep "#" -v)
151153
docker compose -p fiware up -d
152154
```
153155
154-
> **Note:** If you want to clean up and start again you can do so with the following command:
156+
> [!NOTE]
157+
> If you want to clean up and start again you can do so with the following command:
155158
>
156159
> ```
157160
> docker compose -p fiware down
@@ -163,7 +166,7 @@ docker compose -p fiware up -d
163166
164167
You can check if the Orion Context Broker is running by making an HTTP request to the exposed port:
165168
166-
#### :one: Request:
169+
#### 1️⃣ Request:
167170
168171
```console
169172
curl -X GET \
@@ -200,6 +203,7 @@ The response will look similar to the following:
200203
}
201204
```
202205

206+
> [!TIP]
203207
> **What if I get a `Failed to connect to localhost port 1026: Connection refused` Response?**
204208
>
205209
> If you get a `Connection refused` response, the Orion Content Broker cannot be found where expected for this
@@ -240,7 +244,7 @@ creating two new entities (stores in **Berlin**). Any entity must have a `id` an
240244
attributes are optional and will depend on the system being described. Each additional attribute should also have a
241245
defined `type` and a `value` attribute.
242246
243-
#### :two: Request:
247+
#### 2️⃣ Request:
244248
245249
```console
246250
curl -iX POST \
@@ -279,7 +283,7 @@ curl -iX POST \
279283
}'
280284
```
281285
282-
#### :three: Request:
286+
#### 3️⃣ Request:
283287

284288
Each subsequent entity must have a unique `id` for the given `type`
285289

@@ -395,7 +399,7 @@ stripping out the type elements from each attribute
395399

396400
This example returns the data of `urn:ngsi-ld:Store:001`
397401

398-
#### :four: Request:
402+
#### 4️⃣ Request:
399403

400404
```console
401405
curl -G -X GET \
@@ -431,7 +435,7 @@ Because of the use of the `options=keyValues`, the response consists of JSON onl
431435
This example returns the data of all `Store` entities within the context data The `type` parameter limits the response
432436
to store entities only.
433437

434-
#### :five: Request:
438+
#### 5️⃣ Request:
435439

436440
```console
437441
curl -G -X GET \
@@ -485,7 +489,7 @@ Because of the use of the `options=keyValues`, the response consists of JSON onl
485489
This example returns all stores with the `name` attribute _Checkpoint Markt_. Filtering can be done using the `q`
486490
parameter - if a string has spaces in it, it can be URL encoded and held within single quote characters `'` = `%27`
487491

488-
#### :six: Request:
492+
#### 6️⃣ Request:
489493

490494
```console
491495
curl -G -X GET \
@@ -527,7 +531,7 @@ This example returns all stores found in the Kreuzberg District.
527531
Filtering can be done using the `q` parameter - sub-attributes are annotated using the dot syntax e.g.
528532
`address.addressLocality`
529533

530-
#### :seven: Request:
534+
#### 7️⃣ Request:
531535

532536
```console
533537
curl -G -X GET \
@@ -568,7 +572,7 @@ This example returns the data of all `Store` entities with a verified address.
568572

569573
Metadata queries can be made using the `mq` parameter.
570574

571-
#### :eight: Request:
575+
#### 8️⃣ Request:
572576

573577
```console
574578
curl -G -X GET \
@@ -622,7 +626,7 @@ Because of the use of the `options=keyValues`, the response consists of JSON onl
622626

623627
This example return all Stores within 1.5km the **Brandenburg Gate** in **Berlin** (_52.5162N 13.3777W_)
624628

625-
#### :nine: Request:
629+
#### 9️⃣ Request:
626630

627631
```console
628632
curl -G -X GET \

0 commit comments

Comments
 (0)