com.crashthearcade.list Documentation (EN)

main record

A ranked list of games created by a user

Record Key tid Timestamp-based ID

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

items array of ref #listItem Required

No description available.

name string Required

No description available.

maxLength: 256 bytes

numbered boolean Optional

Whether to display position numbers on items

updatedAt string datetime Required

An RFC 3339 formatted timestamp.

url string uri Optional

Public URL to view this list on Crash the Arcade

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "name",
      "items",
      "createdAt",
      "updatedAt"
    ],
    "properties": {
      "url": {
        "type": "string",
        "format": "uri",
        "description": "Public URL to view this list on Crash the Arcade"
      },
      "name": {
        "type": "string",
        "maxLength": 256
      },
      "items": {
        "type": "array",
        "items": {
          "ref": "#listItem",
          "type": "ref"
        }
      },
      "numbered": {
        "type": "boolean",
        "description": "Whether to display position numbers on items"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "updatedAt": {
        "type": "string",
        "format": "datetime"
      }
    }
  },
  "description": "A ranked list of games created by a user"
}

listItem object

No description available.

Properties

award string Optional

Optional label or emoji award for this entry

maxLength: 128 bytes

coverUrl string uri Optional

A valid URI.

igdbId integer Required

No description available.

position integer Required

No description available.

minimum: 1

title string Required

No description available.

maxLength: 256 bytes

View raw schema

{
  "type": "object",
  "required": [
    "igdbId",
    "title",
    "position"
  ],
  "properties": {
    "award": {
      "type": "string",
      "maxLength": 128,
      "description": "Optional label or emoji award for this entry"
    },
    "title": {
      "type": "string",
      "maxLength": 256
    },
    "igdbId": {
      "type": "integer"
    },
    "coverUrl": {
      "type": "string",
      "format": "uri"
    },
    "position": {
      "type": "integer",
      "minimum": 1
    }
  }
}