diff --git a/standard/sections/clause_7_normative_text.adoc b/standard/sections/clause_7_normative_text.adoc index 970ddcd..7746d9e 100644 --- a/standard/sections/clause_7_normative_text.adoc +++ b/standard/sections/clause_7_normative_text.adoc @@ -25,61 +25,61 @@ The table below provides an overview of the set of properties that may be includ |``version`` |**required** -|Version of message specification (see <<_version>>) +|Version of message specification (see <<_1_5_version>>) |``geometry`` |**Required** -|Geospatial location associated with the data or metadata (see <<_1_7_geometry>>) +|Geospatial location associated with the data or metadata (see <<_1_6_geometry>>) |``properties.pubtime`` |**Required** -|The date and time of when the notification was published, in RFC3339 format, UTC (see <<_1_8_properties_publication_time>>) +|The date and time of when the notification was published, in RFC3339 format, UTC (see <<_1_7_properties_publication_time>>) |``properties.data_id`` |**Required** -|Unique identifier of the data as defined by the data producer (see <<_1_9_properties_data_identification>>) +|Unique identifier of the data as defined by the data producer (see <<_1_8_properties_data_identification>>) |``properties.metadata_id`` |Optional -|Identifier for associated discovery metadata record to which the notification applies (see <<_1_10_properties_metadata_identification>>) +|Identifier for associated discovery metadata record to which the notification applies (see <<_1_9_properties_metadata_identification>>) |``properties.producer`` |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>>) +|Identifies the provider that initially captured and processed the source data, in support of data distribution on behalf of other Members (see <<_1_10_properties_producer>>) |``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_11_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_11_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_11_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_12_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_13_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_14_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_15_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_14_properties_content>>). include::../requirements/core/REQ_message_size.adoc[] @@ -93,7 +93,7 @@ include::../requirements/core/REQ_validation.adoc[] A universally unique identifier of the message using the UUID standard (link:https://datatracker.ietf.org/doc/html/rfc4122[RFC4122]). The identifier is generated by the originator of the message. It provides the anti-loop feature that is needed to ensure that the message will be seen once by all Global Brokers. It remains the same throughout the lifetime of the message in the WIS2 ecosystem. -The ``data_id`` is retained to ensure traceability and consistency of the same resource (see <<_1_9_properties_data_identification>>). +The ``data_id`` is retained to ensure traceability and consistency of the same resource (see <<_1_8_properties_data_identification>>). Example: [source,json] @@ -104,12 +104,12 @@ Example: include::../requirements/core/REQ_id.adoc[] include::../recommendations/core/PER_metadata_id.adoc[] -==== 1.6 Version +==== 1.5 Version The ``version`` property provides the version of WNM that the message conforms to. include::../requirements/core/REQ_version.adoc[] -==== 1.7 Geometry +==== 1.6 Geometry The type of geometry in a notification message may be ``Point`` or ``Polygon``. It can also be type ``null`` if the geometry cannot be derived. @@ -179,7 +179,7 @@ The type of geometry in a notification message may be ``Point`` or ``Polygon``. include::../requirements/core/REQ_geometry.adoc[] include::../recommendations/core/PER_geometry.adoc[] -==== 1.8 Properties / Publication time +==== 1.7 Properties / Publication time The ``pubtime`` property identifies the date/time when the notification was first posted or published by the originator. The date/time is encoded in RFC3339 format with the Coordinated Universal Time (UTC) timezone (``Z``). @@ -202,7 +202,7 @@ An update with newer ``pubtime`` and identical ``datetime`` indicates a newer ve include::../requirements/core/REQ_pubtime.adoc[] -==== 1.9 Properties / Data identification +==== 1.8 Properties / Data identification The ``data_id`` property uniquely identifies the data described by the notification and is defined by the data producer. A data producer may use an identification scheme of their choice. @@ -222,7 +222,7 @@ include::../recommendations/core/REC_data_id.adoc[] include::../recommendations/core/PER_data_id.adoc[] -==== 1.10 Properties / Metadata identification +==== 1.9 Properties / Metadata identification The ``metadata_id`` property uniquely identifies the associated discovery metadata record. This property is an important linkage between a WCMP2 dataset discovery metadata record and the related data notifications. The inclusion of this property allows a subscriber to consult additional documentation of the dataset and understand the access control applied to the data. @@ -239,7 +239,7 @@ Example: include::../recommendations/core/REC_metadata_id.adoc[] -==== 1.11 Properties / Producer +==== 1.10 Properties / Producer The ``producer`` property identifies the provider that initially captured and processed the source data, in support of data distribution on behalf of other Members. @@ -256,7 +256,7 @@ Example: include::../recommendations/core/REC_producer.adoc[] -==== 1.12 Properties / Temporal description +==== 1.11 Properties / Temporal description The ``datetime`` property identifies the date and time of the data (for example, when a measurement was observed). When a data or metadata is updated or deleted, this value should identify the original data or metadata, which can be significantly different from the current time. @@ -295,7 +295,7 @@ The ``start_datetime`` and ``end_datetime`` properties identify a temporal exten include::../requirements/core/REQ_temporal.adoc[] -==== 1.13 Properties / Cache +==== 1.12 Properties / Cache Core data, by default, is cached by Global Cache services as described in the _Guide to WIS_, Volume II. @@ -312,7 +312,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.13 Properties / Integrity For data verification, it is recommended to include data integrity information via the ``integrity`` property. Providing this information will allow data consumers to ensure that a given data granule has not been corrupted during download. @@ -338,7 +338,7 @@ Example: include::../recommendations/core/REC_integrity.adoc[] -==== 1.15 Properties / Content +==== 1.14 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 4096 bytes. @@ -367,7 +367,7 @@ include::../requirements/core/REQ_content.adoc[] include::../recommendations/core/REC_content.adoc[] include::../recommendations/core/PER_content.adoc[] -==== 1.16 Links +==== 1.15 Links The ``links`` array property consists of one or more objects providing URLs to access data. @@ -409,7 +409,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.15.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. @@ -431,7 +431,7 @@ For recommended data, WNM links may also provide links to resources that impleme }] ---- -==== 1.17 Additional properties +==== 1.16 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 break compliance with this specification.