Skip to content

New notification triggers: PUT/PATCH with 201 and 205 responses #3

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.

Sign up for GitHub

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

Closed
CxRes wants to merge 7 commits into from
Closed

New notification triggers: PUT/PATCH with 201 and 205 responses #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
70f29f3
chore: Bump actions/checkout
CxRes Oct 26, 2023
923a0c6
feat: Add "Container only" triggers
CxRes Oct 26, 2023
f697d19
feat: Add PUT/PATCH with 205 response as notification triggers
CxRes Oct 26, 2023
28e7eee
fix: Status Codes order for Resource only Triggers
CxRes Oct 26, 2023
8e9f521
fix: POST should trigger container notifications
CxRes Oct 26, 2023
c2674f7
typo: Punctuation in Triggers section
CxRes Oct 27, 2023
79f872c
refactor: Move Triggers to a Unified Table
CxRes Oct 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/auto-publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
permissions:
contents: write
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
with:
ref: main
- uses: w3c/spec-prod@v2
Expand Down
11 changes: 11 additions & 0 deletions src/index.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,17 @@ Status Text:
vertical-align: top;
}

table th.center{
text-align: center;
width: fit-content;
}

table td.tick{
text-align: center;
vertical-align: middle;
font-weight: 800;
}

@media (prefers-color-scheme: dark) {
table {
border-color: white;
Expand Down
67 changes: 42 additions & 25 deletions src/sections/triggers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,45 +1,62 @@
# Triggers # {#triggers}

The Solid Protocol [[!SOLID]] requires an LDP container's state is modified when certain HTTP events occur on a contained resource. Thus, an HTTP event on a resource can trigger a [=Solid server=] to transmit [PREP] notification not only on that resource but also on its container.
The Solid Protocol [[!SOLID]] requires an LDP container's state is modified when certain HTTP events occur on a contained resource. Thus, an HTTP event on a resource can trigger a [=Solid server=] to transmit a [PREP] notification on that resource or its container or both.

A [=Solid server=] implementing the [SUPER] on an LDP Resource SHOULD send a [PREP] notification to a [=Solid client=] upon the following triggers:
A [=Solid server=] implementing the [SUPER] on an LDP Resource SHOULD send a [PREP] notification to a [=Solid client=] listening in on the said resource and/or its container, when a request with one of the following [[RFC9110#section-9|HTTP methods]] generates a response with any of the following [[RFC9110#section-15|HTTP status codes]]:

## Resources and their Containers ## {#triggers-resource-and-their-containers}

When a request sent to the resource or a contained resource within it, with one of the following [[RFC9110#section-9|HTTP methods]] generates a response with any of the following [[RFC9110#section-15|HTTP status codes]]:

<table class="numbered">
<caption> Notification Triggers (Resources and their Containers)
<table class="numbered auto">
<caption> Notification Triggers
<tr>
<th> Request Method
<th> Response Status
<th rowspan=2> Request Method
<th rowspan=2> Response Status
<th colspan=2 class="center"> Notify
<tr>
<td>
<th class="center"> Resource
<th class="center"> Container
<tr>
<td rowspan=2>
<code> [[RFC9110#section-9.3.4|PUT]] <br>
<code> [[RFC5789#section-2|PATCH]] <br>
<code> [[RFC9110#section-9.3.5|DELETE]]
<td>
<code> [[RFC9110#section-15.3.1|200 (OK)]] <br>
<code> [[RFC9110#section-15.3.5|204 (No Content)]] <br>
</table>

## Resources only ## {#triggers-resources-only}

When a request sent to the resource with one of the following [[RFC9110#section-9|HTTP methods]] generates a response with any of the following [[RFC9110#section-15|HTTP status codes]]:

<table class="numbered">
<caption> Notification Triggers (Resource only)
<tr>
<th> Request Method
<th> Response Status
<code> [[RFC9110#section-15.3.6|205 (Reset Content)]]
<td class="tick">
&check;
<td class="tick">
&check;
<tr>
<td>
<code> [[RFC9110#section-9.3.3|POST]] <br>
<code> [[RFC9110#section-15.3.2|201 (Created)]] <br>
<td>
<td class="tick">
&check;
<tr>
<td rowspan=2>
<code> [[RFC9110#section-9.3.3|POST]]
<td>
<code> [[RFC9110#section-15.3.1|200 (OK)]] <br>
<code> [[RFC9110#section-15.3.5|204 (No Content)]] <br>
<code> [[RFC9110#section-15.3.2|201 (Created)]] <br>
<code> [[RFC9110#section-15.3.6|205 (Reset Content)]]
<td class="tick">
&check;
<td class="tick">
&check;
<tr>
<td>
<code> [[RFC9110#section-15.3.2|201 (Created)]]
<td class="tick">
&check;
<tr>
<td>
<code> [[RFC9110#section-9.3.5|DELETE]]
<td>
<code> [[RFC9110#section-15.3.1|200 (OK)]] <br>
<code> [[RFC9110#section-15.3.5|204 (No Content)]] <br>
<td class="tick">
&check;
<td class="tick">
&check;
</table>

## Don't Jump the Gun ## {#trigger-timing}
Expand Down