Skip to content

fix: align component example outputs with provider APIs#4916

Open
Vukotije wants to merge 45 commits into
superplanehq:mainfrom
Vukotije:fix/update-example-payloads
Open

fix: align component example outputs with provider APIs#4916
Vukotije wants to merge 45 commits into
superplanehq:mainfrom
Vukotije:fix/update-example-payloads

Conversation

@Vukotije
Copy link
Copy Markdown
Collaborator

Fixes #3797

Summary

Example outputs shown in the workflow builder did not match what components actually emit, so users built expressions against the wrong shape. This PR updates integration and core component example JSON to match official provider/API documentation and the Emit() payloads in Go, then regenerates docs/components/*.mdx so docs stay in sync.

Changes are split one commit per integration (plus HTTP/Merge components and a final MDX regen commit) for easier review.

What changed

  • ~95 example payload files under pkg/integrations/** and core components (http, merge)
  • Regenerated docs/components/*.mdx via make gen.components.docs
  • Corrected cases where examples were:
    • Over-trimmed (dropped valid API fields, including null values Statuspage and others return)
    • Empty or minimal data: {} while emit passes the full response body
    • Wrong field names or structure vs webhook/API docs (e.g. Merge sourceNodes vs sources, HTTP success payload including a spurious error field)
  • Preserved existing placeholder conventions (timestamps, org/repo names) where the shape was already correct

Integrations touched

AWS, Bitbucket, CircleCI, Cloudflare, Dash0, Datadog, DigitalOcean, Discord, Docker Hub, Elastic, FireHydrant, GCP, GitHub, GitLab, Grafana, Hetzner, Honeycomb, LaunchDarkly, Logfire, New Relic, OpenAI, PagerDuty, Perplexity, Rootly, Semaphore, SendGrid, Slack, Microsoft Teams — plus HTTP and Merge core components.

Validation

  • make check.example.payloads — envelope type matches each component’s Emit()
  • make gen.components.docs — MDX regenerated from updated examples

Notes for reviewers

  • Prefer reviewing per-integration commits rather than the full diff at once.
  • Some integrations have two fix: commits (initial pass + restore of full API shapes); safe to squash per integration before merge if desired.
  • make check.example.payloads checks type/envelope, not full provider fidelity — future work could add stricter guards against key loss vs baseline.

Vukotije added 30 commits May 19, 2026 22:43
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Vukotije and others added 10 commits May 20, 2026 15:17
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
Regenerate docs/components from integration example payloads after
example JSON fixes.

Co-authored-by: Cursor <cursoragent@cursor.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
@superplanehq-integration
Copy link
Copy Markdown

👋 Commands for maintainers:

  • /sp start - Start an ephemeral machine (takes ~30s)
  • /sp stop - Stop a running machine (auto-executed on pr close)

@Vukotije Vukotije requested a review from forestileao May 20, 2026 13:41
Comment thread pkg/components/merge/example_output.json
Comment thread pkg/components/http/example_output.json Outdated
Comment thread pkg/integrations/digitalocean/example_output_create_app.json
- Merge: use sourceNodes with nodeId/receivedAt (matches Emit)
- HTTP: remove spurious error field from success example
- DigitalOcean app: restore blr1 data centers for Bangalore region

Regenerate Core and DigitalOcean component docs MDX.

Co-authored-by: Cursor <cursoragent@cursor.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
@Vukotije Vukotije force-pushed the fix/update-example-payloads branch from 5115003 to 435d91a Compare May 20, 2026 13:49
Copy link
Copy Markdown
Contributor

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 2 potential issues.

There are 3 total unresolved issues (including 1 from previous review).

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 6197fc4. Configure here.

Comment thread pkg/integrations/aws/codepipeline/example_data_on_pipeline.json Outdated
Vukotije and others added 3 commits May 20, 2026 19:06
- Use JSON integers for pipeline-execution-attempt and version (not 1.0)
- Align status_update.incident with top-level incident (acme host, same summary)

Co-authored-by: Cursor <cursoragent@cursor.com>
Signed-off-by: Vukotije <vukanradojevicc@gmail.com>
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.

Example outputs: inaccurate across components

1 participant