Skip to content

Commit 0b1808d

Browse files
committed
Formatting texts
1 parent d7ba023 commit 0b1808d

15 files changed

+766
-774
lines changed

docs/concise.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -279,8 +279,8 @@ curl -iX POST 'http://localhost:1026/ngsi-ld/v1/entities/' \
279279
}'
280280
```
281281
282-
New entities can be added by making a POST request to the `/ngsi-ld/v1/entities` endpoint. Notice that because
283-
`name` is a Property that has no sub-attributes, it does not require a `value` element.
282+
New entities can be added by making a POST request to the `/ngsi-ld/v1/entities` endpoint. Notice that because `name` is
283+
a Property that has no sub-attributes, it does not require a `value` element.
284284

285285
As usual, the request will fail if the entity already exists in the context.
286286

@@ -406,11 +406,7 @@ The request will fail if any of the attributes already exist in the context. The
406406
been successful and the reason for failure (if any has occurred).
407407

408408
```json
409-
[
410-
"urn:ngsi-ld:TemperatureSensor:002",
411-
"urn:ngsi-ld:TemperatureSensor:003",
412-
"urn:ngsi-ld:TemperatureSensor:004"
413-
]
409+
["urn:ngsi-ld:TemperatureSensor:002", "urn:ngsi-ld:TemperatureSensor:003", "urn:ngsi-ld:TemperatureSensor:004"]
414410
```
415411

416412
### Batch Create/Overwrite New Data Entities
@@ -563,9 +559,9 @@ The sensor `urn:ngsi-ld:TemperatureSensor:001` is reading at 25°C. The response
563559
}
564560
```
565561

566-
Because `format=concise` was used this is response includes the metadata such as `unitCode` but not
567-
`"type": "Property"` Context data can be retrieved by making a GET request to the `/ngsi-ld/v1/entities/<entity-id>`
568-
endpoint and selecting the `attrs` using a comma separated list.
562+
Because `format=concise` was used this is response includes the metadata such as `unitCode` but not `"type": "Property"`
563+
Context data can be retrieved by making a GET request to the `/ngsi-ld/v1/entities/<entity-id>` endpoint and selecting
564+
the `attrs` using a comma separated list.
569565

570566
### Read a Data Entity (concise)
571567

