From 10e2b243f4824cab4e47790675c9db502e94b137 Mon Sep 17 00:00:00 2001 From: Alberto Abella Date: Thu, 7 Sep 2023 04:57:34 +0200 Subject: [PATCH] updated DataQualityAssessment/doc/spec_IT.md --- DataQualityAssessment/doc/spec_IT.md | 161 ++++++++++++++++++++------- 1 file changed, 119 insertions(+), 42 deletions(-) diff --git a/DataQualityAssessment/doc/spec_IT.md b/DataQualityAssessment/doc/spec_IT.md index cfb95b5..1cca5e2 100644 --- a/DataQualityAssessment/doc/spec_IT.md +++ b/DataQualityAssessment/doc/spec_IT.md @@ -8,14 +8,23 @@ Descrizione globale: **Questa entità descrive le proprietà di qualità dei dati di una misurazione, come la temperatura.** - versione: 0.0.1 + versione: 0.0.2 ## Elenco delle proprietà [*] Se non c'è un tipo in un attributo è perché potrebbe avere diversi tipi o diversi formati/modelli. -- `accuracy[number]`: L'accuratezza misura l'errore numerico sistematico massimo prodotto nella misura di un sensore. - `address[object]`: L'indirizzo postale . Model: [https://schema.org/address](https://schema.org/address) - `alternateName[string]`: Un nome alternativo per questa voce - `areaServed[string]`: L'area geografica in cui viene fornito il servizio o l'articolo offerto. . Model: [https://schema.org/Text](https://schema.org/Text) - `completeness[number]`: La completezza quantifica il numero di misurazioni o osservazioni mancate in una determinata finestra temporale. - `dataProvider[string]`: Una sequenza di caratteri che identifica il fornitore dell'entità di dati armonizzata. - `dateCalculated[string]`: Data dell'entità calcolata definita dall'utente. - `dateCreated[string]`: Timestamp di creazione dell'entità. Di solito viene assegnato dalla piattaforma di archiviazione. - `dateModified[string]`: Timestamp dell'ultima modifica dell'entità. Di solito viene assegnato dalla piattaforma di archiviazione. - `description[string]`: Descrizione dell'articolo - `id[*]`: Identificatore univoco dell'entità - `location[*]`: Riferimento geojson all'elemento. Può essere un punto, una stringa di linea, un poligono, un multi-punto, una stringa di linea o un poligono multiplo. - `name[string]`: Il nome di questo elemento. - `outlier[object]`: Include informazioni sulle caratteristiche anomale della misura. - `owner[array]`: Un elenco contenente una sequenza di caratteri codificata JSON che fa riferimento agli ID univoci dei proprietari. - `precision[number]`: La precisione misura la deviazione standard di un set di dati. In altre parole, misura quanto i valori del set di dati siano vicini tra loro. - `seeAlso[*]`: elenco di uri che puntano a risorse aggiuntive sull'elemento - `source[string]`: Una sequenza di caratteri che indica la fonte originale dei dati dell'entità come URL. Si consiglia di utilizzare il nome di dominio completamente qualificato del provider di origine o l'URL dell'oggetto di origine. - `synthetic[object]`: Include informazioni sull'origine della misura. - `timeliness[number]`: Tempestività media del flusso di dati - `type[string]`: Tipo di entità NGSI. Deve essere DataQualityAssessment +- `accuracy[number]`: L'accuratezza misura l'errore numerico sistematico massimo prodotto nella misurazione di un sensore. - `address[object]`: L'indirizzo postale . Model: [https://schema.org/address](https://schema.org/address) - `addressCountry[string]`: Il paese. Ad esempio, la Spagna . Model: [https://schema.org/addressCountry](https://schema.org/addressCountry) + - `addressLocality[string]`: La località in cui si trova l'indirizzo civico e che si trova nella regione . Model: [https://schema.org/addressLocality](https://schema.org/addressLocality) + - `addressRegion[string]`: La regione in cui si trova la località, e che si trova nel paese . Model: [https://schema.org/addressRegion](https://schema.org/addressRegion) + - `district[string]`: Un distretto è un tipo di divisione amministrativa che, in alcuni paesi, è gestita dal governo locale. + - `postOfficeBoxNumber[string]`: Il numero di casella postale per gli indirizzi di casella postale. Ad esempio, 03578 . Model: [https://schema.org/postOfficeBoxNumber](https://schema.org/postOfficeBoxNumber) + - `postalCode[string]`: Il codice postale. Ad esempio, 24004 . Model: [https://schema.org/https://schema.org/postalCode](https://schema.org/https://schema.org/postalCode) + - `streetAddress[string]`: L'indirizzo stradale . Model: [https://schema.org/streetAddress](https://schema.org/streetAddress) +- `alternateName[string]`: Un nome alternativo per questa voce - `areaServed[string]`: L'area geografica in cui viene fornito il servizio o l'articolo offerto. . Model: [https://schema.org/Text](https://schema.org/Text) - `completeness[number]`: La completezza quantifica il numero di misurazioni o osservazioni mancate in una determinata finestra temporale. - `dataProvider[string]`: una sequenza di caratteri che identifica il fornitore dell'entità di dati armonizzata - `dateCalculated[date-time]`: Data dell'entità calcolata definita dall'utente - `dateCreated[date-time]`: Timestamp di creazione dell'entità. Di solito viene assegnato dalla piattaforma di archiviazione - `dateModified[date-time]`: Timestamp dell'ultima modifica dell'entità. Di solito viene assegnato dalla piattaforma di archiviazione - `description[string]`: Descrizione dell'articolo - `id[*]`: Identificatore univoco dell'entità - `location[*]`: Riferimento geojson all'elemento. Può essere un punto, una stringa di linea, un poligono, un multi-punto, una stringa di linea o un poligono multiplo. - `name[string]`: Il nome di questo elemento - `outlier[object]`: Include informazioni sulle caratteristiche di outlier della misura. - `isOutlier[boolean]`: Determinare se la misura è stata considerata un outlier o meno. +- `owner[array]`: Un elenco contenente una sequenza di caratteri codificata JSON che fa riferimento agli ID univoci dei proprietari. - `precision[number]`: La precisione misura la deviazione standard di un set di dati. In altre parole, misura quanto i valori del set di dati siano vicini l'uno all'altro. - `seeAlso[*]`: elenco di uri che puntano a risorse aggiuntive sull'elemento - `source[string]`: Una sequenza di caratteri che indica la fonte originale dei dati dell'entità come URL. Si consiglia di utilizzare il nome di dominio completamente qualificato del provider di origine o l'URL dell'oggetto di origine. - `synthetic[object]`: Include informazioni sull'origine della misura - `isSynthetic[boolean]`: Determinare se la misura è stata creata in modo sintetico o meno. +- `timeliness[number]`: Tempestività media del flusso di dati - `type[string]`: Tipo di entità NGSI. Deve essere DataQualityAssessment Proprietà richieste - `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: