Commit b1ec38b3 authored by Giuseppe Tropea's avatar Giuseppe Tropea
Browse files

Merge branch 'feature/csr-use-attributeNames' into 'master' 

DATA(26)000007_simplify_attributes_naming_in_RegistrationInfo

See merge request !25
parents f180bda3 62c7b416

md/annex-b.md

+17 −9
Original line number Diff line number Diff line
@@ -289,7 +289,23 @@ Such definition has been tested using [i.19]. 
      }

    },

    "idPattern": "ngsi-ld:idPattern",

    "information": "ngsi-ld:information",

    "information": {

      "@id": "ngsi-ld:information",

      "@context": {

        "propertyNames": {

          "@id": "ngsi-ld:propertyNames",

          "@type": "@vocab"

        },

        "relationshipNames": {

          "@id": "ngsi-ld:relationshipNames",

          "@type": "@vocab"

        },

        "attributeNames": {

          "@id": "ngsi-ld:attributeNames",

          "@type": "@vocab"

        }

      }

    },

    "instanceId": {

      "@id": "ngsi-ld:instanceId",

      "@type": "@id"
@@ -518,18 +534,10 @@ Such definition has been tested using [i.19]. 
      "@id": "ngsi-ld:problemDetails",

      "@type": "@json"

    },

    "propertyNames": {

      "@id": "ngsi-ld:propertyNames",

      "@type": "@vocab"

    },

    "q": "ngsi-ld:q",

    "refreshRate": "ngsi-ld:refreshRate",

    "registrationId": "ngsi-ld:registrationId",

    "registrationName": "ngsi-ld:registrationName",

    "relationshipNames": {

      "@id": "ngsi-ld:relationshipNames",

      "@type": "@vocab"

    },

    "resultStatus": "ngsi-ld:resultStatus",

    "scope": "ngsi-ld:scope",

    "scopeQ": "ngsi-ld:scopeQ",

md/annex-c.md

+2 −4
Original line number Diff line number Diff line
@@ -1825,8 +1825,7 @@ described. 
          "type": "Vehicle"

        }

      ],

      "propertyNames": ["brandName", "speed"],

      "relationshipNames": ["isParked"]

      "attributeNames": ["brandName", "speed", "isParked"],

    },

    {

      "entities": [
@@ -1839,8 +1838,7 @@ described. 
          "type": "OffStreetParking"

        }

      ],

      "propertyNames": ["availableSpotNumber", "totalSpotNumber"],

      "relationshipNames": ["isNextToBuilding"]

      "attributeNames": ["availableSpotNumber", "totalSpotNumber", "isNextToBuilding"],

    }

  ],

  "endpoint": "http://my.csource.org:1026",

md/clause-5.md

+36 −27
Original line number Diff line number Diff line
@@ -392,8 +392,10 @@ Table: Matrix of all Attributes 
|                                    |                                                                       | property-scoped definition within             |

|                                    |                                                                       | _`notUpdated`_                                |

+------------------------------------+-----------------------------------------------------------------------+-----------------------------------------------+

| _`attributeNames`_                 | EntityType                                                            | Type-scoped definition within                 |

| _`attributeNames`_                 | EntityType, RegistrationInfo                                          | Type-scoped definition within                 |

|                                    |                                                                       | [type="EntityType"]{.HTML-Code},              |

|                                    |                                                                       | property-scoped definition within             |

|                                    |                                                                       | '_`information`_'                             |

+------------------------------------+-----------------------------------------------------------------------+-----------------------------------------------+

| _`attributeTypes`_                 | Attribute                                                             | Type-scoped definition within                 |

|                                    |                                                                       | [type="Attribute"]{.HTML-Code}                |
@@ -658,7 +660,8 @@ Table: Matrix of all Attributes 
| _`properties`_                     | Feature                                                               | Type-scoped definition within                 |

|                                    |                                                                       | [type="Feature"]{.HTML-Code}                  |

+------------------------------------+-----------------------------------------------------------------------+-----------------------------------------------+

| _`propertyNames`_                  | RegistrationInfo                                                      |                                               |

| _`propertyNames`_                  | RegistrationInfo                                                      | property-scoped definition within             |

|                                    |                                                                       | '_`information`_'                             |

+------------------------------------+-----------------------------------------------------------------------+-----------------------------------------------+

| _`q`_                              | Query, Subscription                                                   |                                               |

+------------------------------------+-----------------------------------------------------------------------+-----------------------------------------------+
@@ -673,7 +676,8 @@ Table: Matrix of all Attributes 
+------------------------------------+-----------------------------------------------------------------------+-----------------------------------------------+

| _`registrationName`_               | CSourceRegistration                                                   |                                               |

+------------------------------------+-----------------------------------------------------------------------+-----------------------------------------------+

| _`relationshipNames`_              | RegistrationInfo                                                      |                                               |

| _`relationshipNames`_              | RegistrationInfo                                                      | property-scoped definition within             |

|                                    |                                                                       | '_`information`_'                             |

+------------------------------------+-----------------------------------------------------------------------+-----------------------------------------------+

| _`resultStatus`_                   | ExecutionResult                                                       |                                               |

+------------------------------------+-----------------------------------------------------------------------+-----------------------------------------------+
@@ -1280,7 +1284,7 @@ Table: Output only members of the NGSI-LD Relationship data type 
+----------------+---------------------------------+--------------------------------------------------------------------------------------------+---------------------------+---------------------------------------------------------------------------+

| entity         | Entity or Entity[] \            | See datatype definition in Clause+++root.2.6.4.1                                           | 0..1                      | An inline Entity obtained by Linked Entity Retrieval, corresponding       |

|                | (see note)                      |                                                                                            |                           | to the Relationship's target object. See Clause+++clause-7+++7.7.2.       |

|                |                                 | Only used in Linked Entity Retrieval, if the *join=inline* option                          |                           |                                                                           |

|                |                                 | Only used in Linked Entity Retrieval, if the _`join=inline`_ option                        |                           |                                                                           |

|                |                                 | is explicitly requested                                                                    |                           |                                                                           |

+----------------+---------------------------------+--------------------------------------------------------------------------------------------+---------------------------+---------------------------------------------------------------------------+

| instanceId     | String                          | Valid URI. Only used in temporal representation of Properties                              | 0..1                      | URI uniquely identifying a Relationship instance as mandated by           |
@@ -1466,22 +1470,22 @@ Table: Output only members of the NGSI-LD GeoProperty data type 
:::















::: TAL













+---------------+----------------------------------------------------+---------------------------------------------------------------------------------+-------------+---------------------------------------------------------------------------+













+---------------+----------------------------------------------------+-----------------------------------------------------------------------------------+-------------+---------------------------------------------------------------------------+















| Name          | Data Type                                          | Restrictions                                                                      | Cardinality | Description                                                               |













+===============+====================================================+=================================================================================+=============+===========================================================================+













+===============+====================================================+===================================================================================+=============+===========================================================================+















| createdAt     | String                                             | _DateTime_ (Clause+++root.2.2.4)                                                  | 0..1        | System generated creation timestamp. See Clause+++root.2.4                |













+---------------+----------------------------------------------------+---------------------------------------------------------------------------------+-------------+---------------------------------------------------------------------------+













+---------------+----------------------------------------------------+-----------------------------------------------------------------------------------+-------------+---------------------------------------------------------------------------+















| deletedAt     | String                                             | _DateTime_ (Clause+++root.2.2.4)                                                  | 0..1        | System generated deletion timestamp. See Clause+++root.2.4                |















|               |                                                    |                                                                                   |             |                                                                           |















|               |                                                    | It is only used in notifications reporting deletions                              |             |                                                                           |













+---------------+----------------------------------------------------+---------------------------------------------------------------------------------+-------------+---------------------------------------------------------------------------+













+---------------+----------------------------------------------------+-----------------------------------------------------------------------------------+-------------+---------------------------------------------------------------------------+















| instanceId    | String                                             | Valid URI. Only used in temporal representation of GeoProperties                  | 0..1        | URI uniquely identifying a _GeoProperty_ instance as mandated by          |















|               |                                                    |                                                                                   |             | Clause+++root.3.2.5                                                       |













+---------------+----------------------------------------------------+---------------------------------------------------------------------------------+-------------+---------------------------------------------------------------------------+













+---------------+----------------------------------------------------+-----------------------------------------------------------------------------------+-------------+---------------------------------------------------------------------------+















| modifiedAt    | String                                             | _DateTime_ (Clause+++root.2.2.4)                                                  | 0..1        | System generated last modification timestamp. See Clause+++root.2.4       |













+---------------+----------------------------------------------------+---------------------------------------------------------------------------------+-------------+---------------------------------------------------------------------------+













| previousValue | Any JSON value as defined by IETF RFC 8259 [n.3]   | Only used in Notifications, if the *showChanges* option is explicitly requested | 0..1        | Previous GeoProperty Value.                                               |













+---------------+----------------------------------------------------+---------------------------------------------------------------------------------+-------------+---------------------------------------------------------------------------+













+---------------+----------------------------------------------------+-----------------------------------------------------------------------------------+-------------+---------------------------------------------------------------------------+













| previousValue | Any JSON value as defined by IETF RFC 8259 [n.3]   | Only used in Notifications, if the _`showChanges`_ option is explicitly requested | 0..1        | Previous GeoProperty Value.                                               |













+---------------+----------------------------------------------------+-----------------------------------------------------------------------------------+-------------+---------------------------------------------------------------------------+















:::





























<!-- prettier-ignore-end -->










@@ -1629,7 +1633,7 @@ Table: Output only members of the NGSI-LD LanguageProperty data type













+---------------------+----------------------------------------------------+---------------------------------------------------------------------------------+-------------+---------------------------------------------------------------------------+















| modifiedAt          | String                                             | _DateTime_ (Clause+++root.2.2.4)                                                | 0..1        | System generated last modification timestamp. See Clause+++root.2.4       |















+---------------------+----------------------------------------------------+---------------------------------------------------------------------------------+-------------+---------------------------------------------------------------------------+













