w3c / lws-ucs

Use-cases for the Linked Web Storage Protocol
Other
4 stars 4 forks source link

[UC] Server / Storage Description #21

Open csarven opened 2 days ago

csarven commented 2 days ago

Status: Draft


Server and/or storage "description" (in its general sense) encompasses a category of use cases. I originally raised this issue in https://github.com/solid/specification/issues/355, where I provided several specific examples. I'm copying them here for reference:

Use cases:


As a [primary actor], I want [an action or feature], So that [a reason or benefit].

Preconditions:

What conditions must be in place or assumed before this use case can begin?

Trigger:

What (user or system) event or action initiates this use case?

Actors:

Describe the primary actor, and any other relevant actors involved in this use case

Distinction:

What unique challenges or distinguishing factors (like technical issues, user experience needs, workflow integration, etc.) are associated with this use case?

Scenario:

Describe an ideal or happy-case scenario where this use case would play out as intended.

Alternative case(s):

What alternative flows or variations should the system handle for this use case?

Error scenario:

What unexpected issues or errors might arise, and how should the system handle them?

Acceptance Criteria:

What conditions or criteria must be met for this use case to be considered successfully handled? What limitations are acceptable?

References:

List any relevant resources or examples that could inform this use case, possibly from other domains or solutions.

bumblefudge commented 2 days ago

Picard wants to find the server's contact information to request a diplomatic meeting about security audits.

i feel like there's a CVE user-story hiding in here 😄

bumblefudge commented 2 days ago

Torres wants her devices to use server's URI templates when naming particular kinds of resources.

Would some kind of templating language (even of optional/opt-in) be in-scope here? I feel like the group needs to decide (separately?) if this could be in-scope or if the timeline inclines the group to establish an "extension point" and comes back to it in later iterations...