search

solid / notifications

Solid Notifications Technical Reports
https://solid.github.io/notifications/protocol
MIT License
11 stars 7 forks source link

s/WebhookChannel2023/WebHookChannel2023/ #179

Closed elf-pavlik closed 1 year ago

elf-pavlik commented 1 year ago

I'm currently drafting a draft PR for @jaxoncreed's https://github.com/o-development/solid-notification-client

I noticed that we use different capitalizations for WebSocket and Webhook. I think this might lead to some mistakes, one example is in CSS which uses WebHook instead of Webhook

https://github.com/CommunitySolidServer/CommunitySolidServer/blob/main/src/server/notifications/WebHookChannel2023/WebhookChannel2023Type.ts#L17

I think we should quickly consider changing capitalization in the spec, vocab, and context to have matching

This way CSS could just keep it as currently implemented and we will lower chances of similar misspelling happening in the future.

CxRes commented 1 year ago

No, this is not a mistake. That is how the two standards "brand" themselves. WebSocket and Webhook!

Our job is to reflect what protocol is being used as a notification channel.

elf-pavlik commented 1 year ago

Makes sense @CxRes I filed an issue in CSS repo :point_up:

Once we have a test suite available it should prevent any typos in implementations that pass it.

elf-pavlik commented 1 year ago

CSS has it fixed in v6.0.1