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

Disable Project level /runbooks/all API endpoint #8669

Closed
ankithkonda opened this issue Mar 5, 2024 · 2 comments
Closed

Disable Project level /runbooks/all API endpoint #8669

ankithkonda opened this issue Mar 5, 2024 · 2 comments
Assignees

Comments

@ankithkonda
Copy link

Description

From time to time, Octopus will deprecate features that are no longer going to be supported, and will eventually be removed.

Deprecations have the following lifecycle:

  • Announce deprecation
  • (+6 months) Toggle off deprecated functionality
  • (+1 year) Remove deprecated functionality

Project level /runbooks/all API endpoint GET /projects/{projectId}/runbooks/all is due for soft removal as per our deprecation plan. This endpoint will no longer be available by default and will result in an error if used, there is a toggle to turn this back on if you require it.

In 12 months, we will completely remove this functionality.

If you have any questions please contact our support team. More information on our deprecation plan can be found in our deprecation documentation

Migration Guide

The GET /projects/{projectId}/runbooks/all API endpoint is being replaced by a new version that omits the ProjectIds query string parameter in future versions of Octopus. It was adopted from an earlier version of the product and is now redundant and potentially confusing. The same functionality is available via the GET /runbooks/all API endpoint, passing relevant Project IDs via the ProjectIds query parameter. If the ProjectIds parameter is not required, the GET /projects/{projectId}/runbooks/all/v2 endpoint should be used instead.

https://octopus.com/docs/deprecations#project-level-runbooks-all-api-endpoint

@octoreleasebot
Copy link

Release Note: Disabled Project level /runbooks/all API endpoint

@Octobob
Copy link
Member

Octobob commented May 16, 2024

🎉 The fix for this issue has been released in:

Release stream Release
2024.2 2024.2.1497
2024.3+ all releases

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

3 participants