Skip to content

SDK and OpenAPI mismatch with raw HTTP response fields #490

@obazoud

Description

@obazoud

Describe the bug
There is a discrepancy between the attributes returned in the SDK (and OpenAPI spec) versus the raw HTTP response from the events endpoints (tenant and destination):

When requesting:
GET https://myoutpost.com/api/v1/<tenant id>/destinations/<destination id>/events

The response body is like:

{
  count: x,
  data: [
    {
      id: '<event id>',
      tenant_id: '<tenant id>',
      destination_id: '<destination id>',
      topic: '<my topic>',
      eligible_for_retry: true,
      time: '2025-09-16T15:27:57.720776Z',
      metadata: {},
      data: {...},
      status: 'success'
    },
    ...
  ],
  next: '',
  prev: ''
}

But in openapi.yaml, the array should consist of Event components (#/components/schemas/Event), which are defined to include:

  • id
  • destination_id
  • topic
  • time
  • successful_at
  • metadata
  • data

However, the raw HTTP response includes fields not present in the SDK/OpenAPI, and vice versa:

  • Missing fields in the SDK/OpenAPI: tenant_id, status, eligible_for_retry
  • Missing fields in HTTP: successful_at

The portal uses raw HTTP, which is why it works, but SDKs and OpenAPI-based integrations miss some fields.

To Reproduce

  1. Make the above GET request to /events endpoints.
  2. Compare the response fields to the OpenAPI Event schema and SDK models.

Expected behavior
The SDK and OpenAPI schema should match the raw HTTP response.

Screenshots
N/A

Additional context
N/A

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    Status

    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions