Skip to content

Commit

Permalink
Merge pull request #485 from opengeospatial/update-clause-10
Browse files Browse the repository at this point in the history
Part 2: add x-ogc-api-link concept to pubsub-channels Conformance Class
  • Loading branch information
chris-little authored Nov 30, 2023
2 parents d421cea + c08602e commit 64c436d
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,37 @@ Inspect all `+link+` objects in the response
Ensure that at least one exists with `+rel=service-desc+` that corresponds to an AsyncAPI 2.0 description
--

[.component,class=step]
--
Issue a HTTP GET request on that path
--

[.component,class=step]
--
Ensure that at least one exists with `+rel=service-desc+` that corresponds to an OpenAPI 3 description
--

[.component,class=step]
--
Issue a HTTP GET request on that path
--

[.component,class=step]
--
In the AsyncAPI response, for each channel object, look for an `+x-ogc-api-link+, noting the `+href+` property
--

[.component,class=step]
--
Issue a HTTP GET request on that path
--

[.component,class=step]
--
In the matching channel object from the previous two steps, test that the channel name has an equivalent path in the OpenAPI document
--



=====
====
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@
*A:*
Channel (topic/destination/node depending on protocol) identifiers SHALL be based on the same naming hierarchy as the OGC API endpoints which are generating the events that users subscribe to.
Channels (topic/destination/node depending on protocol) which have equivalent OGC API functionality SHALL be expressed within an AsyncAPI channel with an ``x-ogc-api-link`` object.
====
20 changes: 20 additions & 0 deletions extensions/pubsub/standard/sections/annex-pubsub.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -87,22 +87,42 @@ Different Pub/Sub protocols are supported as additional server objects, and can
----
channels:
collections:
x-ogc-api-link:
rel: data
type: application/json
href: https://example.org/collections
subscribe:
message:
$ref: '#/components/messages/collection_msg'
collections/wthr_stn:
x-ogc-api-link:
rel: collection
type: application/json
href: https://example.org/collections/wthr_stn
subscribe:
message:
$ref: '#/components/messages/collection_msg'
collections/stream_gage:
x-ogc-api-link:
rel: collection
type: application/json
href: https://example.org/collections/stream_gage
subscribe:
message:
$ref: '#/components/messages/collection_msg'
collections/wthr_stn/items:
x-ogc-api-link:
rel: items
type: application/json
href: https://example.org/collections/stream_gage/items
subscribe:
message:
$ref: '#/components/messages/wthr_stn_msg'
collections/stream_gage/items:
x-ogc-api-link:
rel: items
type: application/json
href: https://example.org/collections/stream_gage/items
subscribe:
message:
$ref: '#/components/messages/stream_gage_msg'
Expand Down

0 comments on commit 64c436d

Please sign in to comment.