Skip to content

Conversation

obazoud
Copy link
Contributor

@obazoud obazoud commented Sep 17, 2025

No description provided.

@Copilot Copilot AI review requested due to automatic review settings September 17, 2025 09:24
@vercel
Copy link

vercel bot commented Sep 17, 2025

@obazoud is attempting to deploy a commit to the Hookdeck Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

@Copilot 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 adds a missing status field to an OpenAPI specification schema. The change addresses issue #490 by including the required status enumeration that was previously omitted from the API documentation.

  • Adds a status field with string type and enum values of "success" and "failed"

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

leggetter added a commit that referenced this pull request Oct 13, 2025
Add missing 'status' field to Event schema in OpenAPI specification
and generate updated TypeScript SDK with proper type definitions.

Changes:
- Updated Event schema in OpenAPI spec to include 'status' field
  (enum: success | failed)
- Regenerated TypeScript SDK with new EventStatus type
- Added comprehensive test suite for event status field validation
- Updated all destination tests to use proper SDK types
- Added SDK regeneration script for consistent build process

The API was already returning the status field in event responses,
but it was not documented in the OpenAPI spec, causing SDK clients
to not have access to this field. This change aligns the spec with
the actual API behavior.

Tests verify:
- Status field is present in events from listByDestination
- Status field is present in single event retrieval
- Status field is present in tenant-wide event lists
- Status values are valid (success or failed)

Fixes #490
Related to PR #491
@leggetter
Copy link
Collaborator

Fix included in #518 along with a way to help us test SDKs against a running version of Outpost and identify any discrepancies.

@leggetter leggetter closed this Oct 13, 2025
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