Skip to content

Rename BFF deployments/timeline endpoint to deployments/recent #10139

Description

@lourens-octopus

Background

A new environment timeline endpoint has been created to show deployments to an environment. The old endpoint however is still being used by some backend systems to find recent deployments. The endpoint has thus been renamed to deployments/recent to reflect this change.

Why a breaking change is being considered

The endpoint is a bff endpoint, and accordingly is not versioned and can change at any time. This means that this is not actually a breaking change but notice will still be given to anyone that is using this endpoint.

What is breaking

Any call to the endpoint bff/spaces/{spaceId}/projects/{projectId}/environments/{environmentId}/deployments/timeline/ will now no longer work. The calls should be updated to bff/spaces/{spaceId}/projects/{projectId}/environments/{environmentId}/deployments/recent/

Options not to break

The BFF endpoint is not a a public API and is not versioned. Any changes to it can happen without notice and at any time. We are giving this breaking change notice to any customers who may be relying on this non public endpoint. We suggest that instead of using BFF endpoints, you should consider using the public Resource API Endpoints documented in Swagger at https://<yourinstance>/swaggerui

Metadata

Metadata

Labels

tag/breaking-changeThe resolution of this issue introduced a deliberately breaking change

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions