Scenario schema

GET

/api/v1/scenario-format/{version}/schema.json

curl --request GET \
  --url https://example.com/api/v1/scenario-format/1/schema.json \
  --cookie ttx_access_token=<ttx_access_token>

The JSON Schema of a scenario file’s data block, per format version (2 adds a phase’s headline, 3 rooms, 4 inject files, 5 rendered artifacts, 6 inject formats and polls, 7 poll outcomes, 8 impact meters): for anyone writing or checking files outside TTX-Zone.

Authorizations

• sessionCookie

Parameters

Path Parameters

version

required

Version

integer

Responses

200

Successful Response

Media typeapplication/json

Response Scenario Schema Endpoint Api V1 Scenario Format Version Schema Json Get

object

key

additional properties

any

Example ^generated

{}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example ^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}