Skip to content

Commit

Permalink
Moji: Update translations
Browse files Browse the repository at this point in the history
  • Loading branch information
boxmoji committed Jul 31, 2024
1 parent 3f69522 commit f9f30f3
Show file tree
Hide file tree
Showing 35 changed files with 821 additions and 267 deletions.
14 changes: 7 additions & 7 deletions guides/api-calls/api-versioning-strategy.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,12 @@ Box APIは、URLの`path`と`header`でバージョン管理をサポートし

1. バージョンヘッダーを指定せずに[アップロード](`https://upload.box.com/api/2.0/files/content`)エンドポイントを呼び出すと、URLで定義されている`2.0`バージョンが使用されます。

2. Box APIでは、以下に該当する`Box-Version`ヘッダーを処理します。
2. Box APIでは、以下に該当する`box-version`ヘッダーを処理します。

* `Box-Version: 2025.0`のような有効なバージョン名を含む
* `box-version: 2025.0`のような有効なバージョン名を含む
* `https://api.box.com/2.0/files/:file_id/metadata`に送信される

3. 指定したバージョンが正しい場合は、クライアントにレスポンスが返されます。リクエストで`Box-Version`ヘッダーを指定した場合、レスポンスにはこのヘッダーも含まれます。デフォルトでは、このヘッダーはレスポンスに存在しません。バージョンが正しくない場合は、HTTPコード`400`のエラーがクライアントに返されます。
3. 指定したバージョンが正しい場合は、クライアントにレスポンスが返されます。リクエストで`box-version`ヘッダーを指定した場合、レスポンスにはこのヘッダーも含まれます。デフォルトでは、このヘッダーはレスポンスに存在しません。バージョンが正しくない場合は、HTTPコード`400`のエラーがクライアントに返されます。

APIの動作に大きな変更があると、新しいエンドポイントは新しいURLで公開されます。たとえば、`https://upload.box.com/api/2.0/files/content`では、Boxにファイルをアップロードする際にマルチパートのコンテンツタイプをサポートしています。このAPIの新しいバージョンでこのコンテンツタイプがサポートされなくなると、新しいバージョンは新しいURL`https://upload.box.com/api/3.0/files/content`でリリースされます。

Expand Down Expand Up @@ -78,16 +78,16 @@ Boxは、1年に1回、APIエンドポイントに新しく重大な変更を行

## APIバージョンの呼び出し

Box APIのバージョンは、アプリでリクエストする`Box-Version`ヘッダーで明示的に宣言します。次に例を示します。
Box APIのバージョンは、アプリでリクエストする`box-version`ヘッダーで明示的に宣言します。次に例を示します。

```curl
curl --location 'https://api.box.com/2.0/sign_requests' \
--header 'Box-Version: 2025.0' \
--header 'box-version: 2025.0' \
--header 'Authorization: Bearer …
```

クライアントは、作成されたすべての署名リクエストのリストを取得し、バージョン`2025.0`を要求します。使用可能なAPIにはサポートされているバージョンがいくつかあるため、使用するバージョンを`Box-Version`ヘッダーで指定します。APIのバージョンには、**安定****非推奨****不安定**の3種類があります。
クライアントは、作成されたすべての署名リクエストのリストを取得し、バージョン`2025.0`を要求します。使用可能なAPIにはサポートされているバージョンがいくつかあるため、使用するバージョンを`box-version`ヘッダーで指定します。APIのバージョンには、**安定****非推奨****不安定**の3種類があります。

## バージョン管理のエラー

Expand Down Expand Up @@ -234,7 +234,7 @@ APIに含まれるリソースまたはリソースのプロパティが非推
* 非推奨の動作を伴う呼び出しにより、レスポンスヘッダー`Box-API-Deprecated-Reason`と、詳細を確認するためのリンクが返されます。

```sh
Box-Version: 2023.0
box-version: 2023.0
Deprecation: version="version", date="date"
Box-API-Deprecated-Reason: https://developer.box.com/reference/deprecated

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ subcategory_id: api-calls/permissions-and-errors
is_index: false
id: api-calls/permissions-and-errors/app-diagnostics-report
type: guide
total_steps: 5
total_steps: 6
sibling_id: api-calls/permissions-and-errors
parent_id: api-calls/permissions-and-errors
next_page_id: ''
next_page_id: api-calls/permissions-and-errors/versioning-errors
previous_page_id: api-calls/permissions-and-errors/expiration
source_url: >-
https://github.com/box/developer.box.com/blob/main/content/guides/api-calls/permissions-and-errors/app-diagnostics-report.md
Expand Down
2 changes: 1 addition & 1 deletion guides/api-calls/permissions-and-errors/common-errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ subcategory_id: api-calls/permissions-and-errors
is_index: false
id: api-calls/permissions-and-errors/common-errors
type: guide
total_steps: 5
total_steps: 6
sibling_id: api-calls/permissions-and-errors
parent_id: api-calls/permissions-and-errors
next_page_id: api-calls/permissions-and-errors
Expand Down
2 changes: 1 addition & 1 deletion guides/api-calls/permissions-and-errors/expiration.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ subcategory_id: api-calls/permissions-and-errors
is_index: false
id: api-calls/permissions-and-errors/expiration
type: guide
total_steps: 5
total_steps: 6
sibling_id: api-calls/permissions-and-errors
parent_id: api-calls/permissions-and-errors
next_page_id: api-calls/permissions-and-errors/app-diagnostics-report
Expand Down
2 changes: 1 addition & 1 deletion guides/api-calls/permissions-and-errors/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ subcategory_id: api-calls/permissions-and-errors
is_index: true
id: api-calls/permissions-and-errors
type: guide
total_steps: 5
total_steps: 6
sibling_id: api-calls
parent_id: api-calls
next_page_id: api-calls/permissions-and-errors/scopes
Expand Down
2 changes: 1 addition & 1 deletion guides/api-calls/permissions-and-errors/rate-limits.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ subcategory_id: api-calls/permissions-and-errors
is_index: false
id: api-calls/permissions-and-errors/rate-limits
type: guide
total_steps: 5
total_steps: 6
sibling_id: api-calls/permissions-and-errors
parent_id: api-calls/permissions-and-errors
next_page_id: api-calls/permissions-and-errors/scopes
Expand Down
2 changes: 1 addition & 1 deletion guides/api-calls/permissions-and-errors/scopes.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ subcategory_id: api-calls/permissions-and-errors
is_index: false
id: api-calls/permissions-and-errors/scopes
type: guide
total_steps: 5
total_steps: 6
sibling_id: api-calls/permissions-and-errors
parent_id: api-calls/permissions-and-errors
next_page_id: api-calls/permissions-and-errors/expiration
Expand Down
78 changes: 78 additions & 0 deletions guides/api-calls/permissions-and-errors/versioning-errors.md
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.
Loading

0 comments on commit f9f30f3

Please sign in to comment.