[JA] translate API v2 Updates

This commit is contained in:
tequ
2024-12-03 15:21:55 +09:00
parent bb0c6dcd01
commit 13c2603586
14 changed files with 1545 additions and 888 deletions

View File

@@ -99,42 +99,4 @@ APIのメソッド名は、通常の(ダッシュで始まる)コマンドライ
{% admonition type="warning" name="注意" %}コマンドラインインターフェイスは管理目的でのみ使用することを意図しており、_サポートされているAPIではありません_です。新しいバージョンの`rippled`では、警告なしにコマンドラインAPIに破壊的な変更が導入される可能性があります{% /admonition %}
## APIのバージョン管理
`rippled`サーバは、使用するAPIバージョンを識別するために単一の整数を使用します。現在、`1``2`{% badge href="https://github.com/XRPLF/rippled/releases/tag/2.0.0" %}新規: rippled 2.0.0{% /badge %}の2つのAPIバージョンがあります。サーバは`version`APIメソッドでサポートされるAPIバージョンの範囲を報告します。<!-- TODO: add a link when `version` method is documented. -->
それぞれのAPIバージョンは、破壊的な変更が導入されるときに新しいAPIバージョン番号を導入します。プレリリースやベータ、開発バージョンでは、同じAPIバージョン番号で破壊的な変更を導入することがあり、`account_tx`リクエストを使用してAPIバージョン2を使用し、同じ接続でAPIバージョン1を使用して別の`account_tx`リクエストを行うことができます。
将来の`rippled`のバージョンで破壊的な変更が導入されると、新しいAPIバージョン3が導入されます。
### 破壊的変更
次の種類の変更は**破壊的変更**です。
- リクエストやレスポンスのフィールドの削除や名前の変更
- リクエストやレスポンスのフィールドの型の変更
- リクエストやレスポンスのフィールドの意味の変更
- リクエストやレスポンスのフィールドの位置の変更、または他のリクエストやレスポンスのフィールドの前への新しいフィールドの追加
- APIメソッドの削除や名前の変更
- 既存のクライアントから確認できるAPI関数の動作の変更
- 次の種類の変更は、gRPC APIにのみ適用されます。
- `proto`フィールド番号の変更
- 列挙型または列挙型値の削除または名前の変更
- `oneof`からのフィールドの追加または削除
- `oneof`の分割または統合
- メッセージフィールドが`optional``repeated`、または`required`であるかの変更
- リクエストまたはレスポンスのストリーム値の変更
- パッケージまたはサービスの削除または名前の変更
フルリリースで破壊的変更が加えられると、新しいAPIバージョン番号が導入されます。プレリリース版、ベータ版、開発版では、同じAPIバージョン番号に変更を加えることがあります。
### 非破壊的変更
次の種類の変更は**非破壊的変更**であり、APIバージョン番号の変更なしに発生する可能性があります。
- パラメータの位置の変更を含まない、新しいフィールドの追加
- 新しいAPIメソッドの追加
{% raw-partial file="/docs/_snippets/common-links.md" /%}