Skip to content

Spec drift: probable — events list response is bare array but spec documents paginated envelope #539

@realfishsam

Description

@realfishsam

Summary

core/specs/probable.yaml documents the GET /events response as a paginated envelope object { events: Event[], pagination: {...} }. The live Probable API actually returns a bare array of events Event[] with no wrapping object. The spec is incorrect (note: the PMXT fetcher code handles this correctly by reading the raw array — the spec is wrong, not the code).

Impact

MEDIUM — the spec misrepresents the actual API response shape. Any code generated from or validated against the spec would expect an envelope that doesn't exist. The spec inaccuracy also makes the codebase harder to maintain.

Details

  • Endpoint: GET /events
  • Spec declares: { events: Event[], pagination: { cursor: string, total: integer } }
  • Live API returns: Event[] (bare array, no pagination wrapper)
  • Code status: the Probable fetcher correctly reads from the bare array (no bug in code)
  • Spec file: core/specs/probable.yaml, getEvents response schema

Required Fix

Update the getEvents response schema in core/specs/probable.yaml to reflect the actual bare array response: type: array, items: $ref Event. Remove the erroneous pagination envelope from the schema.

Metadata

Metadata

Assignees

No one assigned

    Labels

    spec-driftCached OpenAPI spec out of date vs venue's live docs

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions