schema reference
Club Metadata Export
ClubMetadataExport
Sidecar club identity metadata keyed by clubId. Records combine source-backed history with generated observations from the season tables.
Schema Links
Contents
Root
Root
object
1 requiredclosed object
Sidecar club identity metadata keyed by clubId. Records combine source-backed history with generated observations from the season tables.
| Property key | Type | Use | Notes |
|---|---|---|---|
metadata |
DatasetMetadata
|
optional | No description. |
clubs |
ClubsMap
|
required | No description. |
Club Absence Explanation
ClubAbsenceExplanation
object
2 requiredclosed object
| Property key | Type | Use | Notes |
|---|---|---|---|
fromSeason |
integer |
required | No description. |
toSeason |
integer | null |
optional | No description. |
reason |
string |
required | Broad reason code such as official-competition-paused, outside-tracked-coverage, below-tracked-coverage, club-inactive, club-dissolved, club-reformed, or unknown. |
linkedEventType |
string | null |
optional | No description. |
basis |
string | null |
optional | No description. |
notes |
string | null |
optional | No description. |
sourceRefs |
SourceRefs
|
optional | No description. |
Club Coverage Gap
ClubCoverageGap
object
3 requiredclosed object
| Property key | Type | Use | Notes |
|---|---|---|---|
startSeason |
integer |
required | No description. |
endSeason |
integer |
required | No description. |
length |
integer |
required | No description. |
Club Derived Metadata
ClubDerivedMetadata
object
closed object
Generated observations from the season table data. These fields describe dataset coverage, not necessarily real-world club activity.
| Property key | Type | Use | Notes |
|---|---|---|---|
source |
string | null |
optional | No description. |
aliases |
StringList
|
optional | No description. |
identitySources |
array |
optional | No description. |
relationships |
array |
optional | No description. |
observedNames |
array |
optional | No description. |
observedNamePeriods |
array |
optional | No description. |
firstSeenSeason |
integer | null |
optional | No description. |
lastSeenSeason |
integer | null |
optional | No description. |
seasonsSeen |
IntegerList
|
optional | No description. |
totalSeasonsSeen |
integer |
optional | No description. |
tiersSeen |
StringList
|
optional | No description. |
tierSeasons |
array |
optional | No description. |
coverageGaps |
array |
optional | No description. |
Club Financial Event
ClubFinancialEvent
object
1 requiredclosed object
| Property key | Type | Use | Notes |
|---|---|---|---|
type |
string |
required | No description. |
startSeason |
integer | null |
optional | No description. |
endSeason |
integer | null |
optional | No description. |
seasonsMissed |
IntegerList
|
optional | No description. |
notes |
string | null |
optional | No description. |
Club History
ClubHistory
object
closed object
Source-backed club history and expected membership context.
| Property key | Type | Use | Notes |
|---|---|---|---|
nameHistory |
array |
optional | No description. |
lifecycleEvents |
array |
optional | No description. |
trackedMembership |
array |
optional | No description. |
absenceExplanations |
array |
optional | No description. |
Club Identity Source
ClubIdentitySource
object
2 requiredclosed object
| Property key | Type | Use | Notes |
|---|---|---|---|
type |
string |
required | No description. |
sourceUrl |
string |
required | No description. |
notes |
string | null |
optional | No description. |
Club Lifecycle Event
ClubLifecycleEvent
object
1 requiredclosed object
| Property key | Type | Use | Notes |
|---|---|---|---|
type |
string |
required | Event label such as renamed, merged, dissolved, not-re-elected, relocated, or phoenix. |
season |
integer | null |
optional | No description. |
date |
string | null |
optional | No description. |
fromSeason |
integer | null |
optional | No description. |
toSeason |
integer | null |
optional | No description. |
fromName |
string | null |
optional | No description. |
toName |
string | null |
optional | No description. |
label |
string | null |
optional | No description. |
description |
string | null |
optional | No description. |
notes |
string | null |
optional | No description. |
sourceRefs |
SourceRefs
|
optional | No description. |
Club Metadata
ClubMetadata
object
1 requiredclosed object
Metadata for a single club identity.
| Property key | Type | Use | Notes |
|---|---|---|---|
clubId |
string |
optional | URL-safe stable club identity slug. |
canonicalName |
string |
required | Preferred display name for this club identity. |
status |
ClubStatus
|
optional | No description. |
history |
ClubHistory
|
optional | No description. |
derived |
ClubDerivedMetadata
|
optional | No description. |
assets |
MetadataAssets
|
optional | No description. |
founded |
string | null |
optional | No description. |
dissolved |
string | null |
optional | No description. |
nameHistory |
array |
optional | Legacy name-history field. Prefer history.nameHistory for new consumers. |
financialEvents |
array |
optional | Legacy financial-event field. Prefer source-backed lifecycle events for new consumers. |
notes |
string | null |
optional | No description. |
sourceUrl |
string | null |
optional | No description. |
Club Name Period
ClubNamePeriod
object
1 requiredclosed object
| Property key | Type | Use | Notes |
|---|---|---|---|
name |
string |
required | No description. |
startSeason |
integer | null |
optional | No description. |
endSeason |
integer | null |
optional | No description. |
notes |
string | null |
optional | No description. |
Club Observed Name
ClubObservedName
object
4 requiredclosed object
| Property key | Type | Use | Notes |
|---|---|---|---|
rawName |
string |
required | No description. |
normalizedName |
string |
required | No description. |
firstSeenSeason |
integer |
required | No description. |
lastSeenSeason |
integer |
required | No description. |
seasonsSeen |
IntegerList
|
optional | No description. |
tiersSeen |
StringList
|
optional | No description. |
Club Observed Name Period
ClubObservedNamePeriod
object
3 requiredclosed object
| Property key | Type | Use | Notes |
|---|---|---|---|
name |
string |
required | No description. |
startSeason |
integer |
required | No description. |
endSeason |
integer |
required | No description. |
Club Relationship
ClubRelationship
object
3 requiredclosed object
| Property key | Type | Use | Notes |
|---|---|---|---|
clubKey |
string |
required | No description. |
relationship |
string |
required | No description. |
direction |
string |
required | No description. |
season |
integer | null |
optional | No description. |
label |
string | null |
optional | No description. |
sourceRefs |
SourceRefs
|
optional | No description. |
notes |
string | null |
optional | No description. |
Clubs Map
ClubsMap
object
closed objectpattern keys
Map of canonical club key to club metadata record.
| Property key | Type | Use | Notes |
|---|---|---|---|
^[a-z0-9][a-z0-9 -]*$ |
ClubMetadata
|
optional | Pattern property. |
Club Source Ref
ClubSourceRef
object
2 requiredclosed object
| Property key | Type | Use | Notes |
|---|---|---|---|
type |
string |
required | No description. |
sourceUrl |
string |
required | No description. |
notes |
string | null |
optional | No description. |
Club Status
ClubStatus
object
closed object
Consumer-facing status summary for the club identity.
| Property key | Type | Use | Notes |
|---|---|---|---|
current |
string |
optional | Small lifecycle/status label such as active, historical, defunct, merged, relocated, renamed, phoenix, or unknown. Use status.reason for coverage context such as below-tracked-coverage. |
trackedFromSeason |
integer | null |
optional | No description. |
trackedToSeason |
integer | null |
optional | No description. |
hasUnexplainedGaps |
boolean |
optional | True only when expected tracked membership has unexplained internal absences; ordinary gaps between observed stints are represented separately in derived.coverageGaps. |
reason |
string | null |
optional | No description. |
reasonLabel |
string | null |
optional | No description. |
sourceRefs |
SourceRefs
|
optional | No description. |
Club Tier Seasons
ClubTierSeasons
object
2 requiredclosed object
| Property key | Type | Use | Notes |
|---|---|---|---|
tierKey |
string |
required | No description. |
seasons |
IntegerList
|
required | No description. |
Club Tracked Membership
ClubTrackedMembership
object
1 requiredclosed object
Observed stints inside the supported season dataset, not a claim of continuous real-world club existence.
| Property key | Type | Use | Notes |
|---|---|---|---|
fromSeason |
integer |
required | No description. |
toSeason |
integer | null |
optional | No description. |
tiers |
StringList
|
optional | No description. |
basis |
string | null |
optional | No description. |
notes |
string | null |
optional | No description. |
sourceRefs |
SourceRefs
|
optional | No description. |
Dataset Metadata
DatasetMetadata
object
closed object
Build provenance for the generated club metadata sidecar.
| Property key | Type | Use | Notes |
|---|---|---|---|
schemaVersion |
integer |
optional | No description. |
generator |
string | null |
optional | No description. |
generatedAt |
string | null |
optional | No description. |
gitSha |
string | null |
optional | No description. |
sourceFiles |
StringList
|
optional | No description. |
buildOptions |
object |
optional | No description. |
Integer List
IntegerList
array
No named properties.
Metadata Asset Bundle
MetadataAssetBundle
object
1 requiredclosed object
| Property key | Type | Use | Notes |
|---|---|---|---|
preferred |
string | null |
optional | assetId for the preferred candidate, or null when no candidate is safe to prefer. |
status |
string |
required | Overall bundle status such as usable, placeholder, restricted, needs-review, needs-more-research, or failed. |
candidates |
array |
optional | No description. |
Metadata Asset Candidate
MetadataAssetCandidate
object
4 requiredclosed object
| Property key | Type | Use | Notes |
|---|---|---|---|
assetId |
string |
required | No description. |
kind |
string |
required | No description. |
status |
string |
required | No description. |
priority |
integer | null |
optional | No description. |
source |
string |
required | No description. |
sourceUrl |
string | null |
optional | No description. |
imageUrl |
string | null |
optional | No description. |
pageUrl |
string | null |
optional | No description. |
fileTitle |
string | null |
optional | No description. |
mimeType |
string | null |
optional | No description. |
width |
integer | null |
optional | No description. |
height |
integer | null |
optional | No description. |
license |
MetadataAssetLicense
|
optional | No description. |
colors |
array |
optional | Structured color hints used by generated placeholders or asset consumers. |
placeholder |
boolean |
optional | True when the candidate is a generated placeholder rather than an official or source-discovered asset. |
verification |
MetadataAssetVerification
|
optional | No description. |
notes |
string | null |
optional | No description. |
Metadata Asset Color
MetadataAssetColor
object
2 requiredclosed object
| Property key | Type | Use | Notes |
|---|---|---|---|
role |
string |
required | No description. |
hex |
string |
required | No description. |
Metadata Asset License
MetadataAssetLicense
object
closed object
| Property key | Type | Use | Notes |
|---|---|---|---|
shortName |
string | null |
optional | No description. |
usageTerms |
string | null |
optional | No description. |
licenseUrl |
string | null |
optional | No description. |
copyrighted |
boolean | null |
optional | No description. |
attribution |
string | null |
optional | No description. |
credit |
string | null |
optional | No description. |
artist |
string | null |
optional | No description. |
Metadata Assets
MetadataAssets
object
Visual and media asset candidates for this metadata identity. v1 populates club crest candidates only.
| Property key | Type | Use | Notes |
|---|---|---|---|
crest |
MetadataAssetBundle
|
optional | No description. |
Metadata Asset Verification
MetadataAssetVerification
object
closed object
| Property key | Type | Use | Notes |
|---|---|---|---|
identityMatch |
string | null |
optional | No description. |
licenseCheck |
string | null |
optional | No description. |
httpCheck |
string | null |
optional | No description. |
needsManualReview |
boolean |
optional | No description. |
reviewReasons |
StringList
|
optional | No description. |
checkedAt |
string | null |
optional | No description. |
Source Refs
SourceRefs
array
No named properties.
String List
StringList
array
No named properties.