| previousLanguageMap | JSON Object                                        | A set of key-value pairs whose keys shall be strings representing               | 0..1        | Previous LanguageProperty's *languageMap.*                                |













| previousLanguageMap | JSON Object                                        | A set of key-value pairs whose keys shall be strings representing               | 0..1        | Previous LanguageProperty's _`languageMap`_.                              |















|                     |                                                    | IETF RFC 5646 [n.11] language codes and whose values shall be JSON strings.     |             |                                                                           |















|                     |                                                    |                                                                                 |             |                                                                           |















|                     |                                                    |                                                                                 |             |                                                                           |










@@ -2224,7 +2228,7 @@ Table: Query data type definition













| temporalQ           | TemporalParams     | See data type definition in Clause+++root.2.6.7.4                                                                          | 0..1         | Temporal Query to be present only for "Query                                                   |















|                     |                    |                                                                                                                            |              | [Temporal Evolution of Entities]{.HTML-Keyboard}" operation (Clause+++clause-11+++11.3.3).     |















+---------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------+













| attrs               | String[]           | Attribute name as short hand strings or URIs.                                                                              | 0..1         | A synonym for a combination of the *pick* and*q* members. **Deprecated**                       |













| attrs               | String[]           | Attribute name as short hand strings or URIs.                                                                              | 0..1         | A synonym for a combination of the _`pick`_ and _`q`_ members. **Deprecated**                  |















|                     |                    |                                                                                                                            |              |                                                                                                |















|                     |                    | Empty array (0 length) is not allowed                                                                                      |              | List of Attributes that shall be matched by Entities in order to be retrieved.                 |















|                     |                    |                                                                                                                            |              | If not present all Attributes will be retrieved.                                               |










@@ -2987,11 +2991,16 @@ Table: RegistrationInfo data type definition













|                   |                | Empty array (0 length) is not allowed.                                           |             |                                                                                  |















|                   |                | Restrictions in Clause+++clause-9+++9 apply as well                              |             |                                                                                  |















+-------------------+----------------+----------------------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------+













| propertyNames     | String[]       | Property names as short hand strings or URIs. Empty array is not allowed.        | 0..1        | Describes the Properties that the CSource may be able to provide.                |













|                   |                | Restrictions in Clause+++clause-9+++9 apply as well                              |             |                                                                                  |













| attributeNames    | String[]       | Attribute names as short hand strings or URIs. Empty array is not allowed.       | 0..1        | Describes the Attributes that the CSource may be able to provide.                |













|                   |                | Restrictions in Clause+++clause-9+++9 apply as well                              |             | A synonym for the combination of _`propertyNames`_ and _`relationshipNames`_.    |















+-------------------+----------------+----------------------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------+













| relationshipNames | String[]       | Relationship names as short hand strings or URIs. Empty array is not allowed.    | 0..1        | Describes the Relationships that the CSource may be able to provide.             |













|                   |                | Restrictions in Clause+++clause-9+++9 apply as well                              |             |                                                                                  |













| propertyNames     | String[]       | It is only used if _`attributeNames`_ is not present.                            | 0..1        | **Deprecated** The field is included in _`attributeNames`_.                      |













|                   |                | Property names as short hand strings or URIs. Empty array is not allowed.        |             |                                                                                  |













|                   |                | Restrictions in Clause+++clause-9+++9 apply as well                              |             | Describes the Properties that the CSource may be able to provide.                |













+-------------------+----------------+----------------------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------+













| relationshipNames | String[]       | It is only used if _`attributeNames`_ is not present.                            | 0..1        | **Deprecated** The field is included in _`attributeNames`_.                      |













|                   |                | Relationship names as short hand strings or URIs. Empty array is not allowed.    |             |                                                                                  |













|                   |                | Restrictions in Clause+++clause-9+++9 apply as well                              |             | Describes the Relationships that the CSource may be able to provide.             |















+-------------------+----------------+----------------------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------+















:::
























@@ -3461,7 +3470,7 @@ Table: Notification data type definition













+----------------+-----------------------------------------+-----------------------------------------------------+-------------+------------------------------------------------------------------------------------------------------+















| data           | NGSI-LD Entity[] or FeatureCollection   |                                                     | 1           | The content of the notification as NGSI-LD Entities. See Clause+++root.2.6.4.1.                      |















|                |                                         |                                                     |             |                                                                                                      |













|                |                                         |                                                     |             | If the notification has been triggered from a Subscription that has the _`notification.`_            |













|                |                                         |                                                     |             | If the notification has been triggered from a Subscription that has the _`notification`_.            |















|                |                                         |                                                     |             | _`endpoint.accept`_ field set to [application/geo+json]{.HTML-Code} then [data]{.HTML-Sample}        |















|                |                                         |                                                     |             | is returned as a _FeatureCollection_. In this case, if the _`notification.endpoint.receiverInfo`_    |















|                |                                         |                                                     |             | contains  the key ["Prefer"]{.HTML-Code} and it is set to the value ["body=json"]{.HTML-Code},       |