Appearance
Add or update one runtime app mapping โ
POST /v1/admin/store/games/{gameId}/runtime-apps
- Operation ID:
saveStoreGameRuntimeApp - Tags: Store runtime apps
- Base URL:
http://localhost:8787
Upserts the mapping for runtime_app_id (both create and update return 201). is_default: true promotes it (and demotes the previous default) when enabled; a disabled mapping cannot be default. Emits a dashboard event.
Workflow: Integration guide.
Authentication: staff Bearer JWT with permission store.write.
Authentication โ
- Auth: staff Bearer JWT (
Authorization: Bearer <access_token>) with the permissions below. - Required permissions:
store.write
Parameters โ
| Name | In | Type | Required | Description |
|---|---|---|---|---|
gameId | path | integer | yes | Greater than: 0 |
Request body โ
Required: yes.
Content type: application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
runtime_app_id | string | yes | Min length: 1. Max length: 200 |
label | string | no | Max length: 200 |
is_enabled | boolean | no | - |
is_default | boolean | no | - |
sort_order | integer | no | Min: 0. Max: 100000 |
Responses โ
201 โ
Saved mapping.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (StoreGameRuntimeApp)
| Field | Type | Required | Description |
|---|---|---|---|
id | string<uuid> | yes | - |
game_id | integer | yes | - |
runtime_app_id | string | yes | Opaque app id in the runtime. |
label | string | yes | - |
is_default | boolean | yes | - |
is_enabled | boolean | yes | - |
sort_order | integer | yes | - |
created_at | string | yes | ISO 8601 timestamp. |
updated_at | string | yes | ISO 8601 timestamp. |
Errors โ
400 โ
Request validation failed.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ValidationErrorBody)
| Field | Type | Required | Description |
|---|---|---|---|
success | boolean | yes | One of: false |
error | object | yes | - |
error.name | string | yes | One of: "ZodError" |
error.issues | object[] | yes | - |
error.issues[].code | string | yes | - |
error.issues[].path | (string | number)[] | yes | - |
error.issues[].message | string | yes | - |
Request validation
json
{
"success": false,
"error": {
"name": "ZodError",
"issues": [
{
"code": "custom",
"path": [
"field"
],
"message": "Invalid value"
}
]
}
}401 โ
Missing, malformed, expired or wrong-audience Bearer token (missing_token, invalid_token, invalid_audience).
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody)
| Field | Type | Required | Description |
|---|---|---|---|
error | string | yes | Stable machine-readable error code, e.g. forbidden, not_found. |
details | any | no | Optional structured context. For 403 it is { perm }. |
Error response
json
{
"error": "missing_token"
}403 โ
Authenticated but lacking the required permission. details.perm lists the accepted permission keys.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody), fields as described above.
Error response
json
{
"error": "forbidden",
"details": {
"perm": "store.write"
}
}404 โ
game_not_found.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody), fields as described above.
Error response
json
{
"error": "game_not_found"
}500 โ
Unexpected server error (internal). No details are returned.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody), fields as described above.
Error response
json
{
"error": "internal"
}Examples โ
curl โ
bash
curl -X POST 'http://localhost:8787/v1/admin/store/games/1/runtime-apps' \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
--data '{"runtime_app_id":"3f6c2a1e-8b4d-4e7a-9c1f-2d5b6a7e8f90","label":"example","is_enabled":false,"is_default":false,"sort_order":1}'TypeScript โ
ts
const accessToken = process.env.ACCESS_TOKEN; // user JWT from your sign-in flow
const response = await fetch("http://localhost:8787/v1/admin/store/games/1/runtime-apps", {
method: "POST",
headers: {
"Authorization": `Bearer ${accessToken}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"runtime_app_id": "3f6c2a1e-8b4d-4e7a-9c1f-2d5b6a7e8f90",
"label": "example",
"is_enabled": false,
"is_default": false,
"sort_order": 1
}),
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
? undefined
: response.headers.get("content-type")?.includes("json")
? await response.json()
: await response.text();