Skip to content

docs(events): note that GET /events silently ignores the order parameter #1611

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tsushanth wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −0
Open

docs(events): note that GET /events silently ignores the order parameter #1611

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions src/events/interfaces/list-events-options.interface.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,16 @@ export interface ListEventOptions {
limit?: number;
after?: string;
organizationId?: string;
/**
* As of 2026-06-11 the `GET /events` endpoint silently ignores this
* parameter and always returns events oldest-first regardless of whether
* `asc`, `desc`, `normal`, or nothing is sent — see
Comment on lines +12 to +13

@greptile-apps greptile-apps Bot Jun 11, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 The comment mentions normal as a value that was tested, but the type union only allows 'asc' | 'desc'. Mentioning normal may confuse readers into thinking it is a valid SDK value. Dropping it keeps the comment consistent with the public API surface.

Suggested change
* parameter and always returns events oldest-first regardless of whether
* `asc`, `desc`, `normal`, or nothing is sent — see
* parameter and always returns events oldest-first regardless of whether
* `asc`, `desc`, or nothing is sent — see

* {@link https://github.com/workos/workos-node/issues/1610}. The SDK
* continues to serialize the value on the wire so callers automatically
* pick up the server-side fix when it lands; until then, treat the
* response as ascending-by-`created_at` and seed cursor pagination from
* the oldest end of the stream.
*/
order?: 'asc' | 'desc';
}

Expand Down