GS2-Version マスターデータリファレンス
マスターデータのフォーマットと インポートする各種モデルのリファレンス
{
"version": "2019-10-09",
"versionModels": [
{
"name": "[string]バージョンモデル名",
"metadata": "[string?]メタデータ",
"scope": "[string]判定に使用するバージョン値の種類",
"type": "[string]バージョンチェックモード",
"currentVersion": {
"major": "[int]メジャーバージョン",
"minor": "[int]マイナーバージョン",
"micro": "[int]マイクロバージョン"
},
"warningVersion": {
"major": "[int]メジャーバージョン",
"minor": "[int]マイナーバージョン",
"micro": "[int]マイクロバージョン"
},
"errorVersion": {
"major": "[int]メジャーバージョン",
"minor": "[int]マイナーバージョン",
"micro": "[int]マイクロバージョン"
},
"scheduleVersions": [
{
"currentVersion": {
"major": "[int]メジャーバージョン",
"minor": "[int]マイナーバージョン",
"micro": "[int]マイクロバージョン"
},
"warningVersion": {
"major": "[int]メジャーバージョン",
"minor": "[int]マイナーバージョン",
"micro": "[int]マイクロバージョン"
},
"errorVersion": {
"major": "[int]メジャーバージョン",
"minor": "[int]マイナーバージョン",
"micro": "[int]マイクロバージョン"
},
"scheduleEventId": "[string?]バージョンチェックを有効化する期間を設定した GS2-Schedule のイベントGRN"
}
],
"needSignature": "[bool]判定するバージョン値に署名検証を必要とするか",
"signatureKeyId": "[string]暗号鍵GRN",
"approveRequirement": "[string]承認の必要性"
}
]
}
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| version | ✓ | 2019-10-09 | マスターデータのフォーマットバージョン | |||
| versionModels | List<VersionModel> | ~ 100 items | バージョンモデル ログインを受け入れるが、バージョンアップ出来ることを通知する警告バージョンと、ログインを受け入れないエラーバージョンを設定できます。 現在のバージョンをクライアントに申告させるのに、署名の有無を指定できます。 署名付きを選択した場合、クライアントは嘘のバージョン申告を出来なくなります。 |
Status
バージョンの状態
バージョンの検証結果を表します。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| versionModel | VersionModel | ✓ | バージョンモデル | |||
| currentVersion | Version | 現在のバージョン |
TargetVersion
検証するバージョン
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| versionName | string | ✓ | ~ 128文字 | バージョンモデル名 | ||
| body | string | ~ 1048576文字 | ボディ | |||
| signature | string | ~ 256文字 | 署名 | |||
| version | Version | {signature} == "" | ✓* | バージョン ※ signature が "" であれば 有効 |
SignTargetVersion
署名対象バージョン
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| region | string | ✓ | ~ 128文字 | リージョン | ||
| namespaceName | string | ✓ | ~ 128文字 | ネームスペース名 | ||
| versionName | string | ✓ | ~ 128文字 | バージョンモデル名 | ||
| version | Version | ✓ | バージョン |
Version
バージョン
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| major | int | ✓ | 0 ~ 2147483646 | メジャーバージョン | ||
| minor | int | ✓ | 0 ~ 2147483646 | マイナーバージョン | ||
| micro | int | ✓ | 0 ~ 2147483646 | マイクロバージョン |
ScheduleVersion
時系列で切り替わるバージョン
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| currentVersion | Version | ✓ | 現在のバージョン | |||
| warningVersion | Version | ✓ | バージョンアップを促すバージョン | |||
| errorVersion | Version | ✓ | バージョンチェックでエラーになるバージョン | |||
| scheduleEventId | string | ~ 1024文字 | バージョンチェックを有効化する期間を設定した GS2-Schedule のイベントGRN |
VersionModel
バージョンモデル
ログインを受け入れるが、バージョンアップ出来ることを通知する警告バージョンと、ログインを受け入れないエラーバージョンを設定できます。
現在のバージョンをクライアントに申告させるのに、署名の有無を指定できます。
署名付きを選択した場合、クライアントは嘘のバージョン申告を出来なくなります。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| versionModelId | string | ✓ | ~ 1024文字 | バージョンモデルGRN | ||||||||
| name | string | ✓ | ~ 128文字 | バージョンモデル名 | ||||||||
| metadata | string | ~ 2048文字 | メタデータ | |||||||||
| scope | 文字列列挙型 enum { “passive”, “active” } | ✓ | ~ 128文字 | 判定に使用するバージョン値の種類
| ||||||||
| type | 文字列列挙型 enum { “simple”, “schedule” } | ✓ | “simple” | ~ 128文字 | バージョンチェックモード
| |||||||
| currentVersion | Version | {type} == “simple” and {scope} == “active” | ✓* | 現在のバージョン ※ type が “simple” で かつ scope が “active” であれば 必須 | ||||||||
| warningVersion | Version | {type} == “simple” | ✓* | バージョンアップを促すバージョン ※ type が “simple” であれば 有効 | ||||||||
| errorVersion | Version | {type} == “simple” | ✓* | バージョンチェックでエラーになるバージョン ※ type が “simple” であれば 有効 | ||||||||
| scheduleVersions | List<ScheduleVersion> | {type} == “schedule” | 0 ~ 10 items | 時系列で切り替わるバージョンチェック内容リスト ※ type が “schedule” であれば 有効 | ||||||||
| needSignature | bool | {scope} == “passive” | ✓* | 判定するバージョン値に署名検証を必要とするか ※ scope が “passive” であれば 有効 | ||||||||
| signatureKeyId | string | {needSignature} | ✓* | ~ 1024文字 | 暗号鍵GRN ※ needSignature が “true” であれば 有効 | |||||||
| approveRequirement | 文字列列挙型 enum { “required”, “optional” } | {scope} == “active” | ✓* | “required” | ~ 128文字 | 承認の必要性
※ scope が “active” であれば 有効 |