Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WebHookSubscription2022 subscription type #457

Open
michielbdejong opened this issue Sep 28, 2022 · 6 comments
Open

WebHookSubscription2022 subscription type #457

michielbdejong opened this issue Sep 28, 2022 · 6 comments

Comments

@michielbdejong
Copy link
Contributor

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
Copy link
Contributor Author

@elf-pavlik
Copy link
Member

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

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

@michielbdejong
Copy link
Contributor Author

For reference, here are our WIP implementation in Solid-Nextcloud and WIP tests in the Solid CRUD tests

@jaxoncreed
Copy link
Contributor

@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

@michielbdejong
Copy link
Contributor Author

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?

@elf-pavlik
Copy link
Member

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

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 solid/notifications#23

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants