Master Data Reference of GS2-Version

Tags:

Master Data

{
  "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",
      "approveRequirement": "[string]Requirement for approval"
    }
  ]
}

	Type	Condition	Require	Default	Limitation	Description
version			✓	2019-10-09		Format version of master data
versionModels	List<VersionModel>				~ 100 items	Version 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.

	Type	Condition	Require	Default	Limitation	Description
versionModelId	string		✓		~ 1024 chars	Version Model GRN
name	string		✓		~ 128 chars	Version Model Name
metadata	string				~ 2048 chars	metadata
scope	enum { “passive”, “active” }		✓		~ 128 chars	Type of version value used for judgment
type	enum { “simple”, “schedule” }		✓	“simple”	~ 128 chars	Type of version value used for judgment
currentVersion	Version	{type} == “simple” and {scope} == “active”	✓			Current Version
warningVersion	Version	{type} == “simple”	✓			Version that prompts for version upgrade
errorVersion	Version	{type} == “simple”	✓			Version that is determined to be an error by the version check
scheduleVersions	List<ScheduleVersion>	{type} == “schedule”			~ 10 items	List of Version check content that switches over time series
needSignature	bool	{scope} == “passive”	✓			Whether the version value to be determined requires signature verification
signatureKeyId	string	{needSignature}	✓		~ 1024 chars	encryption key GRN
approveRequirement	enum { “required”, “optional” }	{scope} == “active”	✓	“required”	~ 128 chars	Requirement for approval

Enumeration type definition to specify as scope

Enumerator String Definition	Description
passive	Sent by Client
active	Version explicitly approved in the past

Enumeration type definition to specify as type

Enumerator String Definition	Description
simple	Simple
schedule	Schedule Change

Enumeration type definition to specify as approveRequirement

Enumerator String Definition	Description
required	Approval required
optional	Any approval

Status

Version Status

Indicates the result of version verification.

	Type	Condition	Require	Default	Limitation	Description
versionModel	VersionModel		✓			Version Model
currentVersion	Version					Current Version

TargetVersion

Version to be verified

	Type	Condition	Require	Limitation	Description
versionName	string		✓	~ 128 chars	Version Model Name
body	string			~ 1048576 chars	Body
signature	string			~ 256 chars	Signature
version	Version	{signature} == ""	✓		Version

SignTargetVersion

Sign Target Version

	Type	Require	Limitation	Description
region	string	✓	~ 128 chars	Region
namespaceName	string	✓	~ 128 chars	Namespace name
versionName	string	✓	~ 128 chars	Version Model Name
version	Version	✓		Version

Version

	Type	Require	Limitation	Description
major	int	✓	~ 2147483646	Major version
minor	int	✓	~ 2147483646	Minor version
micro	int	✓	~ 2147483646	Micro version

ScheduleVersion

Version that switches in chronological order

	Type	Require	Limitation	Description
currentVersion	Version	✓		Current Version
warningVersion	Version	✓		Version that prompts for version upgrade
errorVersion	Version	✓		Version that is determined to be an error by the version check
scheduleEventId	string		~ 1024 chars	GS2-Schedule event GRN that enables version check