From da0cf9477457eccd0aa7231a2e923602100be58e Mon Sep 17 00:00:00 2001 From: Wojciech Socha Date: Mon, 16 Dec 2024 11:18:05 +0100 Subject: [PATCH] fix: move paragraph about base version --- .../guides/api-calls/api-versioning-strategy.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/content/guides/api-calls/api-versioning-strategy.md b/content/guides/api-calls/api-versioning-strategy.md index c1e96f29a..0975dd9a2 100644 --- a/content/guides/api-calls/api-versioning-strategy.md +++ b/content/guides/api-calls/api-versioning-strategy.md @@ -44,7 +44,7 @@ to get a list of all sign requests using version `2025.0`, the request should lo ```curl curl --location 'https://api.box.com/2.0/sign_requests' \ - --header 'box-version: 2024.0' \ + --header 'box-version: 2025.0' \ --header 'Authorization: Bearer … ``` @@ -54,6 +54,12 @@ which indicates the version used to handle the request. Endpoints introduced after 2024 may return a `400` error code if the version is incorrect. More information about versioning errors can be found [here](g://api-calls/permissions-and-errors/versioning-errors). +If your request doesn't include a version, the API defaults to the initial Box API version - `2024.0` - the version of endpoints available before +year-based versioning was introduced. However, relying on this behavior is not recommended when adopting deprecated +changes. To ensure consistency, always specify the API version, with each request. By making your application +version-aware, you anchor it to a specific set of features, ensuring consistent behavior throughout the supported +timeframe. + ## Release schedule and naming convention Box can introduce a new breaking change to certain endpoints **once per year**, which results in a new API version. @@ -84,12 +90,6 @@ It also means, that a new version cannot be released sooner than every 12 months We strongly recommend updating your apps to make requests to the latest stable API version. However, if your app uses a stable version that is no longer supported, then you will get a response with an HTTP error code `400 - Bad Request`. For details, see [Versioning Errors](g://api-calls/permissions-and-errors/versioning-errors). -If your request doesn't include a version, the API defaults to the initial Box API version—the version available before -year-based versioning was introduced. However, relying on this behavior is not recommended when adopting deprecated -changes. To ensure consistency, always specify the API version, with each request. By making your application -version-aware, you anchor it to a specific set of features, ensuring consistent behavior throughout the supported -timeframe. - ### Endpoint versioning indication To keep you informed about the current API state, and improve the readability of the versioned API reference, the affected endpoints are marked with a pill based on the `x-stability-level` tag or `deprecated` attribute.