Skip to content

Add deprecation notice for the Get Events V1 endpoint #2644

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

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

Add deprecation notice for the Get Events V1 endpoint #2644

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fb9abf9
add events api deprecation
nick-roscarel-octo Mar 10, 2025
547ffcf
modDate bump
nick-roscarel-octo Mar 11, 2025
0592a9c
move to dedicated section
nick-roscarel-octo Mar 11, 2025
dde4c3c
spellcheck
nick-roscarel-octo Mar 11, 2025
8ea4928
use the correct LTS version
nick-roscarel-octo Mar 11, 2025
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
9 changes: 8 additions & 1 deletion src/pages/docs/deprecations/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2024-05-10
modDate: 2025-03-11
title: Deprecations
description: Upcoming and past deprecations by version for Octopus Server
navOrder: 300
Expand Down Expand Up @@ -32,6 +32,13 @@ To provide ample time to act, from Octopus Server `2024.1`, workloads that run o

Further notes about this pending change can be found in the [2024.1 deprecation blog post](https://octopus.com/blog/2024-deprecated-features#windows-server-2008)

## Deprecations for 2025.2

### 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.
Copy link
Author

Choose a reason for hiding this comment

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

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 :)


## Deprecations for 2024.3

### Azure Resource Manager Powershell Module
Expand Down