@@ -909,7 +905,7 @@ The response details the selected attributes from the selected entities is retur
909905
"unitCode": "5K"
910906
},
911907
"phenologicalCondition": {
912-
"vocab": "femaleAdult"
908+
"vocab": "femaleAdult"
913909
},
914910
"reproductiveCondition": {
915911
"vocab": "inCalf"

docs/context-providers.md

Lines changed: 393 additions & 351 deletions
Large diffs are not rendered by default.

docs/entity-relationships.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -230,9 +230,8 @@ curl -iX POST \
230230
```
231231

232232
In both cases we have encoded each entity `id` according to the NGSI-LD
233-
[specification](https://cim.etsi.org/NGSI-LD/official/front-page.html) - the proposal
234-
is that each `id` is a URN follows a standard format: `urn:ngsi-ld:<entity-type>:<entity-id>`. This will mean that every
235-
`id` in the system will be unique.
233+
[specification](https://cim.etsi.org/NGSI-LD/official/front-page.html) - the proposal is that each `id` is a URN follows
234+
a standard format: `urn:ngsi-ld:<entity-type>:<entity-id>`. This will mean that every `id` in the system will be unique.
236235

237236
Device information can be requested by making a GET request on the `/ngsi-ld/v1/entities` endpoint. For example to
238237
return the context data of the devices.
@@ -386,7 +385,7 @@ The updated response including the `controlledAsset` attribute is shown below:
386385
"id": "urn:ngsi-ld:TemperatureSensor:001",
387386
"type": "TemperatureSensor",
388387
"description": "Temperature Gauge 1",
389-
"category": {"vocab": "sensor"},
388+
"category": { "vocab": "sensor" },
390389
"controlledProperty": "temperature",
391390
"temperature": 20,
392391
"controlledAsset": "urn:ngsi-ld:Building:farm001"

docs/extended-properties.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,8 @@ this principle, allowing the creation of NGSI-LD properties which directly confo
7777

7878
- An NGSI-LD **LanguageProperty** holds a set of internationalized strings and is defined using the JSON-LD
7979
`@language` keyword.
80-
- An NGSI-LD **VocabProperty** holds is a mapping of a URI to a value within the user'`@context` and is defined
81-
using the JSON-LD `@vocab` keyword.
80+
- An NGSI-LD **VocabProperty** holds is a mapping of a URI to a value within the user'`@context` and is defined using
81+
the JSON-LD `@vocab` keyword.
8282

8383
In each case, the meaning of the resultant payload will be altered according to the standard JSON-LD definitions, so the
8484
output NGSI-LD remains fully valid JSON-LD.
@@ -237,7 +237,8 @@ self-explanatory.
237237

238238
## Start Up
239239

240-
All services can be initialised from the command-line by running the [services](https://github.com/FIWARE/tutorials.Extended-Properties/blob/NGSI-LD/services) Bash script provided within
240+
All services can be initialised from the command-line by running the
241+
[services](https://github.com/FIWARE/tutorials.Extended-Properties/blob/NGSI-LD/services) Bash script provided within
241242
the repository. Please clone the repository and create the necessary images by running the commands as shown:
242243

243244
```bash
@@ -289,9 +290,9 @@ strings representing [IETF RFC 5646](https://www.rfc-editor.org/info/rfc5646) la
289290

290291
### Creating a new data entity
291292

292-
This example creates an entity with a **LanguageProperty** and a **VocabProperty**. Let's create a farm
293-
**Building** entity in which we want to make the `name` available in three different languages, _English_, _German_, and
294-
_Japanese_. The process will be to send a **POST** request to the Broker with the following information:
293+
This example creates an entity with a **LanguageProperty** and a **VocabProperty**. Let's create a farm **Building**
294+
entity in which we want to make the `name` available in three different languages, _English_, _German_, and _Japanese_.
295+
The process will be to send a **POST** request to the Broker with the following information:
295296

296297
#### 1️⃣ Request:
297298

@@ -350,9 +351,9 @@ Content-Length: 0
350351

351352
#### 2️⃣ Request:
352353

353-
This example creates a second entity with a **LanguageProperty** and a **VocabProperty**. Each subsequent entity
354-
must have a unique `id` for the given `type`. Note that within a `languageMap`, the `@none` simplified pair indicates
355-
the default fallback value to be displayed for unknown languages.
354+
This example creates a second entity with a **LanguageProperty** and a **VocabProperty**. Each subsequent entity must
355+
have a unique `id` for the given `type`. Note that within a `languageMap`, the `@none` simplified pair indicates the
356+
default fallback value to be displayed for unknown languages.
356357

357358
```bash
358359
curl -iX POST 'http://localhost:1026/ngsi-ld/v1/entities/' \
@@ -688,8 +689,8 @@ curl -G -X GET \
688689

689690
The User's `@context` is a mechanism for mapping URNs and defining the Entities held within the system It is therefore
690691
possible to retrieve _the same data_ using a different set of short names for the attributes, and in the case of a
691-
**VocabProperty**, different short names for the values of the attributes themselves. This is particularly useful
692-
when dealing with distributed data, federations and data spaces as the end user many not have full control of data held
692+
**VocabProperty**, different short names for the values of the attributes themselves. This is particularly useful when
693+
dealing with distributed data, federations and data spaces as the end user many not have full control of data held
693694
within another participant's context broker.
694695

695696
When the **Building** entities were created, we used an `@context` file called `ngsi-context.jsonld`. Within the
@@ -819,8 +820,8 @@ The `alternate-context.jsonld` `@context` file maps all the terms and enumeratio
819820
#### 1️⃣3️⃣ Request:
820821

821822
When `alternate-context.jsonld` included as a `Link` header in the request, the response will convert all the attribute
822-
names to short names used in `alternate-context.jsonld`, and in the case of a **VocabProperty**, return the short
823-
names for the value as well.
823+
names to short names used in `alternate-context.jsonld`, and in the case of a **VocabProperty**, return the short names
824+
for the value as well.
824825

825826
```bash
826827
curl -G -X GET \

docs/index.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Solution either by connecting to a series of dummy IoT devices or manipulating t
2626
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?template_repository=FIWARE/tutorials.NGSI-LD)
2727

2828
<!-- Global Summit
29-
<a href="https://www.fiware.org/global-summit/"><img src="https://fiware.github.io//catalogue/img/Summit25.png" width="240" height="70" /></a> &nbsp; <a href="https://www.eventbrite.co.uk/e/fiware-global-summit-2025-rabat-smart-city-morocco-tickets-1249129843989"><img src="https://fiware.github.io//catalogue/img/Training25.png" width="240" height="70" /></a>
29+
<a href="https://www.fiware.org/global-summit/"><img src="https://fiware.github.io//catalogue/img/Summit25.png" width="240" height="70" /></a> &nbsp; <a href="https://www.eventbrite.co.uk/e/fiware-global-summit-2025-rabat-smart-city-morocco-tickets-1249129843989"><img src="https://fiware.github.io//catalogue/img/Training25.png" width="240" height="70" /></a>
3030
-->
3131

3232
<blockquote>
@@ -144,8 +144,7 @@ consume context information. The concept of Linked Data based upon JSON-LD paylo
144144
passing data between participating organisations.
145145

146146
The NGSI-LD Specification is regularly updated published by ETSI. The latest specification is
147-
[version 1.7.1](https://cim.etsi.org/NGSI-LD/official/front-page.html) which was
148-
published in June 2023.
147+
[version 1.7.1](https://cim.etsi.org/NGSI-LD/official/front-page.html) which was published in June 2023.
149148

150149
An Excel file detailing the current compatibility of the bleeding edge development version of each context broker
151150
(Orion-LD, Scorpio, Stellio) against the features of the 1.6.1 specification can be found
@@ -168,16 +167,12 @@ attributes used can be found in the following:
168167
These first tutorials are an introduction to the NGSI-LD Context Brokers, and are an essential first step when learning
169168
to use NGSI-LD.
170169

171-
&nbsp; 101. [Understanding `@context`](understanding-@context.md) <br/>
172-
&nbsp; 102. [Working with `@context`](working-with-@context.md) <br/>
173-
&nbsp; 103. [CRUD Operations](ngsi-ld-operations.md) <br/>
174-
&nbsp; 104. [Concise Payloads](concise.md) <br/>
175-
&nbsp; 105. [Merge-Patch and Put](merge-patch.md) <br/>
176-
&nbsp; 106. [Entity Relationships](entity-relationships.md) <br/>
177-
&nbsp; 107. [Subscriptions](subscriptions.md) <br/>
178-
&nbsp; 108. [Registrations](context-providers.md) <br/>
179-
&nbsp; 109. [Temporal Operations](short-term-history.md) <br/>
180-
&nbsp; 110. [Extended Properties](extended-properties.md) <br/>
170+
&nbsp; 101. [Understanding `@context`](understanding-@context.md) <br/> &nbsp; 102.
171+
[Working with `@context`](working-with-@context.md) <br/> &nbsp; 103. [CRUD Operations](ngsi-ld-operations.md) <br/>
172+
&nbsp; 104. [Concise Payloads](concise.md) <br/> &nbsp; 105. [Merge-Patch and Put](merge-patch.md) <br/> &nbsp; 106.
173+
[Entity Relationships](entity-relationships.md) <br/> &nbsp; 107. [Subscriptions](subscriptions.md) <br/> &nbsp; 108.
174+
[Registrations](context-providers.md) <br/> &nbsp; 109. [Temporal Operations](short-term-history.md) <br/> &nbsp; 110.
175+
[Extended Properties](extended-properties.md) <br/>
181176

182177
<h3 style="box-shadow: 0px 4px 0px 0px #5dc0cf;">Internet of Things, Robots and third-party systems</h3>
183178

@@ -215,4 +210,3 @@ These tutorials show how to create, process, analyze or visualize context inform
215210
These tutorials show how to create data spaces using NGSI-LD and access NGSI-v2 sources
216211

217212
&nbsp; 601. [Federative Data Spaces](linked-data.md)<br/>
218-

docs/iot-agent-json.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
**Description:** This tutorial a wires up the dummy [JSON](https://json.org/)-based IoT devices using the
55
[IoT Agent for JSON](https://fiware-iotagent-json.readthedocs.io/en/latest/usermanual/index.html#user-programmers-manual)
66
devices so that measurements can be read and commands can be sent using
7-
[NGSI LD](https://cim.etsi.org/NGSI-LD/official/front-page.html) requests sent to an
8-
NGSI-LD compliant context broker such as the [Orion Context Broker](https://fiware-orion.readthedocs.io/en/latest/).
7+
[NGSI LD](https://cim.etsi.org/NGSI-LD/official/front-page.html) requests sent to an NGSI-LD compliant context broker
8+
such as the [Orion Context Broker](https://fiware-orion.readthedocs.io/en/latest/).
99

1010
The tutorial uses [cUrl](https://ec.haxx.se/) commands throughout, but is also available as
1111
[Postman documentation](https://fiware.github.io/tutorials.IoT-Agent-JSON/ngsi-ld.html)
@@ -54,7 +54,7 @@ A direct comparison of the two IoT Agents can be seen below:
5454
| HTTP commands posted to a well-known URL - response is in the reply | HTTP commands posted to a well-known URL - response is in the reply | Communications Handshake |
5555
| MQTT devices are identified by the path of the topic `/XXX/YYY` | MQTT devices are identified by the path of the topic `/XXX/YYY` | Device Identification |
5656
| MQTT commands posted to the `cmd` topic | MQTT commands posted to the `cmd` topic | Communications Handshake |
57-
| MQTT command responses posted to the `cmdexe` topic | MQTT command responses posted to the `cmdexe` topic | Communications Handshake |
57+
| MQTT command responses posted to the `cmdexe` topic | MQTT command responses posted to the `cmdexe` topic | Communications Handshake |
5858

5959
As can be seen, the message payload differs entirely between the two IoT Agents, but much of the rest of the protocol
6060
remains the same.
@@ -492,11 +492,11 @@ however it has been included here for completeness.
492492

493493
### Provisioning a Sensor
494494

495-
The NGSI-LD [specification](https://cim.etsi.org/NGSI-LD/official/front-page.html)
496-
mandates full URNs when creating context data entities, however the incoming messages from the devices will not be aware
497-
of this convention. Furthermore, the attribute name on the context data entity should match the short names found within
498-
the associated `@context` file. These mappings can be defined at the service group level as seen in the previous
499-
request, or they can be defined by provisioning each device individually.
495+
The NGSI-LD [specification](https://cim.etsi.org/NGSI-LD/official/front-page.html) mandates full URNs when creating
496+
context data entities, however the incoming messages from the devices will not be aware of this convention. Furthermore,
497+
the attribute name on the context data entity should match the short names found within the associated `@context` file.
498+
These mappings can be defined at the service group level as seen in the previous request, or they can be defined by
499+
provisioning each device individually.
500500

501501
Three types of measurement attributes can be provisioned:
502502

docs/iot-agent.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@
44
**Description:** This **NGSI-LD** tutorial introduces the concept of an **IoT Agent** and wires up the dummy
55
[UltraLight 2.0](https://fiware-iotagent-ul.readthedocs.io/en/latest/usermanual/index.html#user-programmers-manual) IoT
66
devices created in the [previous tutorial](https://github.com/FIWARE/tutorials.IoT-Sensors) so that measurements can be
7-
read and commands can be sent using
8-
[NGSI LD](https://cim.etsi.org/NGSI-LD/official/front-page.html) requests sent to an
7+
read and commands can be sent using [NGSI LD](https://cim.etsi.org/NGSI-LD/official/front-page.html) requests sent to an
98
NGSI-LD compliant context broker such as the [Orion Context Broker](https://fiware-orion.readthedocs.io/en/latest/).
109

1110
The tutorial uses [cUrl](https://ec.haxx.se/) commands throughout, but is also available as
@@ -487,11 +486,11 @@ however it has been included here for completeness.
487486

488487
### Provisioning a Sensor
489488

490-
The NGSI-LD [specification](https://cim.etsi.org/NGSI-LD/official/front-page.html)
491-
mandates full URNs when creating context data entities, however the incoming messages from the devices will not be aware
492-
of this convention. Furthermore, the attribute name on the context data entity should match the short names found within
493-
the associated `@context` file. These mappings can be defined at the service group level as seen in the previous
494-
request, ot they can be defined by provisioning each device individually.
489+
The NGSI-LD [specification](https://cim.etsi.org/NGSI-LD/official/front-page.html) mandates full URNs when creating
490+
context data entities, however the incoming messages from the devices will not be aware of this convention. Furthermore,
491+
the attribute name on the context data entity should match the short names found within the associated `@context` file.
492+
These mappings can be defined at the service group level as seen in the previous request, ot they can be defined by
493+
provisioning each device individually.
495494

496495
Three types of measurement attributes can be provisioned:
497496

0 commit comments

Comments
 (0)