Skip to content
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.

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

[Schema Inaccuracy] Limit on the number of events is not explicit #4432

Closed
taylorcuilty opened this issue Jan 15, 2025 · 1 comment
Closed

Comments

@taylorcuilty
Copy link

Schema Inaccuracy

All of the list operations under Events return a maximum of 300 events. The limit is implied but not stated explicitly, and that has led to some customer confusion.

Only events created within the past 90 days will be included in timelines. Events older than 90 days will not be included (even if the total number of events in the timeline is less than 300).

Opening an issue here because I think we might want to document the limit in the About Github Events section.

Should the Stabilize team (we own these operations) also add a note under each operation? Or is documenting the limit at the top level enough 🤔

Related issue

https://github.com/github/docs-content/issues/15197

Expected

The 300 event limit is documented in the section that references it.

@taylorcuilty
Copy link
Author

taylorcuilty commented Jan 15, 2025

Wrong repo 😅 I opened https://github.com/github/docs-internal/pull/53949 to fix the issue

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

No branches or pull requests

1 participant