Skip to content
Closed
Show file tree
Hide file tree
Changes from 9 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions schemas/notificationMessageGeoJSON.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ properties:
type: string
description: |
Identifies the provider that initially captured and processed the source data, in support of data distribution on behalf of other Members.
global-cache:
type: string
description: |
Centre identifier of Global Cache Service producing the notification.
datetime:
type:
- string
Expand Down
4 changes: 4 additions & 0 deletions schemas/wis2-notification-message-bundled.json
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,10 @@
"type": "string",
"description": "Identifies the provider that initially captured and processed the source data, in support of data distribution on behalf of other Members.\n"
},
"global-cache": {
"type": "string",
"description": "Centre identifier of Global Cache Service producing the notification.\n"
},
"datetime": {
"type": [
"string",
Expand Down
4 changes: 4 additions & 0 deletions standard/abstract_tests/ATS_class_core.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ include::./core/ATS_test_data_id.adoc[]

include::./core/ATS_test_temporal.adoc[]

==== Properties / Global Cache

This requirement is not applicable to ATS testing.

==== Links

include::./core/ATS_test_links.adoc[]
3 changes: 2 additions & 1 deletion standard/recommendations/core/PER_links.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,6 @@
|===
^|*Permission {counter:per-id}* |*/per/core/links*
^|A |A WNM `+links+` array property MAY provide link objects which reference APIs or Web Accessible Folders (WAF).
^|B |In addition to one of the links required for WIS2 data and/or metadata publication, the links array property MAY provide additional link objects as necessary.
|===
//per5
//per 6
2 changes: 1 addition & 1 deletion standard/recommendations/core/REC_metadata_id.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
[width="90%",cols="2,6a"]
|===
^|*Recommendation {counter:rec-id}* |*/rec/core/metadata_id*
^|A |A WNM SHOULD provide a `+properties.metadata_id+` property that identifies the associated WCMP dataset discovery metadata record. See requirement for metadata identification in WCMP (Appendix F, 1.4 Identifier).
^|A |A WNM SHOULD provide a `+properties.metadata_id+` property, which is a string, identifying the associated WCMP dataset discovery metadata record. See requirement for metadata identification in WCMP (Appendix F, 1.4 Identifier).
|===
//rec2
7 changes: 7 additions & 0 deletions standard/requirements/core/REQ_global-cache.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[[req_core_global-cache]]
[width="90%",cols="2,6a"]
|===
^|*Requirement {counter:req-id}* |*/req/core/global-cache*
^|A |When a notification is produced by a Global Cache Service, a WNM SHALL provide a `+properties.global-cache+` property.
|===
//req8
7 changes: 4 additions & 3 deletions standard/requirements/core/REQ_links.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@
^|B |The `+links+` array property SHALL contain at least one link with, at a minimum, the `+href+` and `+rel+` properties.
^|C |The links for core data SHALL NOT require further action in order to download the resource.
^|D |The links SHALL be HTTP, HTTPS, FTP or SFTP.
^|E |For new data and metadata notifications, the `+links+` array property SHALL provide at least one link with an IANA link relation of `canonical` to clearly identify the preferred access link.
^|F |For data or metadata update notifications, the `+links+` array property SHALL provide at least one link with a link relation of `update` to clearly identify the preferred access link.
^|G |For data or metadata deletions, the `+links+` array property SHALL provide at least one link with a link relation of `deletion` to clearly identify data which has been deleted or removed.
^|E |For new data and metadata notifications, the `+links+` array property SHALL provide exactly one link with an IANA link relation of `canonical` to clearly identify the preferred access link.
^|F |For data or metadata update notifications, the `+links+` array property SHALL provide exactly one link with a link relation of `update` to clearly identify the preferred access link.
^|G |For data or metadata deletions, the `+links+` array property SHALL provide exactly one link with a link relation of `deletion` to clearly identify data which has been deleted or removed.
^|H |For metadata deletions, the `properties.metadata_id` property SHALL be specified to support deletion of a WCMP2 record from the Global Discovery Catalogue.
^|I |The links array property SHALL contain **only one** link with a link relation value of `+canonical+`, `+update+`, or `+deletion+`. These link relations SHALL NOT be combined within a single notification.
|===
//req11
66 changes: 49 additions & 17 deletions standard/sections/clause_7_normative_text.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -52,39 +52,43 @@ The table below provides an overview of the set of properties that may be includ
|Optional
|Identifies the provider that initially captured and processed the source data, in support of data distribution on behalf of other Members (see <<_1_11_properties_producer>>)

|``properties.global-cache``
|Optional
|Centre identifier of Global Cache Service producing the notification (see <<_1_12_properties_global_cache>>)

|``properties.datetime``
|Optional
|Identifies the reference date and time of the data instance to which the notification is relayed, in RFC3339 format, UTC (see <<_1_12_properties_temporal_description>>)
|Identifies the reference date and time of the data instance to which the notification is relayed, in RFC3339 format, UTC (see <<_1_13_properties_temporal_description>>)

|``properties.start_datetime``
|Optional
|Identifies the start date and time of the data being published, in RFC3339 format (see <<_1_12_properties_temporal_description>>)
|Identifies the start date and time of the data being published, in RFC3339 format (see <<_1_13_properties_temporal_description>>)

|``properties.end_datetime``
|Optional
|Identifies the end date and time of the data being published, in RFC3339 format (see <<_1_12_properties_temporal_description>>)
|Identifies the end date and time of the data being published, in RFC3339 format (see <<_1_13_properties_temporal_description>>)

|``properties.cache``
|Optional
|Indicates whether the data in the notification should be cached (if not specified, the default value is `true`) (see <<_1_13_properties_cache>>)
|Indicates whether the data in the notification should be cached (if not specified, the default value is `true`) (see <<_1_14_properties_cache>>)

|``properties.integrity``
|Optional
|Specifies a checksum to be applied to the data to ensure that the download is accurate (see <<_1_14_properties_integrity>>)
|Specifies a checksum to be applied to the data to ensure that the download is accurate (see <<_1_15_properties_integrity>>)

|``properties.content``
|Optional
|Used to embed small products inline within the message (see <<_1_15_properties_content>>)
|Used to embed small products inline within the message (see <<_1_16_properties_content>>)

|``links``
|**Required**
|Online linkages for data retrieval or additional resources associated with the dataset (see <<_1_16_links>>)
|Online linkages for data retrieval or additional resources associated with the dataset (see <<_1_17_links>>)

|===

==== 1.2 Message size

The WIS2 Notification Message allows for the transmission of messages in a compact manner and includes the ability to embed content inline as required (see <<_1_15_properties_content>>).
The WIS2 Notification Message allows for the transmission of messages in a compact manner and includes the ability to embed content inline as required (see <<_1_16_properties_content>>).

include::../requirements/core/REQ_message_size.adoc[]

Expand Down Expand Up @@ -286,7 +290,24 @@ Example:

include::../recommendations/core/REC_producer.adoc[]

==== 1.12 Properties / Temporal description
==== 1.12 Properties / Global Cache

The ``global-cache`` property identifies the centre identifier of the Global Cache Service producing the message.

Example:

[source,json]
----
"properties": {
...
"global-cache": "de-dwd-global-cache"
...
}
----

include::../requirements/core/REQ_global-cache.adoc[]

==== 1.13 Properties / Temporal description

The ``datetime`` property identifies the date and time of the data (for example, when a measurement was observed).
When data or metadata are updated or deleted, this value should identify the original data or metadata, which can be significantly different from the current time.
Expand Down Expand Up @@ -325,7 +346,7 @@ The ``start_datetime`` and ``end_datetime`` properties identify a temporal exten

include::../requirements/core/REQ_temporal.adoc[]

==== 1.13 Properties / Cache
==== 1.14 Properties / Cache

Core data, by default, is cached by Global Cache services, as described in the _Guide to WIS_, Volume II.

Expand All @@ -342,7 +363,7 @@ However, a data producer can use the ``properties.cache`` value to request Globa

include::../recommendations/core/PER_cache.adoc[]

==== 1.14 Properties / Integrity
==== 1.15 Properties / Integrity

For data verification, it is recommended that data integrity information to be included via the ``integrity`` property. Providing this information will allow data consumers to ensure
that a given data granule has not been corrupted during download.
Expand All @@ -368,7 +389,7 @@ Example:

include::../recommendations/core/REC_integrity.adoc[]

==== 1.15 Properties / Content
==== 1.16 Properties / Content

The ``content`` property allows for the inclusion of data in the notification message when the length of the data, once encoded, is smaller than 4 096 bytes.

Expand Down Expand Up @@ -397,7 +418,7 @@ include::../requirements/core/REQ_content.adoc[]
include::../recommendations/core/REC_content.adoc[]
include::../recommendations/core/PER_content.adoc[]

==== 1.16 Links
==== 1.17 Links

The ``links`` array property consists of one or more objects providing URLs to access data.

Expand Down Expand Up @@ -439,7 +460,7 @@ include::../requirements/core/REQ_links.adoc[]
include::../recommendations/core/REC_links.adoc[]
include::../recommendations/core/PER_links.adoc[]

===== 1.16.1 Access control
===== 1.17.1 Access control

For recommended data, WNM links may also provide links to resources that implement access control in support of authentication and authorization. In secure data use cases, a user needs to be able to detect access-controlled data as part of data discovery and evaluation. The example demonstrates how to express access control using HTTP Basic authentication for a given data access service.

Expand All @@ -461,7 +482,7 @@ For recommended data, WNM links may also provide links to resources that impleme
}]
----

==== 1.17 Additional properties
==== 1.18 Additional properties

A WIS2 Notification Message can be extended as required for organizational purposes by adding properties (of any type) in the message. Additional properties do not render a notification non-compliant with the provisions of this specification.

Expand All @@ -481,11 +502,22 @@ Example:
}
----

Example, based on WCMP2 client-side filtering:

[source,json]
----
"properties": {
...
"wigos_station_identifier": "0-20000-0-71628"
...
}
----

include::../recommendations/core/PER_additional_properties.adoc[]

== 2. WIS2 notification message resources
=== 2.1 WMO Codes Registry
http://codes.wmo.int/wis/link-type
* http://codes.wmo.int/wis/link-type

=== 2.2 WMO schemas server
=== 2.2 WMO schemas server
Validation schemas, examples and other resources are published at https://schemas.wmo.int/wnm.