michielbdejong / notifications

Solid Notifications Technical Reports

Solid Notifications

This repository hosts the technical reports for Solid Notifications.

These reports are incubated by the Solid Notifications Panel for inclusion in the Solid Technical Reports as part of the W3C Solid Community Group (CG). The reports are within the scope of the Notifications Panel Charter.

Technical Reports

Protocol

• Latest Published Version:
  • Solid Notifications Protocol
• Editors Draft:
  • Solid Notifications Protocol

Subscription Types

The Solid Notification Protocol makes it possible to define subscription types. An index of subscription types published by the CG is available at Notification Subscription Types.

The subscription types listed below are intended to be useful to application developers looking for existing subscription types as well as to authors of new subscription types.

• Latest Published Version:
  • WebSocketSubscription2021
• Editors Drafts:
  • WebSocketSubscription2021
  • StreamingHTTPSubscription2021
  • EventSourceSubscription2021
  • LinkedDataNotificationsSubscription2021
  • WebHookSubscription2021
  • WebPushSubscription2022

To add a new subscription type to the list, please create a PR including the name and the URL of the document describing the subscription type.

Diagrams

Mermaid

Sequence diagrams use Mermaid as source syntax. Github workflow generates them automatically before deplying github pages. Any file ending with .mmd will be rendered into file ending with .mmd.svg. For exmple source-flow.mmd results in source-flow.mmd.svg which can be referenced from the spec.

To preview diagrams locally following tools are available:

• Mermaid Live Editor
• Docker image
• mermaid-cli
• code editor extensions

All *.mmd.svg files are ignored by git so they won't be commited to the repository.