Skip to content

Commit

Permalink
Merge pull request #520 from opengeospatial/fix_part2_build
Browse files Browse the repository at this point in the history
fixes includes
  • Loading branch information
ghobona authored Feb 16, 2024
2 parents cd2b641 + cbe18c7 commit 6169e5e
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 6 deletions.
6 changes: 6 additions & 0 deletions extensions/pubsub/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,9 @@ The repo is organized as follows:
- organized in multiple sections and directories
* openapi - normative OpenAPI components specified by the standard
* examples - JSON and XML examples

## Building

Build the document from this folder.

`docker run -v "$(pwd)":/metanorma -v ${HOME}/.fontist/fonts/:/config/fonts metanorma/metanorma metanorma compile --agree-to-terms -t ogc -x html standard/document.adoc`
9 changes: 8 additions & 1 deletion extensions/pubsub/standard/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,11 @@ This repository contains the content for an OGC standard.

== Building

Run `make`.
Build the document from the folder above.

```
cd /GitHub/ogcapi-environmental-data-retrieval/extensions/pubsub

docker run -v "$(pwd)":/metanorma -v ${HOME}/.fontist/fonts/:/config/fonts metanorma/metanorma metanorma compile --agree-to-terms -t ogc -x html,pdf standard/document.adoc

```
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,10 @@ An example WIS2 Notification Message can be found below, extending the OGC API -
====
[source,json]
----
include::https://raw.githubusercontent.com/opengeospatial/ogcapi-environmental-data-retrieval/master/extensions/pubsub/examples/json/pubsub-message-payload.json[]
include::../../examples/json/pubsub-message-payload.json[]
----
====

== Pub/Sub Message Payload Schema (Normative)

[[message-payload-schema]]

Expand All @@ -28,6 +27,6 @@ include::https://raw.githubusercontent.com/opengeospatial/ogcapi-environmental-d
====
[source,yaml]
----
include::https://raw.githubusercontent.com/opengeospatial/ogcapi-environmental-data-retrieval/master/extensions/pubsub/openapi/schemas/pubsub-message-payload-schema.yaml[]
include::../../openapi/schemas/pubsub-message-payload-schema.yaml[]
----
====
5 changes: 3 additions & 2 deletions extensions/pubsub/standard/sections/annex-pubsub.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The API is described using the https://www.asyncapi.com/[AysncAPI 3.0.0 specific
====
[source,yaml]
----
include::https://raw.githubusercontent.com/opengeospatial/ogcapi-environmental-data-retrieval/master/extensions/pubsub/examples/yaml/asyncapi.yaml[]
include::../../examples/yaml/asyncapi.yaml[]
----
====

Expand Down Expand Up @@ -57,6 +57,7 @@ Breaking down into the components:
** `security`: reference to supported authentication types

====
[source,yaml]
----
servers:
mqtt:
Expand Down Expand Up @@ -142,8 +143,8 @@ Different Pub/Sub protocols are supported as additional server objects, and can
** `collections/stream_gage/items`

====
----
[source,yaml]
----
operations:
notify-collections:
action: receive
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,4 +70,5 @@ and can be used to notify users that a resource has been updated or deleted. If
----

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

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

0 comments on commit 6169e5e

Please sign in to comment.