From 782019cdd7a3819a5b97926195583efa000e68d0 Mon Sep 17 00:00:00 2001 From: Alberto Abella Date: Tue, 5 Sep 2023 16:07:04 +0200 Subject: [PATCH] updated SeaConditions/doc/spec.md --- SeaConditions/doc/spec.md | 172 ++++++++++++++++++++++++++------------ 1 file changed, 117 insertions(+), 55 deletions(-) diff --git a/SeaConditions/doc/spec.md b/SeaConditions/doc/spec.md index 36243d7..dcbe6cf 100644 --- a/SeaConditions/doc/spec.md +++ b/SeaConditions/doc/spec.md @@ -15,7 +15,14 @@ ## List of properties [*] If there is not a type in an attribute is because it could have several types or different formats/patterns -- `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) - `dataProvider[string]`: A sequence of characters identifying the provider of the harmonised data entity. - `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. - `dateObserved[string]`: The date and time of this observation in ISO8601 UTC format. . Model: [https://schema.org/DateTime](https://schema.org/DateTime) - `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. - `owner[array]`: A List containing a JSON encoded sequence of characters referencing the unique Ids of the owner(s) - `pH[number]`: Acidity or basicity of an aqueous solution. . Model: [https://schema.org/Number](https://schema.org/Number) - `salinity[number]`: Amount of salts dissolved in water. . Model: [https://schema.org/Number](https://schema.org/Number) - `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. - `surfaceTemperature[number]`: Sea surface temperature. . Model: [https://schema.org/Number](https://schema.org/Number) - `type[string]`: NGSI-LD Entity Type. It has to be SeaConditions - `waveHeight[number]`: Height of the waves. . Model: [https://schema.org/Number](https://schema.org/Number) - `waveLevel[number]`: It indicates the height of the waves and also measures the swell of the sea. . Model: [https://schema.org/Number](https://schema.org/Number) - `wavePeriod[number]`: Indicates the time between the crests of a wave. . Model: [https://schema.org/Number](https://schema.org/Number) +- `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) - `dataProvider[string]`: A sequence of characters identifying the provider of the harmonised data entity - `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 - `dateObserved[date-time]`: The date and time of this observation in ISO8601 UTC format . Model: [https://schema.org/DateTime](https://schema.org/DateTime) - `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 - `owner[array]`: A List containing a JSON encoded sequence of characters referencing the unique Ids of the owner(s) - `pH[number]`: Acidity or basicity of an aqueous solution . Model: [https://schema.org/Number](https://schema.org/Number) - `salinity[number]`: Amount of salts dissolved in water . Model: [https://schema.org/Number](https://schema.org/Number) - `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 - `surfaceTemperature[number]`: Sea surface temperature . Model: [https://schema.org/Number](https://schema.org/Number) - `type[string]`: NGSI-LD Entity Type. It has to be SeaConditions - `waveHeight[number]`: Height of the waves . Model: [https://schema.org/Number](https://schema.org/Number) - `waveLevel[number]`: It indicates the height of the waves and also measures the swell of the sea . Model: [https://schema.org/Number](https://schema.org/Number) - `wavePeriod[number]`: Indicates the time between the crests of a wave . Model: [https://schema.org/Number](https://schema.org/Number) Required properties - `id` - `type` @@ -29,90 +36,122 @@
full yaml details ```yaml SeaConditions: - description: 'This entity contains a harmonised geographic description of sea conditions' + description: This entity contains a harmonised geographic description of sea conditions properties: address: - description: 'The mailing address' + 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' + 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 type: string + x-ngsi: + type: Property type: object x-ngsi: model: https://schema.org/address type: Property alternateName: - description: 'An alternative name for this item' + description: An alternative name for this item type: string x-ngsi: type: Property areaServed: - description: 'The geographic area where a service or offered item is provided' + description: The geographic area where a service or offered item is provided type: string x-ngsi: model: https://schema.org/Text type: Property 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 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: type: Property dateObserved: - description: 'The date and time of this observation in ISO8601 UTC format.' + description: The date and time of this observation in ISO8601 UTC format format: date-time type: string x-ngsi: model: https://schema.org/DateTime type: Property description: - description: 'A description of this item' + description: A description of this item type: string x-ngsi: type: Property id: - anyOf: &seaconditions_-_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 - description: 'Unique identifier of the entity' + 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: @@ -131,9 +170,11 @@ SeaConditions: required: - type - coordinates - title: 'GeoJSON Point' + 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: @@ -155,9 +196,11 @@ SeaConditions: required: - type - coordinates - title: 'GeoJSON LineString' + 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: @@ -181,9 +224,11 @@ SeaConditions: required: - type - coordinates - title: 'GeoJSON Polygon' + 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: @@ -204,9 +249,11 @@ SeaConditions: required: - type - coordinates - title: 'GeoJSON MultiPoint' + 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: @@ -230,9 +277,11 @@ SeaConditions: required: - type - coordinates - title: 'GeoJSON MultiLineString' + 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: @@ -258,25 +307,41 @@ SeaConditions: required: - type - coordinates - title: 'GeoJSON MultiPolygon' + title: GeoJSON MultiPolygon type: object + x-ngsi: + type: GeoProperty x-ngsi: type: GeoProperty name: - description: 'The name of this item.' + description: The name of this item type: string x-ngsi: type: Property owner: - description: 'A List containing a JSON encoded sequence of characters referencing the unique Ids of the owner(s)' + description: A List containing a JSON encoded sequence of characters referencing the unique Ids of the owner(s) items: - anyOf: *seaconditions_-_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 pH: - description: 'Acidity or basicity of an aqueous solution.' + description: Acidity or basicity of an aqueous solution maximum: 14 minimum: 0 type: number @@ -284,15 +349,15 @@ SeaConditions: model: https://schema.org/Number type: Property salinity: - description: 'Amount of salts dissolved in water.' + description: Amount of salts dissolved in water minimum: 0 type: number x-ngsi: model: https://schema.org/Number type: Property - units: 'Parts per thousand' + units: Parts per thousand seeAlso: - description: 'list of uri pointing to additional resources about the item' + description: list of uri pointing to additional resources about the item oneOf: - items: format: uri @@ -304,42 +369,42 @@ SeaConditions: 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 surfaceTemperature: - description: 'Sea surface temperature.' + description: Sea surface temperature type: number x-ngsi: model: https://schema.org/Number type: Property - units: 'Celsius degrees' + units: Celsius degrees type: - description: 'NGSI-LD Entity Type. It has to be SeaConditions' + description: NGSI-LD Entity Type. It has to be SeaConditions enum: - SeaConditions type: string x-ngsi: type: Property waveHeight: - description: 'Height of the waves.' + description: Height of the waves type: number x-ngsi: model: https://schema.org/Number type: Property units: Meters waveLevel: - description: 'It indicates the height of the waves and also measures the swell of the sea.' + description: It indicates the height of the waves and also measures the swell of the sea maximum: 9 minimum: 0 type: number x-ngsi: model: https://schema.org/Number type: Property - units: 'Douglas sea scale' + units: Douglas sea scale wavePeriod: - description: 'Indicates the time between the crests of a wave.' + description: Indicates the time between the crests of a wave type: number x-ngsi: model: https://schema.org/Number @@ -350,7 +415,7 @@ SeaConditions: - type type: object x-derived-from: "" - x-disclaimer: 'Redistribution and use in source and binary forms, with or without modification, are permitted provided that the license conditions are met. Copyleft (c) 2021 Contributors to Smart Data Models Program' + x-disclaimer: 'Redistribution and use in source and binary forms, with or without modification, are permitted provided that the license conditions are met. Copyleft (c) 2022 Contributors to Smart Data Models Program' x-license-url: https://github.com/smart-data-models/dataModel.Weather/blob/master/SeaConditions/LICENSE.md x-model-schema: https://smart-data-models.github.io/dataModel.Environment/SeaConditions/schema.json x-model-tags: "" @@ -398,7 +463,7 @@ SeaConditions:
show/hide example ```json { - "id": "SeaCondition-PlayaLevante.Benidorm.123456", + "id": "SeaCondition-PlayaLevante-Benidorm-123456", "type": "SeaConditions", "dateCreated": { "type": "DateTime", @@ -494,10 +559,7 @@ SeaConditions: "dateObserved": { "type": "Number", "value": "2021-02-20T06:45:00Z" - }, - "@context": [ - "https://smartdatamodels.org/context.jsonld" - ] + } } ```
@@ -530,7 +592,7 @@ SeaConditions: "waveLevel": 1, "wavePeriod": 1.5, "@context": [ - "https://smaertdatamodels.org/context.jsonld", + "https://smartdatamodels.org/context.jsonld", "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld", "https://raw.githubusercontent.com/smart-data-models/dataModel.Weather/master/context.jsonld" ]