Skip to content

Commit 898be6b

Browse files
authored
update Recipe for embedded data notifications (#13)
* update Recipe for embedded data notifications * Update data-publishers.adoc
1 parent f871d4a commit 898be6b

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

cookbook/sections/data-publishers.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -84,16 +84,16 @@ Of course, always ensure your WNM is valid (see <<Validate a WIS2 Notification M
8484

8585
=== Publishing a WIS2 Notification Message with embedded data
8686

87-
A https://wmo-im.github.io/wis2-notification-message[WIS2 Notification Message] provides the ability to embed data as part of a message (see the https://wmo-im.github.io/wis2-notification-message/standard/wis2-notification-message-STABLE.html#_1_15_properties_content[Properties / Content] section of the specification).
87+
A https://wmo-im.github.io/wis2-notification-message[WIS2 Notification Message] provides the ability to embed data as part of a notification (see the https://wmo-im.github.io/wis2-notification-message/standard/wis2-notification-message-STABLE.html#_1_15_properties_content[Properties / Content] section of the specification).
8888

89-
Providing embedded data for direct access offers users access to the data without the need for downloading the file via the notification link (see the https://wmo-im.github.io/wis2-notification-message/standard/wis2-notification-message-STABLE.html#_1_16_links[Links] section of the specification).
89+
Providing embedded data for offers users the ability to access the data without the need to execute the additional step of downloading the data via the actionable link (see the https://wmo-im.github.io/wis2-notification-message/standard/wis2-notification-message-STABLE.html#_1_16_links[Links] section of the specification).
9090

91-
In some cases, a data publisher also may not wish to manage or publish the data link to infrastructure to an HTTP or FTP server.
91+
In some cases, a data publisher also prefer not to publish the corresponding actionable link to infrastructure (e.g. an HTTP or FTP server).
9292

93-
When the data publisher decides to use the embedded data feature without the need of implementing an actionable link providing access to the same data, the data publisher will:
93+
When the data publisher decides to not publish an actionable link and to rely exclusively on the embedded data feature, the data publisher will:
9494

9595
- use `properties.content` object to provide the data
96-
- use `properties.cache=false` to instruct WIS2 Global Cache Services to not cache the data
96+
- use `properties.cache=false` to instruct WIS2 Global Cache Services to not cache the data (note: `properties.cache` is not required for recommended data, since recommended data is not cached by WIS2 Global Caches)
9797
- provide a link object whose `href` results in HTTP 204 (No Content)
9898

9999
To provide an HTTP 204 link, there a couple of options:

0 commit comments

Comments
 (0)