Skip to content

fix(events): Remove the unsupported order option from listEvents - #1747

Merged
qbalin merged 1 commit into
mainfrom
qbalin/events-remove-order-option
Nov 3, 2026
Merged

qbalin merged 1 commit into
mainfrom
qbalin/events-remove-order-option

Conversation

@qbalin

@qbalin qbalin commented Nov 2, 2026

Copy link
Copy Markdown
Contributor

Description

GET /events has never honored order: it returns events oldest first and pages with after only. workos/workos#78349 removes the parameter from the API reference and OpenAPI spec, and the SDK should stop offering it too.

This drops order from ListEventOptions and from the query the SDK sends. Nothing changes on the wire for callers who never set it, which the SDK never did by default. A caller who did set order gets a type error on upgrade; the value was ignored by the API, so removing it from the call is the whole fix.

Release note: I titled this fix(events) without !, treating it as a bugfix per the discussion. If you would rather cut it as a breaking change for the type removal, retitle with ! before merging.

Verified locally: typecheck, eslint src/events, prettier --check on the changed files, and jest src/events/events.spec.ts (36 passing after removing the test that asserted order was sent).

Documentation

Does this require changes to the WorkOS Docs? E.g. the API Reference or code snippets need updates.

[ ] Yes

The reference change ships in workos/workos#78349; nothing further is needed for this PR.

🤖 Generated with Claude Code

GET /events has never honored `order`; it returns events oldest first and
pages with `after` only. The API reference stops documenting it in
workos/workos#78349, so the SDK stops offering it too.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@qbalin
qbalin requested a review from gjtorikian November 2, 2026 21:47
@qbalin
qbalin requested review from a team as code owners November 2, 2026 21:47
@greptile-apps

greptile-apps Bot commented Nov 2, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerView in GreptileConfidence Score: 5/5

[Low impact] The PR appears safe to merge.

Summary

Removes the unsupported order option from listEvents.

  • The events list no longer accepts or sends an ignored ordering option.

Reviews (1) · Last reviewed commit: "fix(events): Remove the unsupported orde..." · Reviewed by Greptile

@qbalin
qbalin merged commit 0222f79 into main Nov 3, 2026
8 of 9 checks passed
@qbalin
qbalin deleted the qbalin/events-remove-order-option branch November 3, 2026 14:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants