Commit fc7fef16 authored by Jason Fox's avatar Jason Fox
Browse files

Escape @ character

parent e1c6193e
Loading
Loading
Loading
Loading
+3 −3
Original line number Diff line number Diff line
@@ -1553,7 +1553,7 @@ format.
}
```

### C.2.4 @context
### C.2.4 \@context

The disposition of the _`@context`_ can be as an inline JSON object, as a
dereferenceable URI or as a (multiple) combination of both. In the examples
@@ -1833,7 +1833,7 @@ shown above, because _`@type`_ is compacted to _`type`_:
}
```

## C.6 @context utilization clarifications
## C.6 \@context utilization clarifications

When expanding or compacting JSON-LD terms, the JSON-LD _`@context`_ to be used
is always the one provided in the current API request. For the benefit of users
@@ -2089,7 +2089,7 @@ _`@context`_ terms or when the Core _`@context`_ has not been previously
included by the wrapper _`@context`_ (not recommended) provided within
developer's requests.

## C.8 @context processing clarifications
## C.8 \@context processing clarifications

JSON-LD Specification [n.2] says that "If a term is redefined within a context,
all previous rules associated with the previous definition are removed". In
+13 −13
Original line number Diff line number Diff line
# 13 Storing, managing and serving @contexts operations
# 13 Storing, managing and serving \@contexts operations

## 13.1 Introduction

@@ -9,7 +9,7 @@ store custom user _`@contexts`_ at the Context Broker, effectively using the
Context Broker as a _`@context`_ server.

Moreover, in order to optimize performance, brokers may automatically store and
use the stored copies of common @contexts as a local cache, downloading them
use the stored copies of common _`@contexts`_ as a local cache, downloading them
just once, thus avoiding fetching them over and over again at each NGSI-LD
request. In order for the broker to understand if a needed _`@context`_ is
already in the local storage or not, the broker uses the URL, where the
@@ -63,7 +63,7 @@ Stored _`@contexts`_ are flagged as one of three kinds: ["Cached"]{.HTML-Code},
  create a new _`@context`_ that is an array, and it is going to be served from
  an own URL. These entries shall be served by brokers on-demand.

## 13.2 Add @context
## 13.2 Add \@context

### 13.2.1 Description

@@ -80,7 +80,7 @@ system as shown in Figure+++below.
:::

::: TF
Figure: Add @context use case
Figure: Add \@context use case
:::

### 13.2.3 Input data
@@ -106,7 +106,7 @@ be applied in case of invalid _`@context`_.
A locally unique URI identifying the _`@context`_ in the broker's
internal storage.

## 13.3 List @contexts
## 13.3 List \@contexts

### 13.3.1 Description

@@ -136,7 +136,7 @@ system as shown in Figure+++below.
:::

::: TF
Figure: List @contexts use case
Figure: List \@contexts use case
:::

### 13.3.3 Input data
@@ -171,7 +171,7 @@ fields:
- _`extraInfo`_ (OPTIONAL, used by implementations to report any kind of custom
  information).

## 13.4 Serve @context
## 13.4 Serve \@context

### 13.4.1 Description

@@ -191,7 +191,7 @@ stored within the NGSI-LD system as shown in Figure+++below.
:::

::: TF
Figure: Serve @context use case
Figure: Serve \@context use case
:::

### 13.4.3 Input data
@@ -199,10 +199,10 @@ Figure: Serve @context use case
- The locally unique identifier that identifies the desired _`@context`_
  in the broker's internal storage. Such unique identifiers are
  obtained by the client as a result of either a "Add
  @context" (clause 13.2) API operation or of a "List
  @contexts" (clause 13.3) API operation. For
  \@context" (clause 13.2) API operation or of a "List
  \@contexts" (clause 13.3) API operation. For
  _`@contexts`_ of kind ["Cached"]{.HTML-Code} this can also be
  the original URL the broker downloaded the @context from.
  the original URL the broker downloaded the _`@context`_ from.
- A boolean [details]{.HTML-Variable} flag indicating that a JSON object
  representing metadata about the _`@context`_, instead of the
  full content, is requested (optional).
@@ -229,7 +229,7 @@ The full content of the indicated _`@context`_ (or its metadata as
specified in clause 13.3.5), or
[ResourceNotFound]{.HTML-Error}/[OperationNotSupported]{.HTML-Error} errors.

## 13.5 Delete and reload @context
## 13.5 Delete and reload \@context

### 13.5.1 Description

@@ -252,7 +252,7 @@ _`@context`_ stored within the NGSI-LD system as shown in Figure+++below.
:::

::: TF
Figure: Delete and reload @context use case
Figure: Delete and reload \@context use case
:::

