Skip to content

Commit fe99efb

Browse files
committed
Update docs
1 parent 539f294 commit fe99efb

30 files changed

Lines changed: 281 additions & 329 deletions

context-provider/routes/proxy-ld.js

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -128,22 +128,19 @@ router.get('/weather/weatherConditions/ngsi-ld/v1/entities/:id', weatherDefaults
128128

129129
// Convenience endpoints for tweets readings
130130

131-
132-
133131
router.get('/catfacts/tweets/ngsi-ld/v1/entities/', tweetDefaults, (req, res, next) => {
134-
req.params.id = req.query.id || '12345'
132+
req.params.id = req.query.id || '12345';
135133
CatFactsNGSIProxy.getAsNgsiLD(req, res, next, true);
136-
});
134+
});
137135
router.get('/random/tweets/ngsi-ld/v1/entities/', tweetDefaults, (req, res, next) => {
138-
req.params.id = req.query.id || '12345'
136+
req.params.id = req.query.id || '12345';
139137
RandomNGSIProxy.getAsNgsiLD(req, res, next, true);
140-
});
138+
});
141139
router.get('/static/tweets/ngsi-ld/v1/entities/', tweetDefaults, (req, res, next) => {
142-
req.params.id = req.query.id || '12345'
140+
req.params.id = req.query.id || '12345';
143141
StaticNGSIProxy.getAsNgsiLD(req, res, next, true);
144142
});
145143

146-
147144
router.get('/random/tweets/ngsi-ld/v1/entities/:id', tweetDefaults, RandomNGSIProxy.getAsNgsiLD);
148145

149146
router.get('/static/tweets/ngsi-ld/v1/entities/:id', tweetDefaults, StaticNGSIProxy.getAsNgsiLD);
@@ -152,11 +149,6 @@ router.get('/twitter/tweets/ngsi-ld/v1/entities/:id', tweetDefaults, TwitterNGSI
152149

153150
router.get('/catfacts/tweets/ngsi-ld/v1/entities/:id', tweetDefaults, CatFactsNGSIProxy.getAsNgsiLD);
154151

155-
156-
157-
158-
159-
160152
// Not Supported Endpoints
161153

162154
router.all('/:proxy/:attributes/ngsi-ld/v1/entities', notSupported);

docker/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ in debug mode add `DEBUG=tutorial:*`
1919
- `NGSI_LD_PREFIX=` - Whether to use full URNs for devices
2020
- `SECURE_ENDPOINTS=true` - Enable Keyrock as PDP - default is `false`
2121

22-
## Dummy Ultralight Devices
22+
## Dummy JSON Devices
2323

2424
- `IOTA_HTTP_HOST=iot-agent` - The URL of the IoT Agent
2525
- `IOTA_HTTP_PORT=7896` - Port used by the dummy IoT devices to commuicate with the IoT Agent

docs/administrating-xacml.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ This application demonstrates the administration of level 3 Advanced Authorizati
105105
Management and Sensors-based application created in [previous tutorials](xacml-access-rules.md) and secures access to
106106
the context broker behind a [PEP Proxy](https://github.com/FIWARE/tutorials.PEP-Proxy/). It will make use of five FIWARE
107107
components - the [Orion Context Broker](https://fiware-orion.readthedocs.io/en/latest/),the
108-
[IoT Agent for UltraLight 2.0](https://fiware-iotagent-ul.readthedocs.io/en/latest/), the
108+
[IoT Agent for JSON](https://fiware-iotagent-json.readthedocs.io/en/latest/), the
109109
[Keyrock](https://fiware-idm.readthedocs.io/en/latest/) Identity Manager, the
110110
[Wilma](https://fiware-pep-proxy.readthedocs.io/en/latest/) PEP Proxy and the
111111
[Authzforce](https://authzforce-ce-fiware.readthedocs.io) XACML Server. All access control decisions will be delegated
@@ -119,10 +119,10 @@ Therefore, the overall architecture will consist of the following elements:
119119

120120
- The FIWARE [Orion Context Broker](https://fiware-orion.readthedocs.io/en/latest/) which will receive requests using
121121
[NGSI-v2](https://fiware.github.io/specifications/OpenAPI/ngsiv2).
122-
- The FIWARE [IoT Agent for UltraLight 2.0](https://fiware-iotagent-ul.readthedocs.io/en/latest/) which will receive
122+
- The FIWARE [IoT Agent for JSON](https://fiware-iotagent-json.readthedocs.io/en/latest/) which will receive
123123
southbound requests using [NGSI-v2](https://fiware.github.io/specifications/OpenAPI/ngsiv2) and convert them to
124-
[UltraLight 2.0](https://fiware-iotagent-ul.readthedocs.io/en/latest/usermanual/index.html#user-programmers-manual)
125-
commands for the devices.
124+
[JSON](https://fiware-iotagent-json.readthedocs.io/en/latest/usermanual/index.html#user-programmers-manual) commands
125+
for the devices.
126126
- FIWARE [Keyrock](https://fiware-idm.readthedocs.io/en/latest/) offer a complement Identity Management System
127127
including:
128128
- An OAuth2 authentication system for Applications and Users.
@@ -145,8 +145,8 @@ Therefore, the overall architecture will consist of the following elements:
145145
- Allows authorized users into restricted areas, it also delegates authorization decisions to the **Authzforce**
146146
PDP.
147147
- A webserver acting as set of [dummy IoT devices](iot-sensors.md) using the
148-
[UltraLight 2.0](https://fiware-iotagent-ul.readthedocs.io/en/latest/usermanual/index.html#user-programmers-manual)
149-
protocol running over HTTP - access to certain resources is restricted.
148+
[JSON](https://fiware-iotagent-json.readthedocs.io/en/latest/usermanual/index.html#user-programmers-manual) protocol
149+
running over HTTP - access to certain resources is restricted.
150150

151151
Since all interactions between the services are initiated by HTTP requests, the services can be containerized and run
152152
from exposed ports.

docs/application-mashups.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ JavaScript). The aim is to create an equivalent application without resorting to
7272
The Users in **Wirecloud** have been created using the standard [identity management](identity-management.md) component,
7373
**Keyrock**. Overall the system makes use of four FIWARE components - the
7474
[Orion Context Broker](https://fiware-orion.readthedocs.io/en/latest/),the
75-
[IoT Agent for UltraLight 2.0](https://fiware-iotagent-ul.readthedocs.io/en/latest/), the
75+
[IoT Agent for JSON](https://fiware-iotagent-json.readthedocs.io/en/latest/), the
7676
[Keyrock](https://fiware-idm.readthedocs.io/en/latest/) Identity Manager and the newly integrated
7777
[Wirecloud](https://wirecloud.readthedocs.io/en/stable/) application mashup tool. Usage of the Orion Context Broker is
7878
sufficient for an application to qualify as _“Powered by FIWARE”_.
@@ -81,10 +81,10 @@ Therefore, the overall architecture will consist of the following elements:
8181

8282
- The FIWARE [Orion Context Broker](https://fiware-orion.readthedocs.io/en/latest/) which will receive requests using
8383
[NGSI-v2](https://fiware.github.io/specifications/OpenAPI/ngsiv2).
84-
- The FIWARE [IoT Agent for UltraLight 2.0](https://fiware-iotagent-ul.readthedocs.io/en/latest/) which will receive
84+
- The FIWARE [IoT Agent for JSON](https://fiware-iotagent-json.readthedocs.io/en/latest/) which will receive
8585
southbound requests using [NGSI-v2](https://fiware.github.io/specifications/OpenAPI/ngsiv2) and convert them to
86-
[UltraLight 2.0](https://fiware-iotagent-ul.readthedocs.io/en/latest/usermanual/index.html#user-programmers-manual)
87-
commands for the devices.
86+
[JSON](https://fiware-iotagent-json.readthedocs.io/en/latest/usermanual/index.html#user-programmers-manual) commands
87+
for the devices.
8888
- The FIWARE [Keyrock](https://fiware-idm.readthedocs.io/en/latest/) Identity Management System:
8989
- Used by both the **Stock Management System** and **Wirecloud**.
9090
- FIWARE [Wirecloud](https://wirecloud.readthedocs.io/en/stable/) an application mashup tool for displaying NGSI
@@ -105,8 +105,8 @@ Therefore, the overall architecture will consist of the following elements:
105105
- Shows which products can be bought at each store.
106106
- Allows users to "buy" products and reduce the stock count.
107107
- A webserver acting as set of [dummy IoT devices](iot-sensors.md) using the
108-
[UltraLight 2.0](https://fiware-iotagent-ul.readthedocs.io/en/latest/usermanual/index.html#user-programmers-manual)
109-
protocol running over HTTP - access to certain resources is restricted.
108+
[JSON](https://fiware-iotagent-json.readthedocs.io/en/latest/usermanual/index.html#user-programmers-manual) protocol
109+
running over HTTP - access to certain resources is restricted.
110110
- Three additional microservices are used by **Wirecloud**:
111111
- [Memcache](https://memcached.org), a general-purpose distributed memory caching system.
112112
- [ElasticSearch](https://www.elastic.co/products/elasticsearch), a full-text search engine.

docs/big-data-flink.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ which is processing a continuous stream of context-data events.
5353
This application builds on the components and dummy IoT devices created in
5454
[previous tutorials](https://github.com/FIWARE/tutorials.IoT-Agent/). It will make use of three FIWARE components - the
5555
[Orion Context Broker](https://fiware-orion.readthedocs.io/en/latest/), the
56-
[IoT Agent for Ultralight 2.0](https://fiware-iotagent-ul.readthedocs.io/en/latest/), and the
56+
[IoT Agent for JSON](https://fiware-iotagent-json.readthedocs.io/en/latest/), and the
5757
[Cosmos Orion Flink Connector](https://fiware-cosmos-flink.readthedocs.io/en/latest/) for connecting Orion to an
5858
[Apache Flink cluster](https://ci.apache.org/projects/flink/flink-docs-stable/concepts/runtime.html). The Flink cluster
5959
itself will consist of a single **JobManager** _master_ to coordinate execution and a single **TaskManager** _worker_ to
@@ -68,9 +68,9 @@ Therefore the overall architecture will consist of the following elements:
6868
- Two **FIWARE Generic Enablers** as independent microservices:
6969
- The FIWARE [Orion Context Broker](https://fiware-orion.readthedocs.io/en/latest/) which will receive requests
7070
using [NGSI-v2](https://fiware.github.io/specifications/OpenAPI/ngsiv2)
71-
- The FIWARE [IoT Agent for Ultralight 2.0](https://fiware-iotagent-ul.readthedocs.io/en/latest/) which will
72-
receive northbound measurements from the dummy IoT devices in
73-
[Ultralight 2.0](https://fiware-iotagent-ul.readthedocs.io/en/latest/usermanual/index.html#user-programmers-manual)
71+
- The FIWARE [IoT Agent for JSON](https://fiware-iotagent-json.readthedocs.io/en/latest/) which will receive
72+
northbound measurements from the dummy IoT devices in
73+
[JSON](https://fiware-iotagent-json.readthedocs.io/en/latest/usermanual/index.html#user-programmers-manual)
7474
format and convert them to [NGSI-v2](https://fiware.github.io/specifications/OpenAPI/ngsiv2) requests for the
7575
context broker to alter the state of the context entities
7676
- An [Apache Flink cluster](https://ci.apache.org/projects/flink/flink-docs-stable/concepts/runtime.html) consisting
@@ -84,7 +84,7 @@ Therefore the overall architecture will consist of the following elements:
8484
- Used by the **IoT Agent** to hold device information such as device URLs and Keys
8585
- Three **Context Providers**:
8686
- A webserver acting as set of [dummy IoT devices](iot-sensors.md) using the
87-
[Ultralight 2.0](https://fiware-iotagent-ul.readthedocs.io/en/latest/usermanual/index.html#user-programmers-manual)
87+
[JSON](https://fiware-iotagent-json.readthedocs.io/en/latest/usermanual/index.html#user-programmers-manual)
8888
protocol running over HTTP.
8989
- The **Stock Management Frontend** is not used in this tutorial. It does the following:
9090
- Display store information and allow users to interact with the dummy IoT devices

docs/big-data-spark.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ which is processing a continuous stream of context-data events.
5050

5151
This application builds on the components and dummy IoT devices created in [previous tutorials](iot-agent.md). It will
5252
make use of three FIWARE components - the [Orion Context Broker](https://fiware-orion.readthedocs.io/en/latest/), the
53-
[IoT Agent for Ultralight 2.0](https://fiware-iotagent-ul.readthedocs.io/en/latest/), and the
53+
[IoT Agent for JSON](https://fiware-iotagent-json.readthedocs.io/en/latest/), and the
5454
[Cosmos Orion Spark Connector](https://fiware-cosmos-spark.readthedocs.io/en/latest/) for connecting Orion to an
5555
[Apache Spark cluster](https://spark.apache.org/docs/latest/cluster-overview.html). The Spark cluster itself will
5656
consist of a single **Cluster Manager** _master_ to coordinate execution and some **Worker Nodes** _worker_ to execute
@@ -65,9 +65,9 @@ Therefore, the overall architecture will consist of the following elements:
6565
- Two **FIWARE Generic Enablers** as independent microservices:
6666
- The FIWARE [Orion Context Broker](https://fiware-orion.readthedocs.io/en/latest/) which will receive requests
6767
using [NGSI](https://fiware.github.io/specifications/OpenAPI/ngsiv2).
68-
- The FIWARE [IoT Agent for Ultralight 2.0](https://fiware-iotagent-ul.readthedocs.io/en/latest/) which will
69-
receive northbound measurements from the dummy IoT devices in
70-
[Ultralight 2.0](https://fiware-iotagent-ul.readthedocs.io/en/latest/usermanual/index.html#user-programmers-manual)
68+
- The FIWARE [IoT Agent for JSON](https://fiware-iotagent-json.readthedocs.io/en/latest/) which will receive
69+
northbound measurements from the dummy IoT devices in
70+
[JSON](https://fiware-iotagent-json.readthedocs.io/en/latest/usermanual/index.html#user-programmers-manual)
7171
format and convert them to [NGSI](https://fiware.github.io/specifications/OpenAPI/ngsiv2) requests for the
7272
context broker to alter the state of the context entities.
7373
- An [Apache Spark cluster](https://spark.apache.org/docs/latest/cluster-overview.html) consisting of a single
@@ -81,7 +81,7 @@ Therefore, the overall architecture will consist of the following elements:
8181
- Used by the **IoT Agent** to hold device information such as device URLs and Keys.
8282
- Three **Context Providers**:
8383
- A webserver acting as set of [dummy IoT devices](iot-sensors.md) using the
84-
[Ultralight 2.0](https://fiware-iotagent-ul.readthedocs.io/en/latest/usermanual/index.html#user-programmers-manual)
84+
[JSON](https://fiware-iotagent-json.readthedocs.io/en/latest/usermanual/index.html#user-programmers-manual)
8585
protocol running over HTTP.
8686
- The **Stock Management Frontend** is not used in this tutorial. It does the following:
8787
- Display store information and allow users to interact with the dummy IoT devices.

docs/crud-operations.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -151,9 +151,9 @@ Once an `<entity-id>` is known within the context, individual data entities can
151151
`/v2/entities/<entity-id>` endpoint.
152152

153153
It is recommended that entity identifiers should be URNs following the
154-
[NGSI-LD specification](https://cim.etsi.org/NGSI-LD/official/front-page.html),
155-
therefore each `id` is a URN which follows a standard format: `urn:ngsi-ld:<entity-type>:<entity-id>`. This helps to
156-
make every `id` in the context data unique.
154+
[NGSI-LD specification](https://cim.etsi.org/NGSI-LD/official/front-page.html), therefore each `id` is a URN which
155+
follows a standard format: `urn:ngsi-ld:<entity-type>:<entity-id>`. This helps to make every `id` in the context data
156+
unique.
157157

158158
| HTTP Verb | `/v2/entities` | `/v2/entities/<entity-id>` |
159159
| ---------- | :--------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------: |

0 commit comments

Comments
 (0)