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

- Amend images to use Attribute Fragment

- Update text to remove (Property or Relationship)
- Update text to explain use of `null` and NGSI-LD Null
parent dca92b21
Loading
Loading
Loading
Loading
Loading
+11 −18
Original line number Diff line number Diff line
@@ -161,8 +161,7 @@ Figure: Update Attributes use case
- Then, implementations shall perform a partial update patch operation over the
  remains of the target Entity as mandated by clause 8.4.2, using the following
  procedure.
- For each Attribute (Property or Relationship) included by the Entity Fragment
  at root level:
- For each Attribute included by the Entity Fragment at root level:
  - If the target Entity does not include a matching Attribute (considering term
    expansion rules as mandated by clause 8.2.4) then such Attribute shall be
    appended to the target Entity.
@@ -264,8 +263,7 @@ The following behaviour shall be exhibited by compliant implementations:
  operation is supported.
- Then, implementations shall perform an Append Attributes operation over the
  remains of the target Entity as using the following procedure:
  - For each Attribute (Property or Relationship) included by the Entity
    Fragment at root level:
  - For each Attribute included by the Entity Fragment at root level:
    - If a _`datasetId`_ is present in the Attribute included by the Entity
      Fragment:
      - If no Attribute instance of the same target Entity exists that has the
@@ -335,8 +333,7 @@ Figure: Partial Attribute update use case

- Entity ID (URI) of the concerned Entity, the target Entity.
- A selector of Entity types as specified by clause 7.2.2 (optional).
- Target Attribute (Property or Relationship) to be modified, identified by a
  name.
- Target Attribute to be modified, identified by a name.
- A JSON-LD document representing an NGSI-LD Attribute Fragment.

#### 10.2.5.4 Behaviour
@@ -420,8 +417,7 @@ Figure: Set Attribute Value use case

- Entity ID (URI) of the concerned Entity, the target Entity.
- A selector of Entity types as specified by clause 7.2.2 (optional).
- Target Attribute (Property or Relationship) to be modified, identified by a
  name.
- Target Attribute to be modified, identified by a name.
- A JSON or JSON-LD document representing an NGSI-LD Attribute Fragment (see
  clause 5.4.2)
- An optional parameter indicating an _`observedAt`_ timestamp to use when
@@ -520,8 +516,7 @@ Figure: Delete Attribute use case

- Entity ID (URI) of the concerned Entity, the target Entity.
- A selector of Entity types as specified by clause 7.2.2 (optional).
- Target Attribute (Property or Relationship) to be deleted, identified by a
  name.
- Target Attribute to be deleted, identified by a name.
- An optional parameter identifying the _`datasetId`_ of the target Attribute
  instance to be deleted. Otherwise the default Attribute instance is targeted.
- An optional flag _`deleteAll`_ indicating whether also all target Attribute
@@ -703,7 +698,7 @@ The following behaviour shall be exhibited by compliant implementations:

- Then, implementations shall perform a merge operation over the target Entity
  as mandated by clause 8.4.3, using the following procedure:
- For each Attribute (Property or Relationship) included by the Entity Fragment:
- For each Attribute included by the Entity Fragment:

  - If the target Entity does not include a matching Attribute (considering term
    expansion rules as mandated by clause 8.2.4), then such Attribute shall be
@@ -711,9 +706,9 @@ The following behaviour shall be exhibited by compliant implementations:
  - If the target Entity already includes a matching Attribute (considering term
    expansion rules as mandated by clause 8.2.4):

    - If the Attribute (Property or Relationship) to be merged is represented in
      a simplified representation, the _`type`_ of any pre-existing Attribute in
      the target entity shall be preserved.
    - If the Attribute to be merged is represented in a simplified
      representation, the _`type`_ of any pre-existing Attribute in the target
      entity shall be preserved.
    - If a common language tag is defined and a _LanguageProperty_ Attribute to
      be merged is represented as a string, the pre-existing _`languageMap`_
      JSON object shall be preserved. The string value shall only replace the
@@ -862,8 +857,7 @@ Figure: Replace Attribute use case

- Entity ID (URI) of the concerned Entity, the target Entity.
- A selector of Entity types as specified by clause 7.2.2 (optional).
- Target Attribute (Property or Relationship) to be replaced, identified by a
  name.
- Target Attribute to be replaced, identified by a name.
- A JSON-LD document representing an NGSI-LD Attribute Fragment.

#### 10.2.11.4 Behaviour
@@ -2211,8 +2205,7 @@ Figure: Retrieve Attribute Value use case
- A selector of Entity types as specified by clause 7.2.2 (optional).
- A flag indicating representation of the Attribute value to be returned
  (optional).
- Target Attribute (Property or Relationship) whose value is to be retrieved,
  identified by a name.
- Target Attribute whose value is to be retrieved, identified by a name.
- A specified language filter as per clause 7.2.7 (optional).
- A reference to a JSON-LD _`@context`_ (optional).
- A flag indicating whether to include additional inline [Linked
+13 −9
Original line number Diff line number Diff line
@@ -5612,8 +5612,8 @@ An NGSI-LD Element Fragment is a JSON Merge Patch document [n.17] and [i.18]
which describes changes to be made to a target JSON-LD document using a syntax
that closely mimics the document being modified.
An NGSI-LD Element Fragment is a JSON-LD Object which shall include the following
members:
An NGSI-LD Element Fragment is a JSON-LD Object which shall include the
following members:
- [id"]{.HTML-Code}: (optional for certain bindings where it can be determined
  from the operation signature). It shall be equal to the _`id`_ of the target
@@ -5834,6 +5834,13 @@ directly. In these cases, it shall be assumed that Entity ["id"]{.HTML-Code},
Entity ["type"]{.HTML-Code} and Attribute name can all be determined from the
operation signature.
The value _`null`_ shall not appear within Attribute fragments, with a limited
exception for Attribute fragments representing a _JSONProperty_, such as
[{"json": null}]{.HTML-Code}
A representation of NGSI-LD Null is only allowed within an Attribute fragment
during Partial update patch operations as described in clause 8.4.2
An Attribute Fragment in the normalised format, shall at a minimum be a JSON
Object holding the mandatory elements of an Attribute as described in clause
5.3.2.2 - i.e. ["type"]{.HTML-Code} and one of ["value"]{.HTML-Code},
@@ -5934,10 +5941,7 @@ Value only Representation of an NGSI-LD Attribute Fragment
<!-- prettier-ignore-end -->
An _`@context`_ cannot be embedded within the NGSI-LD Attribute fragment when
using the **value only** representation, therefore in this case, whenever an
_`@context`_ is required, it shall be supplied through the use of a Link header
(see Clause+++clause-6+++6.2.4).
The value _`null`_ or any representation of NGSI-LD Null are prohibited within
NGSI-LD Attribute fragments.
An _`@context`_ cannot be embedded within the Attribute fragment when using the
**value only** representation, therefore in this case, whenever an _`@context`_
is required, it shall be supplied through the use of a Link header (see
Clause 6.2.4).
+1 −1

File changed.

Preview size limit exceeded, changes collapsed.

+1 −1

File changed.

Preview size limit exceeded, changes collapsed.