Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Default"default"

Match^[a-zA-Z0-9_-]{1,64}$

namespace?string

Match^[a-zA-Z0-9._:/%-]{1,512}$

Length1 <= length <= 512

schemaVersion?integer

Default1

Range0 < value

operations*array<||||>

Items1 <= items <= 1000

Response Body

`application/json`

curl -X POST "http://localhost:3013/api/rooms/change" \  -H "Content-Type: application/json" \  -d '{    "operations": [      {        "type": "set",        "path": [          "string"        ],        "value": null      }    ]  }'

{
  "room": {
    "namespace": "string",
    "name": "string",
    "schemaVersion": 0,
    "generation": "string",
    "stale": true,
    "state": null,
    "snapshot": "string",
    "bytes": 0
  }
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

value?unknown

Response Body

`application/json`

curl -X POST "http://localhost:3013/api/rooms/decode" \  -H "Content-Type: application/json" \  -d '{}'

{
  "schemaVersion": 0,
  "generation": "string",
  "state": null
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Query Parameters

name?string

Default"default"

Match^[a-zA-Z0-9_-]{1,64}$

namespace?string

Match^[a-zA-Z0-9._:/%-]{1,512}$

Length1 <= length <= 512

schemaVersion?integer

Default1

Range0 < value

Response Body

`application/json`

curl -X GET "http://localhost:3013/api/rooms/get"

{
  "room": {
    "namespace": "string",
    "name": "string",
    "schemaVersion": 0,
    "generation": "string",
    "stale": true,
    "state": null,
    "snapshot": "string",
    "bytes": 0
  }
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Default"default"

Match^[a-zA-Z0-9_-]{1,64}$

namespace?string

Match^[a-zA-Z0-9._:/%-]{1,512}$

Length1 <= length <= 512

schemaVersion?integer

Default1

Range0 < value

Response Body

`application/json`

curl -X POST "http://localhost:3013/api/rooms/get" \  -H "Content-Type: application/json" \  -d '{}'

{
  "room": {
    "namespace": "string",
    "name": "string",
    "schemaVersion": 0,
    "generation": "string",
    "stale": true,
    "state": null,
    "snapshot": "string",
    "bytes": 0
  }
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Default"default"

Match^[a-zA-Z0-9_-]{1,64}$

namespace?string

Match^[a-zA-Z0-9._:/%-]{1,512}$

Length1 <= length <= 512

schemaVersion?integer

Default1

Range0 < value

state?unknown

Response Body

`application/json`

curl -X POST "http://localhost:3013/api/rooms/reset" \  -H "Content-Type: application/json" \  -d '{}'

{
  "room": {
    "namespace": "string",
    "name": "string",
    "schemaVersion": 0,
    "generation": "string",
    "stale": true,
    "state": null,
    "snapshot": "string",
    "bytes": 0
  }
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

Rooms

200application/json

400application/json

403application/json

409application/json

413application/json

200application/json

400application/json

413application/json

200application/json

400application/json

403application/json

404application/json

200application/json

400application/json

403application/json

404application/json

413application/json

200application/json

400application/json

403application/json

413application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`