FirstData/firstdata/schemas/datasource-schema.json at main · MLT-OSS/FirstData · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://firstdata.org/schemas/firstdata-v2.json",
  "title": "FirstData Metadata Schema (Simplified)",
  "description": "Simplified schema for describing authoritative data sources - removes complex nested structures and quality scoring",
  "version": "2.0.0",
  "type": "object",
  "required": [
    "id",
    "name",
    "description",
    "website",
    "data_url",
    "authority_level",
    "domains",
    "tags"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (lowercase, hyphen-separated)",
      "pattern": "^[a-z0-9-]+$",
      "examples": [
        "china-nbs",
        "worldbank-open-data",
        "hkex"
      ]
    },
    "name": {
      "type": "object",
      "description": "Data source name in multiple languages",
      "required": [
        "en"
      ],
      "properties": {
        "en": {
          "type": "string",
          "description": "English name"
        },
        "zh": {
          "type": "string",
          "description": "Chinese name"
        }
      }
    },
    "description": {
      "type": "object",
      "description": "Detailed description of the data source",
      "required": [
        "en"
      ],
      "properties": {
        "en": {
          "type": "string",
          "description": "English description"
        },
        "zh": {
          "type": "string",
          "description": "Chinese description"
        }
      }
    },
    "website": {
      "type": "string",
      "format": "uri",
      "description": "Organization homepage URL (top-level website)"
    },
    "data_url": {
      "type": "string",
      "format": "uri",
      "description": "Direct URL to data access page (not organization homepage - should point to data query/download interface)"
    },
    "api_url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "description": "API documentation or endpoint URL. Set to null if no API is available."
    },
    "authority_level": {
      "type": "string",
      "description": "Authority level of the data source organization",
      "enum": [
        "government",
        "international",
        "market",
        "research",
        "commercial",
        "other"
      ]
    },
    "country": {
      "type": [
        "string",
        "null"
      ],
      "description": "ISO 3166-1 alpha-2 country code. Only use this field when the data source clearly belongs to a specific country AND geographic_scope is 'national' or 'subnational'. MUST be null when geographic_scope is 'global' or 'regional'.",
      "pattern": "^[A-Z]{2}$",
      "examples": [
        "CN",
        "US",
        "HK",
        "JP",
        null
      ]
    },
    "domains": {
      "type": "array",
      "description": "Data domains covered by this source",
      "items": {
        "type": "string",
        "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$"
      },
      "minItems": 1,
      "examples": [
        [
          "finance",
          "economics"
        ],
        [
          "health",
          "social"
        ],
        [
          "environment",
          "climate"
        ]
      ]
    },
    "geographic_scope": {
      "type": "string",
      "description": "Geographic coverage level",
      "enum": [
        "global",
        "regional",
        "national",
        "subnational"
      ]
    },
    "update_frequency": {
      "type": "string",
      "description": "Data update frequency",
      "enum": [
        "real-time",
        "daily",
        "weekly",
        "monthly",
        "quarterly",
        "annual",
        "irregular"
      ]
    },
    "tags": {
      "type": "array",
      "description": "Search tags - mixed Chinese/English keywords, synonyms, data types, and related terms for improved discoverability. Must not contain whitespace; use hyphens for multi-word English phrases (e.g., 'economic-growth' not 'economic growth'). Convention: new ASCII-only entries SHOULD be lowercase (gdp/ipo); mixed CJK+ASCII acronyms (AI产业/3C认证/A股) MUST preserve ASCII case.",
      "items": {
        "type": "string",
        "pattern": "^\\S+$"
      },
      "minItems": 1,
      "examples": [
        [
          "gdp",
          "经济增长",
          "economic-growth"
        ],
        [
          "ipo",
          "招股书",
          "prospectus",
          "上市公司"
        ]
      ]
    },
    "data_content": {
      "type": "object",
      "description": "Detailed descriptions of data categories and content available from this source",
      "properties": {
        "en": {
          "type": "array",
          "description": "English data content descriptions",
          "items": {
            "type": "string"
          }
        },
        "zh": {
          "type": "array",
          "description": "Chinese data content descriptions",
          "items": {
            "type": "string"
          }
        }
      }
    }
  },
  "additionalProperties": false
}