live config

Manages live configuraion data

Experimental feature: this API is likely to change.

Service health check

GEThttp://admin.m2worlds.io/api/live-config/healthz

Response

Default Response

Body

statusMessage (string)

Provides information about the service status.

Request

const response = await fetch('http://admin.m2worlds.io/api/live-config/healthz', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

"text"

Retrieves metadata about a live config instance

GEThttp://admin.m2worlds.io/api/live-config/meta/

Authorization

Header parameters

Response

Default Response

Body

buildId*string

The original build id that this live config instance was created from

contentIdstring

The content id that this live config instance was created from, if provided

buildSchemaVersion*string

The build live config schema version that this live config instance was created from

contentSchemaVersionstring

The content live config schema version that this live config instance was created from

configIds*array of string

The config file names contained in the live config schema

Request

const response = await fetch('http://admin.m2worlds.io/api/live-config/meta/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "buildId": "text",
  "contentId": "text",
  "buildSchemaVersion": "text",
  "contentSchemaVersion": "text",
  "configIds": [
    "text"
  ]
}

Gets all live config JSON schemas for the given buildId

GEThttp://admin.m2worlds.io/api/live-config/builds/{buildId}/schema/

Path parameters

buildId*string

Response

Default Response

Body

Other propertiesJSONSchema7DefinitionSchema (object)

Request

const response = await fetch('http://admin.m2worlds.io/api/live-config/builds/{buildId}/schema/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Posts all live config JSON schemas for the given buildId

POSThttp://admin.m2worlds.io/api/live-config/builds/{buildId}/schema/

Path parameters

buildId*string

Body

Request body containing a collection of live config JSON Schemas

schema*object

A collection of live config JSON schemas

Response

Default Response

Body

statusMessage (string)

Provides information about the service status.

Request

const response = await fetch('http://admin.m2worlds.io/api/live-config/builds/{buildId}/schema/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

"text"

Gets the live config JSON schema for the given buildId and configId

GEThttp://admin.m2worlds.io/api/live-config/builds/{buildId}/schema/{configId}/

Path parameters

buildId*string

configId*string

Response

Default Response

Body

idstring

$schemastring

titlestring

descriptionstring

typeany of

defaultany of

propertiesobject

multipleOfnumber

maximumnumber

exclusiveMaximumnumber

minimumnumber

exclusiveMinimumnumber

maxLengthnumber

minLengthnumber

requiredany of

patternstring

formatstring

Other propertiesany

Request

const response = await fetch('http://admin.m2worlds.io/api/live-config/builds/{buildId}/schema/{configId}/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "$schema": "text",
  "title": "text",
  "description": "text",
  "type": "string",
  "default": "text",
  "multipleOf": 0,
  "maximum": 0,
  "exclusiveMaximum": 0,
  "minimum": 0,
  "exclusiveMinimum": 0,
  "maxLength": 0,
  "minLength": 0,
  "required": false,
  "pattern": "text",
  "format": "text"
}

Gets all live config JSON schemas for the given contentId

GEThttp://admin.m2worlds.io/api/live-config/content/{contentId}/schema/

Path parameters

contentId*string

Response

Default Response

Body

Other propertiesJSONSchema7DefinitionSchema (object)

Request

const response = await fetch('http://admin.m2worlds.io/api/live-config/content/{contentId}/schema/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Posts all live config JSON schemas for the given contentId. Config names of schema are not allowed to overlap with those defined in the build associated with the given contentId.

POSThttp://admin.m2worlds.io/api/live-config/content/{contentId}/schema/

Path parameters

contentId*string

Body

Request body containing a collection of live config JSON Schemas

schema*object

A collection of live config JSON schemas

Response

Default Response

Body

statusMessage (string)

Provides information about the service status.

Request

const response = await fetch('http://admin.m2worlds.io/api/live-config/content/{contentId}/schema/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

"text"

Posts live config overrides for content

POSThttp://admin.m2worlds.io/api/live-config/content/{contentId}/override/

Path parameters

contentId*string

Body

Request containing changes to a live config file instance

overrideData*LiveConfigOverrideDataSchema (object)

A record containing partial live config data for overriding, keyed by config name.

Response

Default Response

Body

statusMessage (string)

Provides information about the service status.

Request

const response = await fetch('http://admin.m2worlds.io/api/live-config/content/{contentId}/override/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

"text"

Gets live config overrides for content

GEThttp://admin.m2worlds.io/api/live-config/content/{contentId}/override/

Path parameters

contentId*string

Response

Default Response

Body

Other propertiesLiveConfigDataSchema (object)

Payload for a live config file instance

Request

const response = await fetch('http://admin.m2worlds.io/api/live-config/content/{contentId}/override/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Posts live config overrides for map

POSThttp://admin.m2worlds.io/api/live-config/content/{contentId}/map/override/

Path parameters

contentId*string

Body

Request containing changes to a live config file instance

overrideData*LiveConfigOverrideDataSchema (object)

A record containing partial live config data for overriding, keyed by config name.

Response

Default Response

Body

statusMessage (string)

Provides information about the service status.

Request

const response = await fetch('http://admin.m2worlds.io/api/live-config/content/{contentId}/map/override/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

"text"

Gets live config overrides for map

GEThttp://admin.m2worlds.io/api/live-config/content/{contentId}/map/override/

Path parameters

contentId*string

Response

Default Response

Body

LiveConfigOverrideGetRequestSchema (any)

A reply of a record containing partial live config data for overriding, keyed by config name.

Request

const response = await fetch('http://admin.m2worlds.io/api/live-config/content/{contentId}/map/override/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Retrieves a live config file

GEThttp://admin.m2worlds.io/api/live-config/config/{configId}/

Authorization

Path parameters

configId*string

Header parameters

Response

Default Response

Body

liveConfig*LiveConfigDataSchema (object)

Payload for a live config file instance

version*number

Request

const response = await fetch('http://admin.m2worlds.io/api/live-config/config/{configId}/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "version": 0
}

Updates a live config file

PATCHhttp://admin.m2worlds.io/api/live-config/config/{configId}/

Authorization

Path parameters

configId*string

Header parameters

Body

data*LiveConfigDataSchema (object)

Payload for a live config file instance

fields*array of string

The dot-delimited fields to patch. Any fields that are listed in fields but not found in the data will be removed.

Response

Default Response

Body

statusMessage (string)

Provides information about the service status.

Request

const response = await fetch('http://admin.m2worlds.io/api/live-config/config/{configId}/', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "fields": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

"text"

Retrieves the contents of a live config file

GEThttp://admin.m2worlds.io/api/live-config/gameConfig/{configId}.json/

Path parameters

configId*string

Header parameters

Response

Default Response

Body

Other propertiesany

Request

const response = await fetch('http://admin.m2worlds.io/api/live-config/gameConfig/{configId}.json/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{}

Retrieves the live config schema of the running world

GEThttp://admin.m2worlds.io/api/live-config/schema/

Header parameters

Response

Default Response

Body

Other propertiesJSONSchema7DefinitionSchema (object)

Request

const response = await fetch('http://admin.m2worlds.io/api/live-config/schema/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Previouslauncher Nextmessaging

Last updated 1 month ago