Skip to content

Commit

Permalink
fix: move paragraph about base version
Browse files Browse the repository at this point in the history
  • Loading branch information
wsocha committed Dec 16, 2024
1 parent fbe7810 commit da0cf94
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions content/guides/api-calls/api-versioning-strategy.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 …
```

Expand All @@ -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.
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit da0cf94

Please sign in to comment.