Skip to content

Commit df34777

Browse files
committed
Add note
1 parent a72f8eb commit df34777

2 files changed

Lines changed: 13 additions & 1 deletion

File tree

docs/understanding-@context.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,18 @@ It should be noted that definitions of the models examined so far are very gener
142142
to be of use in a working system, however using these models as the basis of interoperability will ensure that the
143143
resulting `@context` file will be understandable to the widest number of systems.
144144

145+
> **Note:** The Data Models used here for `@context` generation are defined using OpenAPI 3.0
146+
> [Swagger format](https://swagger.io/specification). To help with the generation of IRIs the specification has been
147+
> extended with additional annotations as necessary. The `x-ngsi` attribute, as the name suggests is just a simple
148+
> [Specification Extension](https://swagger.io/specification/#specificationExtensions) - usually it is not relevant to
149+
> Swagger, and indeed you could generate a simple `@context` file without it, but the data held within in has been used
150+
> to help generate a rich [`@graph`](https://w3c.github.io/json-ld-syntax/#dfn-graph-object) and more comprehensive
151+
> documentation.
152+
>
153+
> The simple NGSI-LD `@context` generator in the tutorial defaults to using `uri.fiware.org` namespaces and updates with
154+
> corrected URIs based on the `x-ngsi.uri` and `x-ngsi.uri-prefix` attributes. The code and defaults found within this
155+
> tutorial can be altered if necessary.
156+
145157
## Amending Models
146158

147159
The base data models are useful as a starting point but some enumerated values or attributes will be redundant other

0 commit comments

Comments
 (0)