### 13.5.3 Input data
+9 −9
Original line number Diff line number Diff line
@@ -740,7 +740,7 @@ The NGSI-LD core _`@context`_ is publicly available at
[https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context-v1.9.jsonld](https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context-v1.9.jsonld)
and contains all the terms as specified in annex b.

#### 4.3.4.4 User @context
#### 4.3.4.4 User \@context

In addition to the terms defined by the core NGSI-LD _`@context`_ (as specified
in annex B), a user _`@context`_ is to be provided that contains the following
@@ -751,9 +751,9 @@ terms:
- One term associated to the name of each Attribute or any of its subclasses
  mapping the Property name with its Property Identifier (URI).

Generally, a user @context is provided with each request. However, in addition
to the core @context, NGSI-LD systems can allow the specfication of a user
default @context that then is to be used as @context, if no user @context is
Generally, a user _`@context`_ is provided with each request. However, in addition
to the core _`@context`_, NGSI-LD systems can allow the specfication of a user
default _`@context`_ that then is to be used as _`@context`_, if no user _`@context`_ is
provided with the request.

## 4.4 API overview
@@ -787,10 +787,10 @@ system) view of the Entities selected by the queries. It allows consuming these
Entities, but also using provision operations for making available predicted and
simulated information, e.g. as needed for digital twins.

The JSONLDContext API implements the capability of storing and serving @contexts
to clients. The stored @contexts can be managed by clients directly. Clients can
store custom user @contexts at the Context Broker, effectively using the Context
Broker as an @context server.
The JSONLDContext API implements the capability of storing and serving _`@contexts`_
to clients. The stored _`@contexts`_ can be managed by clients directly. Clients can
store custom user _`@contexts`_ at the Context Broker, effectively using the Context
Broker as an _`@context`_ server.

**Table 4.4-1: NGSI-LD API structure**

@@ -863,7 +863,7 @@ Broker as an @context server.
|                       | The information contained in a snapshot is updated using the Core API operations, but applied to the respective snapshot.                                               |
|                       |                                                                                                                                                                         |
+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| JSONLDContext API     | _JSON-LD @context Management_ - The _`@context`_ managment operations allow storing user JSON-LD `@context`, listing available `@context`,                              |
| JSONLDContext API     | _JSON-LD _`@context`_ Management_ - The _`@context`_ managment operations allow storing user JSON-LD `@context`, listing available `@context`,                          |
| (optional)            | serving stored JSON-LD `@context` and deleting user JSON-LD `@context`. In addition, a [Context Broker]{.HTML-Keyboard} can make                                        |
|                       | _cached_ JSON-LD _`@context`_ visible, which can then be deleted, or deleted and updated in a single step, in case the source JSON-LD _`@context`_ has changed.         |
|                       |                                                                                                                                                                         |
+1 −1
Original line number Diff line number Diff line
@@ -3759,7 +3759,7 @@ JSON-LD and Attributes in the **normalised** format.
### 5.3.2 JSON-LD
#### 5.3.2.1 Core and User @context
#### 5.3.2.1 Core and User \@context
NGSI-LD serialization is based on JSON-LD [n.2], a JSON-based format to
serialize Linked Data. The _`@context`_ in JSON-LD is used to expand terms,
+4 −4
Original line number Diff line number Diff line
@@ -139,10 +139,10 @@ Table: NGSI-LD API structure
|                           |                                                                                                                                                                                                                        | Clause 16.6 Delete Snapshot \                                                                   |
|                           |                                                                                                                                                                                                                        | Clause 16.8 Snapshot Status Notification                                                        |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| {TAC}                     | _JSON-LD @Context Management_ - operations for storing, managing and serving JSON-LD @contexts                                                                                                                         | Clause 13.2 Add @context \                                                                      |
|                           |                                                                                                                                                                                                                        | Clause 13.3 List @contexts \                                                                    |
| JSONLDContext API         |                                                                                                                                                                                                                        | Clause 13.4 Serve @context \                                                                    |
|                           |                                                                                                                                                                                                                        | Clause 13.5 Delete and Reload @context                                                          |
| {TAC}                     | _JSON-LD \@Context Management_ - operations for storing, managing and serving JSON-LD _`@contexts`_                                                                                                                    | Clause 13.2 Add \@context \                                                                     |
|                           |                                                                                                                                                                                                                        | Clause 13.3 List \@contexts \                                                                   |
| JSONLDContext API         |                                                                                                                                                                                                                        | Clause 13.4 Serve \@context \                                                                   |
|                           |                                                                                                                                                                                                                        | Clause 13.5 Delete and Reload \@context                                                         |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
:::

Loading