Skip to content

Commit

Permalink
address #537
Browse files Browse the repository at this point in the history
  • Loading branch information
tomkralidis committed Jun 13, 2024
1 parent 11bd36d commit a077821
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 16 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ properties:
required:
- pubtime
properties:
resource_id:
resourceId:
type: string
description: |
Identifies a resource identifier that may have multiple message notifications on
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[[rec_pubsub-notification-message-payload-resource_id]]
[[rec_pubsub-notification-message-payload-resourceid]]
[recommendation]
====
[%metadata]
identifier:: /rec/pubsub-notification-message-payload/resource_id
part:: A Pub/Sub notification message `+properties.resource_id+` property SHOULD be used to identify a resource that may have multiple message notifications on its state or lifecycle over time.
identifier:: /rec/pubsub-notification-message-payload/resourceid
part:: A Pub/Sub notification message `+properties.resourceId+` property SHOULD be used to identify a resource that may have multiple message notifications on its state or lifecycle over time.
====
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ include::../requirements/requirements_class_pubsub_channels.adoc[]
The OGC API service endpoint specified by a URL path of resources and sub-resources can be used in parallel as a channel description when the data publisher wishes to provide Pub/Sub capability for resources normally available via an OGC API implementations instance in the same way. Below are examples of service endpoints or resources normally available via HTTP, and how they can be re-used as topics for Pub/Sub workflow:

- ``/collections``: Notifies Subscribers whenever there is a change to the ``/collections`` resource (for example, addition of a new collection). The message payload would be collection metadata as defined in the https://docs.ogc.org/DRAFTS/20-024.html#collection-description[OGC API - Common Standard], or a message referencing the collection metadata.
- ``/collections/{collectionId}``: Notifies Subscribers whenever there is an update to a single `collection` resource (for example, spatial or temporal extents, new items, etc.). The message payload would be defined by the resource model of the given collection (items, etc.), or a message referencing the resource model of the collection.

- ``/collections/{collectionId}``: Notifies Subscribers whenever there is an update to a single `collection` resource (for example, spatial or temporal extents, new items, etc.). The message payload would be defined by either the resource model of the given collection (items, etc.), or a notification message of metadata referencing the collection with the relevant change.

For example, users could use a subscription to metadata records, which are usually small compared to the source data, and are therefore more transportable. This informs and notifies the user of changes prior to requesting the possibly large source data, especially when bandwidth is at a premium.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ representation or encoding. Notification messages can be issued using any encodi
suitable by a given publisher.

While the Publish-Subscribe (Pub/Sub) Requirements Class recommends a machine-readable message payload,
the Message Payload Requirements Class provides further requirements for interoperability of message payloads as part of
the Notification Message Payload Requirements Class provides further requirements for interoperability of message payloads as part of
an OGC API implementation ecosystem.

==== GeoJSON
Expand All @@ -34,7 +34,7 @@ It remains the same throughout the lifetime of the message. The identifier is v

include::../requirements/pubsub-notification-message-payload/REQ_rc-id.adoc[]
include::../recommendations/pubsub-notification-message-payload/REC_id.adoc[]
include::../recommendations/pubsub-notification-message-payload/REC_resource_id.adoc[]
include::../recommendations/pubsub-notification-message-payload/REC_resourceid.adoc[]

===== pubtime

Expand Down Expand Up @@ -88,5 +88,3 @@ and can be used to notify users that a resource has been created, updated or del
----

include::../requirements/pubsub-notification-message-payload/REQ_rc-operation.adoc[]

include::../recommendations/pubsub-notification-message-payload/PER_rc-operation.adoc[]

0 comments on commit a077821

Please sign in to comment.