Skip to content

Commit 6b16a29

Browse files
committed
Update descriptions
1 parent 058df6c commit 6b16a29

File tree

3 files changed

+10
-8
lines changed

3 files changed

+10
-8
lines changed

content/guides/api-calls/api-versioning-strategy.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -67,23 +67,25 @@ Box can issue a new breaking change to API endpoints **once** per year, reservin
6767
Each stable version is supported for a minimum of 12 months. This means that when a new version is released, the previous version becomes deprecated and will be available for use, but no new features will be added.
6868
It also means, that a new version cannot be released sooner than every 12 months.
6969

70-
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](#versioning-errors).
70+
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).
7171

7272
If your request doesn't include a version, the API defaults to the initial Box API version—the version available before
7373
year-based versioning was introduced. However, relying on this behavior is not recommended when adopting deprecated
7474
changes. To ensure consistency, always specify the API version, with each request. By making your application
7575
version-aware, you anchor it to a specific set of features, ensuring consistent behavior throughout the supported
7676
timeframe.
7777

78-
### Endpoint marking
78+
### Endpoint versioning indication
7979

80-
To keep you informed about the current API state, and improve the readability of the versioned API reference, the affected endpoints are marked with the following terms:
80+
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.
8181

82-
* **Beta**: Endpoints marked with **beta**, are offered subject to Box’s Main Beta Agreement, meaning the available capabilities may change at any time. Although beta endpoints not the same as versioned endpoints, they are a part of API lifecycle.
82+
![An example of a beta pill used for API reference endpoints](./images/api-versioning-pills.png)
8383

84-
* **Latest version**: The latest version applies to APIs that are already versioned. **Latest version** marks the most recent API version of an endpoint.
85-
86-
* **Deprecated**: If a version is deprecated, it is still available for use, but no new features are added. Such a version is marked with **Deprecated**.
84+
| Schema element | Pill name | Description|
85+
|---------------------|-----------|------------|
86+
| `x-stability-level: beta` | Beta | Endpoints marked with **beta**, are offered subject to Box’s Main Beta Agreement, meaning the available capabilities may change at any time. Although beta endpoints not the same as versioned endpoints, they are a part of API lifecycle. |
87+
|`x-stability-level: stable` or no `x-stability-level` tag | Latest version | The latest version applies to APIs that are already versioned. **Latest version** marks the most recent stable API version of an endpoint.|
88+
| `deprecated: true` | Deprecated | An endpoint is deprecated, which means it is still available for use, but no new features are added. Such an endpoint is annotated with the `deprecated` attribute set to `true`.|
8789

8890
## Calling an API version
8991

34.6 KB
Loading

content/microcopy/headers.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ secondary:
235235
// display: |-
236236
A boolean that determines whether to show the orange notification bar
237237
in the header. Must be "true" or "false"
238-
display: "true"
238+
display: "false"
239239

240240
// message: |-
241241
The content of the notification

0 commit comments

Comments
 (0)