specification icon indicating copy to clipboard operation
specification copied to clipboard

WebHookSubscription2022 subscription type

Open michielbdejong opened this issue 3 years ago • 6 comments

We've started experimenting with implementing webhooks. The notifications spec gives a pretty good description of how they should work, but doesn't specify an RDF class name for them.

To be able to add them as a second subscription type, next to WebSocketSubscription2021 we were thinking of calling it WebHookSubscription2022.

Is anybody else working on webhooks already and maybe already using a different class name to announce them? If so, let's coordinate! :)

CC @jaxoncreed

michielbdejong avatar Sep 28 '22 20:09 michielbdejong

It will also have to be added in https://github.com/solid/vocab/pull/62 and in https://github.com/solid/specification/blob/main/notification-subscription-types.html

michielbdejong avatar Sep 28 '22 20:09 michielbdejong

There is a client https://github.com/o-development/solid-webhook-client

I see that https://github.com/solid/vocab/pull/62/ only includes notify:WebSocketSubscription2021 I guess currents drafts of subscription type could be added there.

elf-pavlik avatar Sep 28 '22 20:09 elf-pavlik

@michielbdejong is the major change you have around the content of the notification or around the notification method itself. If it's the former, I think that should be a part of the general notifications specification rather than something specific to to webhooks

jaxoncreed avatar Sep 29 '22 17:09 jaxoncreed

it's not a major change, note that the existing one is WebSocketSubscription2021 and the one that seems to be missing (unless we misunderstood) is WebHookSubscription2022.

The difference 2021/2022 is just that I thought the template was to add the current year at the time of proposing each one? Or should all subscription type names end in 2021?

michielbdejong avatar Sep 30 '22 08:09 michielbdejong

Each subscription type spec should define IRI denoting it

https://github.com/solid/notifications/blob/main/webhook-subscription-2021.md#1-introduction

This document proposes an implementation for the WebHookSubscription2021 Solid Notification protocol.

I think the action here would be

  • Updated draft to include full IRI in W3C namespace
  • Update https://github.com/solid/vocab/pull/62 to include it defined as a rdf:Class similar to

The difference 2021/2022 is just that I thought the template was to add the current year at the time of proposing each one? Or should all subscription type names end in 2021?

Implementations should just rely on the full IRI. How we name the spec is not an exact science, IMO for this draft, either 2021 or 2022 works as long as it is used in a consistent way throughout the draft.

The original proposal was created and migrated to its current repo back in 2021 https://github.com/solid/notifications/pull/23

elf-pavlik avatar Sep 30 '22 12:09 elf-pavlik