Skip to content

Conversation

@leggetter
Copy link
Collaborator

No description provided.

Copilot AI review requested due to automatic review settings June 4, 2025 12:23
@vercel
Copy link

vercel bot commented Jun 4, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
outpost-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 4, 2025 0:24am
outpost-website ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 4, 2025 0:24am

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the example JSON schema in the alerts documentation to reflect the new alert payload structure.

  • Renamed the topic field and updated the example timestamp precision
  • Introduced an event object and replaced response with delivery_response
  • Adjusted failure metrics, the will_disable flag, and placeholder sections for destination
Comments suppressed due to low confidence (3)

docs/pages/features/alerts.mdx:34

  • The status field is now an integer (400) whereas the previous example used a string ("500"). Consider standardizing the type or calling out this change in the docs to avoid confusion.
"status": 400

docs/pages/features/alerts.mdx:33

  • [nitpick] Showing the response body as a raw JSON string can be hard to read. Consider presenting it as an inline object or noting explicitly that this is a stringified payload.
"body": "{\"success\":false,...}"

docs/pages/features/alerts.mdx:31

  • [nitpick] Using an empty object for destination doesn't illustrate its expected shape. It may help to provide a realistic example or reference the DestinationObject schema.
"destination": {}

@leggetter leggetter merged commit 6f8aada into main Jun 5, 2025
4 checks passed
@leggetter leggetter deleted the chore/alerts-payload-update branch June 5, 2025 19:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants