football.tools.formguide.preferences

tools.football

Documentation

main record

No description available.

Record Key literal:self Fixed literal value

Properties

createdAt string datetime Required

When the preferences record was first created.

favoriteTeams array of ref #favoriteTeam Optional

Teams the user follows. Order is significant — clients should preserve it for display.

maxLength: 100 items
updatedAt string datetime Optional

When the preferences record was last modified.

View raw schema 
{
  "key": "literal:self",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "createdAt"
    ],
    "properties": {
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "When the preferences record was first created."
      },
      "updatedAt": {
        "type": "string",
        "format": "datetime",
        "description": "When the preferences record was last modified."
      },
      "favoriteTeams": {
        "type": "array",
        "items": {
          "ref": "#favoriteTeam",
          "type": "ref"
        },
        "maxLength": 100,
        "description": "Teams the user follows. Order is significant — clients should preserve it for display."
      }
    }
  }
}
favoriteTeam object

A team the user follows, scoped to a specific league.

Properties

addedAt string datetime Optional

When this team was added to favorites.

league string Required

League slug as used in the Form Guide URL (e.g. mls, nwsl, epl).

maxLength: 64 bytes
name string Optional

Denormalized display name at the time the team was added. Hint for consumers; the league/slug pair is the canonical key.

maxLength: 200 bytes
slug string Required

Team slug — lowercased, hyphenated form of the team's display name. Unique within a league.

maxLength: 128 bytes
View raw schema 
{
  "type": "object",
  "required": [
    "league",
    "slug"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 200,
      "description": "Denormalized display name at the time the team was added. Hint for consumers; the league/slug pair is the canonical key."
    },
    "slug": {
      "type": "string",
      "maxLength": 128,
      "description": "Team slug — lowercased, hyphenated form of the team's display name. Unique within a league."
    },
    "league": {
      "type": "string",
      "maxLength": 64,
      "description": "League slug as used in the Form Guide URL (e.g. mls, nwsl, epl)."
    },
    "addedAt": {
      "type": "string",
      "format": "datetime",
      "description": "When this team was added to favorites."
    }
  },
  "description": "A team the user follows, scoped to a specific league."
}

Lexicon Garden

@