Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
54 changes: 54 additions & 0 deletions src/partials/sites-events.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
{% table %}

- Name
- Description

---

- `sites.*`
- This event triggers on any sites event.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Tighten wording for grammar in generic event descriptions.

Two phrases read awkwardly: “any sites event” and “any deployments event”. Recommend singular noun forms.

✏️ Proposed wording fix
- This event triggers on any sites event.
+ This event triggers on any site event.
...
- This event triggers on any deployments event.
+ This event triggers on any deployment event.

Also applies to: 27-27

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@src/partials/sites-events.md` at line 9, Update the awkward plural phrasing
in the generic event descriptions by replacing "any sites event" with "any site
event" and "any deployments event" with "any deployment event" wherever they
appear (e.g., the strings "any sites event" and "any deployments event" in the
sites-events partial); ensure singular noun usage is applied consistently across
the file.

Returns [Site Object](/docs/references/cloud/models/site)

---

- `sites.*.create`
- This event triggers when a site is created.
Returns [Site Object](/docs/references/cloud/models/site)

---

- `sites.*.delete`
- This event triggers when a site is deleted.
Returns [Site Object](/docs/references/cloud/models/site)

---

- `sites.*.deployments.*`
- This event triggers on any deployments event.
Returns [Deployment Object](/docs/references/cloud/models/deployment)

---

- `sites.*.deployments.*.create`
- This event triggers when a deployment is created.
Returns [Deployment Object](/docs/references/cloud/models/deployment)

---

- `sites.*.deployments.*.delete`
- This event triggers when a deployment is deleted.
Returns [Deployment Object](/docs/references/cloud/models/deployment)

---

- `sites.*.deployments.*.update`
- This event triggers when a deployment is updated.
Returns [Deployment Object](/docs/references/cloud/models/deployment)

---

- `sites.*.update`
- This event triggers when a site is updated.
Returns [Site Object](/docs/references/cloud/models/site)

{% /table %}
5 changes: 4 additions & 1 deletion src/routes/docs/advanced/platform/events/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ You can subscribe to events for specific resources using their ID or subscribe t
You can also filter for events of specific actions like create, update, upsert, or delete.


You can find a list of events for Storage, Databases, Functions, and Authentication services below.
You can find a list of events for Storage, Databases, Functions, Sites, and Authentication services below.

{% accordion %}
{% accordion_item title="Authentication" %}
Expand All @@ -27,6 +27,9 @@ You can find a list of events for Storage, Databases, Functions, and Authenticat
{% accordion_item title="Functions" %}
{% partial file="functions-events.md" /%}
{% /accordion_item %}
{% accordion_item title="Sites" %}
{% partial file="sites-events.md" /%}
{% /accordion_item %}
{% accordion_item title="Messaging" %}
{% partial file="messaging-events.md" /%}
{% /accordion_item %}
Expand Down