From fa6b6c4817e902e657c930268263c2221c23fbd3 Mon Sep 17 00:00:00 2001 From: Alberto Abella Date: Thu, 7 Sep 2023 04:56:16 +0200 Subject: [PATCH] updated DataQualityAssessment/doc/spec.md --- DataQualityAssessment/doc/spec.md | 161 ++++++++++++++++++++++-------- 1 file changed, 119 insertions(+), 42 deletions(-) diff --git a/DataQualityAssessment/doc/spec.md b/DataQualityAssessment/doc/spec.md index 382c17b..1de1603 100644 --- a/DataQualityAssessment/doc/spec.md +++ b/DataQualityAssessment/doc/spec.md @@ -8,14 +8,23 @@ Global description: **This entity describes the data quality properties of a measurement, such as temperature.** - version: 0.0.1 + version: 0.0.2 ## List of properties [*] If there is not a type in an attribute is because it could have several types or different formats/patterns -- `accuracy[number]`: Accuracy measures the maximum systematic numerical error produced in a sensor measurement. - `address[object]`: The mailing address . Model: [https://schema.org/address](https://schema.org/address) - `alternateName[string]`: An alternative name for this item - `areaServed[string]`: The geographic area where a service or offered item is provided . Model: [https://schema.org/Text](https://schema.org/Text) - `completeness[number]`: Completeness quantifies the number of missed measurements or observations in a given time window - `dataProvider[string]`: A sequence of characters identifying the provider of the harmonised data entity. - `dateCalculated[string]`: Date of the calculated entity defined by the user. - `dateCreated[string]`: Entity creation timestamp. This will usually be allocated by the storage platform. - `dateModified[string]`: Timestamp of the last modification of the entity. This will usually be allocated by the storage platform. - `description[string]`: A description of this item - `id[*]`: Unique identifier of the entity - `location[*]`: Geojson reference to the item. It can be Point, LineString, Polygon, MultiPoint, MultiLineString or MultiPolygon - `name[string]`: The name of this item. - `outlier[object]`: Includes information about the outlier characteristics of the measurement. - `owner[array]`: A List containing a JSON encoded sequence of characters referencing the unique Ids of the owner(s) - `precision[number]`: Precision measures the standard deviation of a dataset. That is, it measures how close the values in the dataset are to each other. - `seeAlso[*]`: list of uri pointing to additional resources about the item - `source[string]`: A sequence of characters giving the original source of the entity data as a URL. Recommended to be the fully qualified domain name of the source provider, or the URL to the source object. - `synthetic[object]`: Includes information about the origin of the measurement. - `timeliness[number]`: Average timeliness of the data-stream - `type[string]`: NGSI Entity type. It has to be DataQualityAssessment +- `accuracy[number]`: Accuracy measures the maximum systematic numerical error produced in a sensor measurement - `address[object]`: The mailing address . Model: [https://schema.org/address](https://schema.org/address) - `addressCountry[string]`: The country. For example, Spain . Model: [https://schema.org/addressCountry](https://schema.org/addressCountry) + - `addressLocality[string]`: The locality in which the street address is, and which is in the region . Model: [https://schema.org/addressLocality](https://schema.org/addressLocality) + - `addressRegion[string]`: The region in which the locality is, and which is in the country . Model: [https://schema.org/addressRegion](https://schema.org/addressRegion) + - `district[string]`: A district is a type of administrative division that, in some countries, is managed by the local government + - `postOfficeBoxNumber[string]`: The post office box number for PO box addresses. For example, 03578 . Model: [https://schema.org/postOfficeBoxNumber](https://schema.org/postOfficeBoxNumber) + - `postalCode[string]`: The postal code. For example, 24004 . Model: [https://schema.org/https://schema.org/postalCode](https://schema.org/https://schema.org/postalCode) + - `streetAddress[string]`: The street address . Model: [https://schema.org/streetAddress](https://schema.org/streetAddress) +- `alternateName[string]`: An alternative name for this item - `areaServed[string]`: The geographic area where a service or offered item is provided . Model: [https://schema.org/Text](https://schema.org/Text) - `completeness[number]`: Completeness quantifies the number of missed measurements or observations in a given time window - `dataProvider[string]`: A sequence of characters identifying the provider of the harmonised data entity - `dateCalculated[date-time]`: Date of the calculated entity defined by the user - `dateCreated[date-time]`: Entity creation timestamp. This will usually be allocated by the storage platform - `dateModified[date-time]`: Timestamp of the last modification of the entity. This will usually be allocated by the storage platform - `description[string]`: A description of this item - `id[*]`: Unique identifier of the entity - `location[*]`: Geojson reference to the item. It can be Point, LineString, Polygon, MultiPoint, MultiLineString or MultiPolygon - `name[string]`: The name of this item - `outlier[object]`: Includes information about the outlier characteristics of the measurement - `isOutlier[boolean]`: Determine whether the measurement has been considered an outlier or not +- `owner[array]`: A List containing a JSON encoded sequence of characters referencing the unique Ids of the owner(s) - `precision[number]`: Precision measures the standard deviation of a dataset. That is, it measures how close the values in the dataset are to each other - `seeAlso[*]`: list of uri pointing to additional resources about the item - `source[string]`: A sequence of characters giving the original source of the entity data as a URL. Recommended to be the fully qualified domain name of the source provider, or the URL to the source object - `synthetic[object]`: Includes information about the origin of the measurement - `isSynthetic[boolean]`: Determine whether the measurement has been created synthetically or not +- `timeliness[number]`: Average timeliness of the data-stream - `type[string]`: NGSI Entity type. It has to be DataQualityAssessment Required properties - `id` - `type` @@ -32,7 +41,7 @@ DataQualityAssessment: description: 'This entity describes the data quality properties of a measurement, such as temperature.' properties: accuracy: - description: Accuracy measures the maximum systematic numerical error produced in a sensor measurement. + description: Accuracy measures the maximum systematic numerical error produced in a sensor measurement type: number x-ngsi: type: Property @@ -40,29 +49,51 @@ DataQualityAssessment: description: The mailing address properties: addressCountry: - description: 'Property. The country. For example, Spain. Model:''https://schema.org/addressCountry''' + description: 'The country. For example, Spain' type: string + x-ngsi: + model: https://schema.org/addressCountry + type: Property addressLocality: - description: 'Property. The locality in which the street address is, and which is in the region. Model:''https://schema.org/addressLocality''' + description: 'The locality in which the street address is, and which is in the region' type: string + x-ngsi: + model: https://schema.org/addressLocality + type: Property addressRegion: - description: 'Property. The region in which the locality is, and which is in the country. Model:''https://schema.org/addressRegion''' + description: 'The region in which the locality is, and which is in the country' type: string + x-ngsi: + model: https://schema.org/addressRegion + type: Property district: - description: 'A district is a type of administrative division that, in some countries, is managed by the local government.' + description: 'A district is a type of administrative division that, in some countries, is managed by the local government' type: string + x-ngsi: + type: Property postOfficeBoxNumber: - description: 'Property. The post office box number for PO box addresses. For example, 03578. Model:''https://schema.org/postOfficeBoxNumber''' + description: 'The post office box number for PO box addresses. For example, 03578' type: string + x-ngsi: + model: https://schema.org/postOfficeBoxNumber + type: Property postalCode: - description: 'Property. The postal code. For example, 24004. Model:''https://schema.org/https://schema.org/postalCode''' + description: 'The postal code. For example, 24004' type: string + x-ngsi: + model: https://schema.org/https://schema.org/postalCode + type: Property streetAddress: - description: 'Property. The street address. Model:''https://schema.org/streetAddress''' + description: The street address type: string + x-ngsi: + model: https://schema.org/streetAddress + type: Property streetNr: - description: Number identifying a specific property on a public street. + description: Number identifying a specific property on a public street type: string + x-ngsi: + type: Property type: object x-ngsi: model: https://schema.org/address @@ -85,26 +116,26 @@ DataQualityAssessment: type: number x-ngsi: type: Property - units: P1. + units: P1 dataProvider: - description: A sequence of characters identifying the provider of the harmonised data entity. + description: A sequence of characters identifying the provider of the harmonised data entity type: string x-ngsi: type: Property dateCalculated: - description: Date of the calculated entity defined by the user. + description: Date of the calculated entity defined by the user format: date-time type: string x-ngsi: type: Property dateCreated: - description: Entity creation timestamp. This will usually be allocated by the storage platform. + description: Entity creation timestamp. This will usually be allocated by the storage platform format: date-time type: string x-ngsi: type: Property dateModified: - description: Timestamp of the last modification of the entity. This will usually be allocated by the storage platform. + description: Timestamp of the last modification of the entity. This will usually be allocated by the storage platform format: date-time type: string x-ngsi: @@ -115,22 +146,26 @@ DataQualityAssessment: x-ngsi: type: Property id: - anyOf: &dataqualityassessment_-_properties_-_owner_-_items_-_anyof - - description: Property. Identifier format of any NGSI entity + anyOf: + - description: Identifier format of any NGSI entity maxLength: 256 minLength: 1 pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$ type: string - - description: Property. Identifier format of any NGSI entity + x-ngsi: + type: Property + - description: Identifier format of any NGSI entity format: uri type: string + x-ngsi: + type: Property description: Unique identifier of the entity x-ngsi: type: Property location: description: 'Geojson reference to the item. It can be Point, LineString, Polygon, MultiPoint, MultiLineString or MultiPolygon' oneOf: - - description: Geoproperty. Geojson reference to the item. Point + - description: Geojson reference to the item. Point properties: bbox: items: @@ -151,7 +186,9 @@ DataQualityAssessment: - coordinates title: GeoJSON Point type: object - - description: Geoproperty. Geojson reference to the item. LineString + x-ngsi: + type: GeoProperty + - description: Geojson reference to the item. LineString properties: bbox: items: @@ -175,7 +212,9 @@ DataQualityAssessment: - coordinates title: GeoJSON LineString type: object - - description: Geoproperty. Geojson reference to the item. Polygon + x-ngsi: + type: GeoProperty + - description: Geojson reference to the item. Polygon properties: bbox: items: @@ -201,7 +240,9 @@ DataQualityAssessment: - coordinates title: GeoJSON Polygon type: object - - description: Geoproperty. Geojson reference to the item. MultiPoint + x-ngsi: + type: GeoProperty + - description: Geojson reference to the item. MultiPoint properties: bbox: items: @@ -224,7 +265,9 @@ DataQualityAssessment: - coordinates title: GeoJSON MultiPoint type: object - - description: Geoproperty. Geojson reference to the item. MultiLineString + x-ngsi: + type: GeoProperty + - description: Geojson reference to the item. MultiLineString properties: bbox: items: @@ -250,7 +293,9 @@ DataQualityAssessment: - coordinates title: GeoJSON MultiLineString type: object - - description: Geoproperty. Geojson reference to the item. MultiLineString + x-ngsi: + type: GeoProperty + - description: Geojson reference to the item. MultiLineString properties: bbox: items: @@ -278,43 +323,67 @@ DataQualityAssessment: - coordinates title: GeoJSON MultiPolygon type: object + x-ngsi: + type: GeoProperty x-ngsi: - type: Geoproperty + type: GeoProperty name: - description: The name of this item. + description: The name of this item type: string x-ngsi: type: Property outlier: - description: Includes information about the outlier characteristics of the measurement. + description: Includes information about the outlier characteristics of the measurement properties: isOutlier: - description: Property. Determine whether the measurement has been considered an outlier or not. + description: Determine whether the measurement has been considered an outlier or not type: boolean + x-ngsi: + type: Property methodology: anyOf: - - description: Property. Identifier format of any NGSI entity + - description: Identifier format of any NGSI entity maxLength: 256 minLength: 1 pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$ type: string - - description: Property. Identifier format of any NGSI entity + x-ngsi: + type: Property + - description: Identifier format of any NGSI entity format: uri type: string - description: Relationship. Reference to the other entity including AI methodology information. + x-ngsi: + type: Property + description: Reference to the other entity including AI methodology information + x-ngsi: + type: Relationship type: object x-ngsi: type: Property owner: description: A List containing a JSON encoded sequence of characters referencing the unique Ids of the owner(s) items: - anyOf: *dataqualityassessment_-_properties_-_owner_-_items_-_anyof - description: Property. Unique identifier of the entity + anyOf: + - description: Identifier format of any NGSI entity + maxLength: 256 + minLength: 1 + pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$ + type: string + x-ngsi: + type: Property + - description: Identifier format of any NGSI entity + format: uri + type: string + x-ngsi: + type: Property + description: Unique identifier of the entity + x-ngsi: + type: Property type: array x-ngsi: type: Property precision: - description: 'Precision measures the standard deviation of a dataset. That is, it measures how close the values in the dataset are to each other.' + description: 'Precision measures the standard deviation of a dataset. That is, it measures how close the values in the dataset are to each other' type: number x-ngsi: type: Property @@ -331,27 +400,35 @@ DataQualityAssessment: x-ngsi: type: Property source: - description: 'A sequence of characters giving the original source of the entity data as a URL. Recommended to be the fully qualified domain name of the source provider, or the URL to the source object.' + description: 'A sequence of characters giving the original source of the entity data as a URL. Recommended to be the fully qualified domain name of the source provider, or the URL to the source object' type: string x-ngsi: type: Property synthetic: - description: Includes information about the origin of the measurement. + description: Includes information about the origin of the measurement properties: isSynthetic: - description: Property. Determine whether the measurement has been created synthetically or not. + description: Determine whether the measurement has been created synthetically or not type: boolean + x-ngsi: + type: Property methodology: anyOf: - - description: Property. Identifier format of any NGSI entity + - description: Identifier format of any NGSI entity maxLength: 256 minLength: 1 pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$ type: string - - description: Property. Identifier format of any NGSI entity + x-ngsi: + type: Property + - description: Identifier format of any NGSI entity format: uri type: string - description: Relationship. Reference to the other entity including AI methodology information. + x-ngsi: + type: Property + description: Reference to the other entity including AI methodology information + x-ngsi: + type: Relationship type: object x-ngsi: type: Property @@ -360,7 +437,7 @@ DataQualityAssessment: type: number x-ngsi: type: Property - units: minutes. + units: minutes type: description: NGSI Entity type. It has to be DataQualityAssessment enum: