Master Data Reference of GS2-Version

{
  "version": "2019-10-09",
  "versionModels": [
    {
      "name": "[string]Version Model Name",
      "metadata": "[string?]metadata",
      "scope": "[string]Type of version value used for judgment",
      "type": "[string]Type of version value used for judgment",
      "currentVersion": {
        "major": "[int]Major version",
        "minor": "[int]Minor version",
        "micro": "[int]Micro version"
      },
      "warningVersion": {
        "major": "[int]Major version",
        "minor": "[int]Minor version",
        "micro": "[int]Micro version"
      },
      "errorVersion": {
        "major": "[int]Major version",
        "minor": "[int]Minor version",
        "micro": "[int]Micro version"
      },
      "scheduleVersions": [
        {
          "currentVersion": {
            "major": "[int]Major version",
            "minor": "[int]Minor version",
            "micro": "[int]Micro version"
          },
          "warningVersion": {
            "major": "[int]Major version",
            "minor": "[int]Minor version",
            "micro": "[int]Micro version"
          },
          "errorVersion": {
            "major": "[int]Major version",
            "minor": "[int]Minor version",
            "micro": "[int]Micro version"
          },
          "scheduleEventId": "[string?]GS2-Schedule event GRN that enables version check"
        }
      ],
      "needSignature": "[bool]Whether the version value to be determined requires signature verification",
      "signatureKeyId": "[string]encryption key GRN"
    }
  ]
}
TypeConditionRequireDefaultLimitationDescription
version2019-10-09Format version of master data
versionModelsList<VersionModel>~ 100 itemsVersion Model

VersionModel

Version Model

You can set a warning version that accepts login but notifies you that you can upgrade, and an error version that does not accept login.

You can specify whether or not to have the client declare the current version with or without a signature. If you select signed, the client will not be able to declare a false version.

TypeConditionRequireDefaultLimitationDescription
versionModelIdstring~ 1024 charsVersion Model GRN
namestring~ 128 charsVersion Model Name
metadatastring~ 2048 charsmetadata
scopeenum {
    “passive”,
    “active”
}
~ 128 charsType of version value used for judgment
typeenum {
    “simple”,
    “schedule”
}
“simple”~ 128 charsType of version value used for judgment
currentVersionVersion{type} == “simple” and {scope} == “active”Current Version
warningVersionVersion{type} == “simple”Version that prompts for version upgrade
errorVersionVersion{type} == “simple”Version that is determined to be an error by the version check
scheduleVersionsList<ScheduleVersion>{type} == “schedule”~ 10 itemsList of Version check content that switches over time series
needSignaturebool{scope} == “passive”Whether the version value to be determined requires signature verification
signatureKeyIdstring{needSignature}~ 1024 charsencryption key GRN

Enumeration type definition to specify as scope

Enumerator String DefinitionDescription
passiveSent by Client
activeVersion explicitly approved in the past

Enumeration type definition to specify as type

Enumerator String DefinitionDescription
simpleSimple
scheduleSchedule Change

Status

Version Status

Indicates the result of version verification.

TypeConditionRequireDefaultLimitationDescription
versionModelVersionModelVersion Model
currentVersionVersionCurrent Version

TargetVersion

Version to be verified

TypeConditionRequireDefaultLimitationDescription
versionNamestring~ 128 charsVersion Model Name
bodystring~ 1048576 charsBody
signaturestring~ 256 charsSignature
versionVersion{signature} == ""Version

SignTargetVersion

TypeConditionRequireDefaultLimitationDescription
regionstring~ 128 charsRegion
namespaceNamestring~ 128 charsNamespace name
versionNamestring~ 128 charsVersion Model Name
versionVersionVersion

Version

Version

TypeConditionRequireDefaultLimitationDescription
majorint~ 2147483646Major version
minorint~ 2147483646Minor version
microint~ 2147483646Micro version

ScheduleVersion

Version that switches in chronological order

TypeConditionRequireDefaultLimitationDescription
currentVersionVersionCurrent Version
warningVersionVersionVersion that prompts for version upgrade
errorVersionVersionVersion that is determined to be an error by the version check
scheduleEventIdstring~ 1024 charsGS2-Schedule event GRN that enables version check