Skip to main content

Field types & roles

The complete set of field types and role enums, generated directly from the app's schema model — so it always matches the version you're running. Meaning always flows from these declarations, never from a field's name. The Types & fields reference explains how each is used.

Field types (fieldType)​

fieldTypeMeaning
idStable id/key field for the entity. Useful when filenames may change.
titleA title or alternate title. Contributes to entity.title and/or entity.titles.
imageSingle cover/image URL.
imageListList of image URLs. The first useful image may be used as the cover.
enumSingle value from a known option set.
enumListMultiple values from a known option set.
numberA plain number: a count such as episodes or pages, or a hand-kept tally. (The retired progress / totalProgress types still load as number.)
ratingNumeric rating. Optional ratingMax declares a scale from zero to that maximum; absent means unscaled. Existing values are never rescaled automatically.
boolBoolean flag.
seasonSeason or release window such as 2025, 2025 Spring, or localized season strings. Can be used in date views.
dateDate-like field. Exact dates are normalized for calendar links.
externalRefURL or id pointing to an external metadata provider (see External providers).
relationWikilink or list of wikilinks to other entities.
textGeneric scalar text.
textListGeneric list of text values.

Date roles (dateRole)​

Set on date and season fields; see Dates and Calendar Design.

dateRoleMeaning
planningFuture, release, airing, publish, or schedule date.
startedThe date you started the entity (began watching, reading, or playing). It's the field a started log entry stamps, and it reads as a record: it shows in the activity feed's Recent, never as something upcoming.
completedFinished, watched, read, played, or completed date.
eventA date the entity happens on and you attend (a concert, exhibition, or release event), rather than a release you consume. Whether it reads as upcoming or attended is derived from the entity's status, not a separate role.

Title roles (titleRole)​

titleRoleMeaning
originalThe language-agnostic fallback title used for entity.title when the viewer's language has no title.

Enum roles (enumRole)​

enumRoleMeaning
statusMarks the one enum field the engine treats as the entity's lifecycle status. Pair with statusValues to give options canonical meaning.

Canonical statuses (statusValues)​

The fixed set an enumRole: status field's options can map onto; see Status.

CanonicalMeaning
planningIntend to watch/read/play (or attend, for an event date).
ongoingIn progress.
pausedOn hold — deliberately deferred but not abandoned. Kept off "up next", but a started/completed log resumes it (unlike dropped).
completedFinished.
droppedAbandoned — kept off "up next"; a log never auto-resumes it. Its past records still appear in the activity feed.

Season languages (seasonLanguage)​

seasonLanguageMeaning
zhChinese season labels.
jaJapanese season labels.
enEnglish season labels.