Skip to content
DARK
PAWNS

A Multi-User DungeonEST. 1994

Get an OLC editor schema

Look up the Dark Pawns admin API request and response contract. Sign in with a level 40 character and use the authenticated admin console session.

GET
/admin/olc/schema/{kind}
curl --request GET \
  --url https://example.com/admin/olc/schema/example

Returns the shared vocabulary and resolved controls for an OLC editor kind.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
kind
required

OLC kind: room, mob, obj, shop, or zone.

string

OLC kind: room, mob, obj, shop, or zone.

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
actions
Array<object> | null
object
allowed
required
boolean
key
required
string
label
required
string
required_label
required
string
required_level
required
integer format: int64
applies
object
add_operation
required
string
max
required
integer format: int64
options
required
Array<object> | null
object
label
required
string
storage
string
value
required
integer format: int64
remove_operation
required
string
bespoke
Array<string> | null
exits
object
directions
required
Array<string> | null
door_options
required
Array<object> | null
object
label
required
string
storage
string
value
required
integer format: int64
fields
required
Array<object> | null
object
bounds
object
max
required
integer format: int64
min
required
integer format: int64
control
required
string
key
required
string
label
required
string
options
Array<object> | null
object
label
required
string
storage
string
value
required
integer format: int64
kind
required
string
value_matrix
Array<object> | null
object
item_type
required
integer format: int64
item_type_label
required
string
values
required
Array<object> | null
>= 4 items <= 4 items
object
control
required
string
label
required
string
max
required
integer format: int64
min
required
integer format: int64
options
Array<object> | null
object
label
required
string
storage
string
value
required
integer format: int64
visible
required
boolean
zone_commands
Array<object> | null
object
arguments
required
Array<object> | null
>= 3 items <= 3 items
object
bounds
object
max
required
integer format: int64
min
required
integer format: int64
control
required
string
key
required
string
label
required
string
options
Array<object> | null
object
label
required
string
storage
string
value
required
integer format: int64
visible
required
boolean
command
required
string
label
required
string

Example generated

{
  "actions": [
    {
      "allowed": true,
      "key": "example",
      "label": "example",
      "required_label": "example",
      "required_level": 1
    }
  ],
  "applies": {
    "add_operation": "example",
    "max": 1,
    "options": [
      {
        "label": "example",
        "storage": "example",
        "value": 1
      }
    ],
    "remove_operation": "example"
  },
  "bespoke": [
    "example"
  ],
  "exits": {
    "directions": [
      "example"
    ],
    "door_options": [
      {
        "label": "example",
        "storage": "example",
        "value": 1
      }
    ]
  },
  "fields": [
    {
      "bounds": {
        "max": 1,
        "min": 1
      },
      "control": "example",
      "key": "example",
      "label": "example",
      "options": [
        {
          "label": "example",
          "storage": "example",
          "value": 1
        }
      ]
    }
  ],
  "kind": "example",
  "value_matrix": [
    {
      "item_type": 1,
      "item_type_label": "example",
      "values": [
        {
          "control": "example",
          "label": "example",
          "max": 1,
          "min": 1,
          "options": [
            {
              "label": "example",
              "storage": "example",
              "value": 1
            }
          ],
          "visible": true
        }
      ]
    }
  ],
  "zone_commands": [
    {
      "arguments": [
        {
          "bounds": {
            "max": 1,
            "min": 1
          },
          "control": "example",
          "key": "example",
          "label": "example",
          "options": [
            {
              "label": "example",
              "storage": "example",
              "value": 1
            }
          ],
          "visible": true
        }
      ],
      "command": "example",
      "label": "example"
    }
  ]
}

default

Section titled “default”

Error

Media typeapplication/problem+json
object
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object> | null
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank

Example 

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}