-
Notifications
You must be signed in to change notification settings - Fork 86
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
35 changed files
with
821 additions
and
267 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
78 changes: 78 additions & 0 deletions
78
guides/api-calls/permissions-and-errors/versioning-errors.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
--- | ||
rank: 100 | ||
related_endpoints: [] | ||
related_guides: [] | ||
required_guides: [] | ||
category_id: api-calls | ||
subcategory_id: api-calls/permissions-and-errors | ||
is_index: false | ||
id: api-calls/permissions-and-errors/versioning-errors | ||
type: guide | ||
total_steps: 6 | ||
sibling_id: api-calls/permissions-and-errors | ||
parent_id: api-calls/permissions-and-errors | ||
next_page_id: '' | ||
previous_page_id: api-calls/permissions-and-errors/app-diagnostics-report | ||
source_url: >- | ||
https://github.com/box/developer.box.com/blob/main/content/guides/api-calls/permissions-and-errors/versioning-errors.md | ||
fullyTranslated: true | ||
--- | ||
# バージョン管理のエラー | ||
|
||
Boxでは、特定のAPIエンドポイントに対してバージョン管理機能を提供しています。このバージョン管理システムにより、Boxがエンドポイントのバージョンを新しく導入した場合でも、既存のエンドポイントのバージョンに対してシームレスな機能が保証されます。 | ||
|
||
APIのバージョン管理により、Boxは、自社のプラットフォームを継続的に強化できると同時に、機能の更新や廃止のための信頼できる手段をサードパーティの開発者に提供することもできます。 | ||
|
||
To stay informed about the API modifications, monitor the [Changelog](https://developer.box.com/changelog/) and maintain a current email address in the **App Info** section of the Developer Console. | ||
|
||
## Error examples | ||
|
||
When using versioned API calls, you can encounter versioning-related errors. This reference lists the most common cases when errors appear and provides you with examples of such errors. | ||
|
||
## Calling with incorrect `box-version` header | ||
|
||
If you call an API using an incorrect `box-version` header, the API will respond with an `HTTP error code 400 - Bad Request` error and provide the supported versions in the response message. | ||
|
||
The response will include one of the following status messages in `message` field: | ||
|
||
| 詳細 | メッセージ | | ||
| ------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | ||
| `box-version` value is an unsupported API version or was sent malformed. | `Invalid API version specified in 'box-version' header.` | | ||
| The request headers did not include `box-version` header when versioned only endpoint was called. | `Missing required box-version header.` | | ||
| `box-version` is empty. | `Invalid (empty) API version specified in 'box-version' header.` | | ||
| `box-version` contained multiple version. It requires **only one** version per request. | `The 'box-version' header supports only one header value per request, do not use comas.` | | ||
| An unsupported API version is used for an existing endpoint. | `Unsupported API version specified in 'box-version' header.` | | ||
|
||
An example of a response with an incorrect `box-version` header: | ||
|
||
```json | ||
{ | ||
"type": "error", | ||
"status": 400, | ||
"code": "invalid_api_version", | ||
"help_url": "https://developer.box.com/reference/error-codes/invalid-api-version", | ||
"message": "Invalid API version specified in 'box-version' header. Supported API versions: [2024.0].", | ||
"request_id": "abcdef123456" | ||
} | ||
|
||
``` | ||
|
||
## URLでの正しくないAPIバージョンの呼び出し | ||
|
||
Box documentation specifies API URLs. For instance, the Sign Requests endpoints are accessed via: `https://api.box.com/2.0/sign_requests/`. If you mistakenly make a call to an incorrect version, such as `https://api.box.com/3.0/sign_requests/`, the response returns an `HTTP error code 404 - Not Found` error. | ||
|
||
## 非推奨のAPIの呼び出し | ||
|
||
When you use an API version that Box has marked as deprecated, the API will respond as usual. Additionally, it will append a `Deprecation` header, stating the deprecation date. For example: | ||
|
||
```sh | ||
Deprecation: date="Fri, 11 Nov 2023 23:59:59 GMT" | ||
Box-API-Deprecated-Reason: https://developer.box.com/reference/deprecated | ||
|
||
``` | ||
|
||
You should monitor API responses to verify if the `Deprecation` header is present to accordingly plan the transition to a new API version. | ||
|
||
## Calling a non-existent version | ||
|
||
If you attempt to use an outdated API version, such as `2023.0` which has reached its end-of-life, the response will return an `HTTP error code 404 - Not Found`. See [Calling an incorrect API version in the URL](#calling-an-incorrect-api-version-in-the-url) for more information. |
Oops, something went wrong.