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

Rename subscription resource #63

Closed
uvdsl opened this issue Apr 7, 2022 · 8 comments
Closed

Rename subscription resource #63

uvdsl opened this issue Apr 7, 2022 · 8 comments
Assignees
Labels

Comments

@uvdsl
Copy link
Collaborator

uvdsl commented Apr 7, 2022

Although it seems to me that subscription resource is a long used and pretty set in stone term,
I would like point out that the naming may be confusing:

From the term alone, one could get the idea that a subscription resource is a resource whose representation describes a subscription. Especially, when modelling the resource where requests are submitted to as a container (#36), or even more, when considering materializing requests for subscriptions in such a container.

In my mind, what is currently referred to as a subscription resource is a resource whose representation describes a service that provides the subscription/notification functionalities. (independent of that resource being also a container or can be POSTed to)

Thus, I would like to propose the terms subscription service resource which is described by its subscription service representation.

@csarven
Copy link
Member

csarven commented Jan 4, 2023

The notion of container is not part of Solid Notifications Protocol. "Resources" all the way down.

The subscription request (POST) and the response representations use the notification-channel-data-model and relevant notification-channel-types data model.

I don't have a strong opinion on re-naming, i.e., whether to use subscription resource or subscription service or subscription service resource. I would just say that the spec currently uses:

  • topic resource
  • description resource
  • subscription resource
  • notification channel

I find "resource" to be sufficient/simple. Notification channel may need to be referred as the notification channel resource, where applicable. Or, as you suggest, change subscription resource to subscription service resource.

Do others have thoughts/suggestions on this? We can still change / have more consistency.

@csarven csarven self-assigned this Jan 4, 2023
@uvdsl
Copy link
Collaborator Author

uvdsl commented Jan 4, 2023

Just to clearify, I do not take issue in the usage of the term resource but the ambiguity of the term subscription resource as it may be confused with a resource representing a subscription.

As the current notion of subscription resource refers to a resource where one can create/register a subscription via HTTP POST, I feel we could be more precise in terms of naming here.

@CxRes
Copy link
Member

CxRes commented Jan 5, 2023

I would second @uvdsl here. Furthermore, if we were to go down the container (containing resources for a subscription) route in the future, we would have the term "subscription resource" available to us.

@CxRes
Copy link
Member

CxRes commented Jan 5, 2023

My preference is "Subscription Service", which might then also be referred to as "Subscription Service Resource" where we need to make it explicit that we are referring to an HTTP resource.

@csarven
Copy link
Member

csarven commented Jan 16, 2023

I'd welcome renaming to "subscription service", but I propose an alternative view that can potentially tie up some loose ends:

The behaviour of subscription resource/service resembles a specialisation of LDN inbox with a particular data model. The inbox accepts subscription requests with optional features about a topic.

The request can be further specified with particular activity types (or shapes, see activityType proposal in #147 ).

The inbox can contain accepted subscriptions. Subscriptions can be modified or removed (TBD with #145 ).

While the minimal implementation of a Subscription Service need not have subscription resource be an inbox, it can certainly be extended in that way (re ldn-channel-2023). So, from ldn-channel-2023's point of view, the subscription resource/service thing is really a subscription inbox. notify:subscription need not be defined as a rdfs:subPropertyOf ldp:inbox either. Whether it is called service or inbox is perhaps minor/bikeshedding in the end.

If we introduce the notion where subscriptions (active notification channels) are identifiable units where they can be modified or removed for some (all?) channel types, there is not a whole lot difference from regular container/inbox behaviour. I think this actually ties up a bunch of our considerations, including #36 .

@CxRes
Copy link
Member

CxRes commented Jan 16, 2023

I am ok with "Subscription Inbox", though it is weird to subscribe to an Inbox because Inboxes accept mail not generates a letter on a request for a mail.

To @udvsl's original point, subscription resource is too generic, can imply many things and is confusing. Alternatives that show the thing dispenses subscriptions are acceptable.

@csarven
Copy link
Member

csarven commented Jan 19, 2023

Renaming Subscription Resource to Subscription Service works for me me.

I'd like to know what @elf-pavlik @acoburn thinks about this proposal or have other thoughts.

@csarven csarven closed this as completed in edd6c91 Feb 7, 2023
@csarven
Copy link
Member

csarven commented Feb 7, 2023

edd6c91 closed this issue by renaming subscription resource to subscription service as per https://github.com/solid/notifications-panel/blob/main/meetings/2023-02-02.md#rename-subscription-resource-to-subscription-service .

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

No branches or pull requests

3 participants