Notification Subscription Types
Living Document, 2022-05-05
More details about this document
- This version
- https://solidproject.org/TR/notification-subscription-types
- Created
- Published
- Modified
- Repository
- GitHub
- Issues
- Language
- English
- License
- MIT License
- Document Status
- Published
- In Reply To
- Solid Origin
- Policy
-
- Rule
- Offer
- Unique Identifier
- https://solidproject.org/TR/notification-subscription-types#document-policy-offer
- Target
- https://solidproject.org/TR/notification-subscription-types
- Permission
-
- Assigner
- W3C Solid Community Group
- Action
MIT License. Copyright © 2022 W3C Solid Community Group.
Abstract
This document serves as an index for Subscription Types that can be used with the Solid Notifications Protocol.
Status of This Document
This section describes the status of this document at the time of its publication.
This document was published by the Solid Community Group as Living Document. The sections that have been incorporated have been reviewed following the Solid process. However, the information in this document is still subject to change. You are invited to contribute any feedback, comments, or questions you might have.
Publication as Living Document does not imply endorsement by the W3C Membership. This document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.
This document was produced by a group operating under the W3C Community Contributor License Agreement (CLA). A human-readable summary is available.
Introduction
This section is non-normative.
The purpose of this document is to help with the discovery of Subscription Types published as a Solid Technical Report that can be used with the Solid Notifications Protocol [SOLID-NOTIFICATIONS-PROTOCOL].
This document also describes the indexing procedure to add new subscription types to the index.
This document is for:
- Resource server developers who want to implement subscription types.
- Application developers who want to implement a client to listen for updates using particular subscription types.
Conformance
All assertions, diagrams, examples, and notes are non-normative, as are all sections explicitly marked non-normative. Everything else is normative.
The key words “MUST” and “MUST NOT” are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.
Indexing Procedure
In order to update this index, an implementer MUST submit a modification request for this index, as a pull request on the repository where this index is hosted, where the modification request includes the following information:
- Name
- The name of the subscription type
- Description
- A short English description of the type's semantics.
- Reference
- Reference to the document that specifies the subscription type, preferably including a URI that can be used to retrieve a copy of the document.
Index
The information in these documents may be subject to change, therefore please see each document’s publication status and versions for further details.
Name | Description | Reference |
---|---|---|
WebSocketSubscription2021 | Subscription type that uses the WebSocket API. | WebSocketSubscription2021 |
References
Normative References
- [RFC2119]
- Key words for use in RFCs to Indicate Requirement Levels. S. Bradner. IETF. March 1997. Best Current Practice. URL: https://datatracker.ietf.org/doc/html/rfc2119
- [RFC8174]
- Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words. B. Leiba. IETF. May 2017. Best Current Practice. URL: https://datatracker.ietf.org/doc/html/rfc8174
Informative References
- [SOLID-NOTIFICATIONS-PROTOCOL]
- Solid Notifications Protocol. Aaron Coburn; Sarven Capadisli. W3C Solid Community Group. 1 April 2022. Version 0.1.0. URL: https://solidproject.org/TR/notifications-protocol