chore(sdks,docs): v0.13 SDK generation prep, upgrade guide, spec fixes (#688, #689) by leggetter · Pull Request #690 · hookdeck/outpost

leggetter · 2026-02-11T14:25:26Z

Summary

Prep for v0.13 SDK generation and documentation updates. SDKs will be generated via GitHub Actions (Generate OUTPOST-TS, OUTPOST-GO, OUTPOST-PYTHON).

Changes

OpenAPI spec (#688, #689)

Event status field: expected behavior? (spec vs API) #689: Remove status from Event schema (delivery outcome is on Attempt only).
Bug: GET /events with destination_id returns 500 #688: Remove destination_id query param from GET /events (unimplemented; no longer advertised).
Default server: Production first in servers (https://api.outpost.hookdeck.com/2025-07-01), then localhost.

Docs

Upgrade to v0.13 guide: add to sidebar nav (with Upgrade to v0.12), add SDK Migration section (list response shape, events/attempts/schemas/topics before-after, checklist).

SDKs

Overlays (sdks/schemas/): include pagination-fixes-overlay.yaml and speakeasy-modifications-overlay.yaml for v0.13 generation (no generated SDK code in this PR).

Examples

Dashboard integration: events list uses v0.13 response shape (response.models, response.pagination).

Spec SDK tests

Use response.models / response.pagination; Event → Attempt test (publish event, assert attempt created with status: success).
Bug: GET /events with destination_id returns 500 #688/Event status field: expected behavior? (spec vs API) #689: Remove event status assertions and pollForEventsWithStatus; simplify to list events and get by ID; update test:failures grep.
Default server: Add sdk-defaults.test.ts asserting new Outpost instance defaults to https://api.outpost.hookdeck.com/2025-07-01.

Next steps

Run GitHub Actions: Generate OUTPOST-TS, Generate OUTPOST-GO, Generate OUTPOST-PYTHON (optionally set set_version to 0.13.0).
Merge generated SDK PRs after review.
Update upgrade guide: remove GET /events destination_id / 500 note and Bug: GET /events with destination_id returns 500 #688 link if not done in a follow-up.

Refs #688, #689

…tempt tests - Use response.models and response.pagination for list endpoints - Treat Event.status as optional per spec; poll for status after delivery - Add Event → Attempt test: publish event, assert attempt created with status success - Update run script, README, .env.example, mocharc, destination tests for SDK Co-authored-by: Cursor <cursoragent@cursor.com>

…xample - docs: add Upgrade to v0.12/v0.13 to sidebar, SDK migration section, issue #688 link - sdks/schemas: include pagination and speakeasy overlays for SDK generation - examples: dashboard-integration uses events list models/pagination (v0.13) Co-authored-by: Cursor <cursoragent@cursor.com>

vercel · 2026-02-11T14:25:30Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
outpost-docs	Ready	Preview, Comment	Feb 11, 2026 4:42pm
outpost-website	Ready	Preview, Comment	Feb 11, 2026 4:42pm

Copilot

Pull request overview

Prepares the repo for Outpost v0.13 SDK regeneration by updating Speakeasy overlays, aligning spec-SDK contract tests to the new { models, pagination } envelope, and adding documentation/examples to guide users through the breaking SDK/API changes.

Changes:

Updated Speakeasy overlays for v0.13 endpoint naming + pagination handling.
Updated/added spec-SDK tests (events/topics + destination topic selection) to match v0.13 response shapes and async delivery behavior.
Updated docs + demo dashboard example for the v0.13 list response envelope.

Reviewed changes

Copilot reviewed 20 out of 20 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
spec-sdk-tests/tests/topics.test.ts	New topics list/sanity tests.
spec-sdk-tests/tests/events.test.ts	Updates event status polling and adds Event→Attempt test; adapts to `models/pagination`.
spec-sdk-tests/tests/destinations/webhook.test.ts	Uses instance topics from `/topics` for “array of topics” test.
spec-sdk-tests/tests/destinations/rabbitmq.test.ts	Uses instance topics from `/topics` for “array of topics” test.
spec-sdk-tests/tests/destinations/gcp-pubsub.test.ts	Uses instance topics from `/topics` for “array of topics” test.
spec-sdk-tests/tests/destinations/azure-servicebus.test.ts	Uses instance topics from `/topics` for “array of topics” test.
spec-sdk-tests/tests/destinations/aws-sqs.test.ts	Uses instance topics from `/topics` for “array of topics” test.
spec-sdk-tests/tests/destinations/aws-s3.test.ts	Uses instance topics from `/topics` for “array of topics” test.
spec-sdk-tests/tests/destinations/aws-kinesis.test.ts	Uses instance topics from `/topics` for “array of topics” test.
spec-sdk-tests/test-setup.ts	Adds optional global per-test delay hook via `TEST_DELAY_MS`.
spec-sdk-tests/scripts/run-tests.sh	Adds optional skip for `/healthz` check and improves API base URL handling.
spec-sdk-tests/package.json	Adds `test:failures` script for targeted reruns.
spec-sdk-tests/README.md	Documents managed Outpost health-check skip + delay + curl debugging.
spec-sdk-tests/.mocharc.json	Requires the new `test-setup.ts` hook file.
spec-sdk-tests/.env.example	Updates examples and adds `SKIP_HEALTH_CHECK` + `TEST_DELAY_MS`.
sdks/schemas/speakeasy-modifications-overlay.yaml	Updates Speakeasy name overrides for v0.13 endpoint/method naming.
sdks/schemas/pagination-fixes-overlay.yaml	Updates pagination override targets/config for v0.13 SeekPagination + envelope.
examples/demos/dashboard-integration/src/lib/outpost.ts	Updates dashboard example to read `response.models` from events list.
docs/zudoku.config.ts	Adds “Upgrade to v0.12/v0.13” guides to docs nav.
docs/pages/guides/upgrade-v0.13.mdx	Adds v0.13 SDK migration guidance and before/after examples.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-11T14:33:43Z

@@ -151,50 +227,44 @@ describe('Events - Status Field Tests (PR #491)', () => {
      });
      console.log('Event published successfully');

-      // Poll for events with 5s intervals, max 30s wait
-      const events = await pollForEvents(
+      // Poll until at least one event has status (delivery attempt completed). Uses list without destinationId
+      // because GET /events?destination_id=... currently returns 500 (see GitHub issue).
+      const events = await pollForEventsWithStatus(
        async () => {
-          const response = await sdk.events.listByDestination({
+          const response = await sdk.events.list({
            tenantId: client.getTenantId(),
-            destinationId: destinationId,
          });
-          return response?.data || [];
+          return response?.models || [];


The status assertion can become a false-positive because it searches for any event with status in the tenant list. If the tenant already has historical events with status, this test can pass even if the event you just published never appears or never gets a status. Prefer capturing the eventId from publish.event() and polling sdk.events.get({ eventId }) until status is set, then assert on that specific event.

Copilot · 2026-02-11T14:33:44Z

+/** Topic names used only for spec-SDK tests; they must not exist before/after. */
+const TEST_ONLY_TOPIC_NAMES = [
+  'spec-sdk-test.placeholder',
+  'outpost.spec-test.topic',
+  'test.only.topic.management',
+];
+
+describe('Topics - List and sanity checks', () => {
+  it('should list topics and return an array of strings', async function () {
+    const client = createSdkClient();
+    const sdk = client.getSDK();
+
+    const topics = await sdk.topics.list();
+
+    expect(topics).to.be.an('array');
+    topics.forEach((t: string, i: number) => {
+      expect(t, `topic[${i}]`).to.be.a('string');
+      expect(t.length, `topic[${i}]`).to.be.greaterThan(0);
+    });
+  });
+
+  it('should not contain test-only placeholder topics (before/after sanity)', async function () {
+    const client = createSdkClient();
+    const sdk = client.getSDK();
+
+    const topics = await sdk.topics.list();
+    const set = new Set(topics);
+
+    for (const testTopic of TEST_ONLY_TOPIC_NAMES) {
+      expect(set.has(testTopic), `Topic "${testTopic}" should not exist in instance list`).to.be.false;
+    }


This test hard-codes topic names that “must not exist” on the target Outpost instance. Since topics are instance-configured, a real deployment could legitimately include one of these strings and the suite would fail for reasons unrelated to the API/SDK contract. Consider gating this check behind an env flag (or removing it) so default runs don’t assume a specific topic set.

- Remove Event status from Event schema (#689) - Remove destination_id param from GET /events (#688) - Set production server first in OpenAPI servers - Simplify events tests; add sdk-defaults test for default server URL Refs #688, #689 Co-authored-by: Cursor <cursoragent@cursor.com>

…nts pagination, topics.list) Co-authored-by: Cursor <cursoragent@cursor.com>

…ict topics check on env Co-authored-by: Cursor <cursoragent@cursor.com>

- Use repo-relative path in pagination-fixes-overlay.yaml extends (CI/contributors) - Remove obsolete curl-events.sh section; document run-tests.sh behavior Co-authored-by: Cursor <cursoragent@cursor.com>

…ek pagination only) Co-authored-by: Cursor <cursoragent@cursor.com>

leggetter and others added 2 commits February 11, 2026 14:05

Copilot AI review requested due to automatic review settings February 11, 2026 14:25

Copilot started reviewing on behalf of leggetter February 11, 2026 14:25 View session

This was referenced Feb 11, 2026

Bug: GET /events with destination_id returns 500 #688

Closed

Event status field: expected behavior? (spec vs API) #689

Closed

Copilot AI reviewed Feb 11, 2026

View reviewed changes

vercel Bot temporarily deployed to Preview – outpost-website February 11, 2026 15:07 Inactive

vercel Bot temporarily deployed to Preview – outpost-docs February 11, 2026 15:08 Inactive

leggetter changed the title ~~chore(sdks,docs): v0.13 SDK generation prep, upgrade guide, and spec tests~~ chore(sdks,docs): v0.13 SDK generation prep, upgrade guide, spec fixes (#688, #689) Feb 11, 2026

leggetter and others added 2 commits February 11, 2026 15:25

fix(dashboard-example): use SDK by file and align with v0.13 API (eve…

06105a6

…nts pagination, topics.list) Co-authored-by: Cursor <cursoragent@cursor.com>

test(spec-sdk): events test use publish id for listAttempts; gate str…

569d8ec

…ict topics check on env Co-authored-by: Cursor <cursoragent@cursor.com>

vercel Bot temporarily deployed to Preview – outpost-website February 11, 2026 15:26 Inactive

vercel Bot temporarily deployed to Preview – outpost-docs February 11, 2026 15:27 Inactive

fix(spec): overlay extends path and spec-sdk-tests README

57cf40e

- Use repo-relative path in pagination-fixes-overlay.yaml extends (CI/contributors) - Remove obsolete curl-events.sh section; document run-tests.sh behavior Co-authored-by: Cursor <cursoragent@cursor.com>

vercel Bot temporarily deployed to Preview – outpost-docs February 11, 2026 15:33 Inactive

vercel Bot temporarily deployed to Preview – outpost-website February 11, 2026 15:33 Inactive

fix(dashboard-example): remove totalEvents stat (API has no total; se…

1c68f3f

…ek pagination only) Co-authored-by: Cursor <cursoragent@cursor.com>

vercel Bot temporarily deployed to Preview – outpost-docs February 11, 2026 16:42 Inactive

vercel Bot temporarily deployed to Preview – outpost-website February 11, 2026 16:42 Inactive

leggetter merged commit c8a4e0c into main Feb 11, 2026
4 checks passed

leggetter deleted the feature/sdk-v0.13-generation branch February 11, 2026 16:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore(sdks,docs): v0.13 SDK generation prep, upgrade guide, spec fixes (#688, #689)#690

chore(sdks,docs): v0.13 SDK generation prep, upgrade guide, spec fixes (#688, #689)#690
leggetter merged 7 commits into
mainfrom
feature/sdk-v0.13-generation

leggetter commented Feb 11, 2026 •

edited

Loading

Uh oh!

vercel Bot commented Feb 11, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Feb 11, 2026

Uh oh!

Uh oh!

Uh oh!

Copilot AI Feb 11, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

leggetter commented Feb 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

OpenAPI spec (#688, #689)

Docs

SDKs

Examples

Spec SDK tests

Next steps

Uh oh!

vercel Bot commented Feb 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

leggetter commented Feb 11, 2026 •

edited

Loading

vercel Bot commented Feb 11, 2026 •

edited

Loading