Add deprecation notice for the Get Events V1 endpoint#2644
Draft
nick-roscarel-octo wants to merge 5 commits intomainfrom
Draft
Add deprecation notice for the Get Events V1 endpoint#2644nick-roscarel-octo wants to merge 5 commits intomainfrom
nick-roscarel-octo wants to merge 5 commits intomainfrom
Conversation
nick-roscarel-octo
force-pushed
the
bft/nick/getevents-v1-deprecation
branch
from
f230c66 to
dde4c3c
Compare
nick-roscarel-octo
changed the title
| ### System and Space Level `/events` API Endpoint | ||
| The `GET /events` and `GET /{spaceId}/events` API endpoints will be replaced by new versions that don't return pagination properties. Events are created constantly, minimizing the value of providing individual page numbers, and calculating the total number of results can be very expensive on instances with larger data sets. | ||
|
|
||
| For similar functionality without pagination, use the `GET /events/v2` and `GET /{spaceId}/events/v2` endpoints. To export events in CSV format, use the `GET /events/export` or `GET /events/{spaceId}/export` endpoints. |
Author
There was a problem hiding this comment.
I'm running off the assumption that this notice should still be written in present imperative tense, even though the requisite PR isn't merged on the Server side.
If we want to use future tense initially, and then switch to present tense once it's released in cloud, I'm more than happy to raise a separate PR for it :)
steve-fenton-octopus
approved these changes
Mar 14, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a deprecation notice for the
/api/eventsand/api/{spaceId}/eventsendpoints.[sc-104549]