File size: 17,643 Bytes
0077dd0 | 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 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "document_metadata_schema.json",
"title": "Document Metadata Schema",
"description": "Schema for document metadata following the World Bank Metadata Standards for Improved Data Discoverability (Chapter 5 - Documents). Reference: https://worldbank.github.io/schema-guide/chapter05.html",
"type": "object",
"required": ["type", "metadata_information", "document_description"],
"additionalProperties": true,
"properties": {
"type": {
"type": "string",
"description": "Resource type identifier.",
"const": "document"
},
"metadata_information": {
"$ref": "#/$defs/metadata_information"
},
"document_description": {
"$ref": "#/$defs/document_description"
},
"provenance": {
"type": "array",
"description": "Provenance information describing the origin and harvest history of the metadata.",
"items": {
"$ref": "#/$defs/provenance_entry"
}
},
"tags": {
"type": "array",
"description": "Tags for classification and filtering.",
"items": {
"$ref": "#/$defs/tag"
}
},
"schematype": {
"type": "string",
"description": "Schema type identifier.",
"const": "document"
},
"additional": {
"type": "object",
"description": "Additional fields not covered by the core schema. Keys follow the 'additional.<namespace>_<field>' convention. Used for source-specific metadata preservation.",
"additionalProperties": true
}
},
"$defs": {
"metadata_information": {
"type": "object",
"description": "Information about the metadata record itself (who created it, when, etc.).",
"required": ["title", "idno", "producers", "production_date"],
"additionalProperties": false,
"properties": {
"title": {
"type": "string",
"description": "Title of the metadata record."
},
"idno": {
"type": "string",
"description": "Unique identifier for the metadata record."
},
"producers": {
"type": "array",
"description": "Organizations or individuals that produced or contributed to the metadata.",
"items": {
"$ref": "#/$defs/producer"
}
},
"production_date": {
"type": "string",
"description": "Date the metadata was produced. ISO 8601 format: YYYY-MM-DD.",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
"version": {
"type": "string",
"description": "Version or description of the metadata record."
}
}
},
"producer": {
"type": "object",
"description": "An organization or individual that produced metadata.",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Name of the producing organization or individual."
},
"abbr": {
"type": "string",
"description": "Abbreviation of the producer name."
},
"affiliation": {
"type": "string",
"description": "Institutional affiliation of the producer."
},
"role": {
"type": "string",
"description": "Role of the producer (e.g., 'Source', 'Compiler')."
}
}
},
"document_description": {
"type": "object",
"description": "Core descriptive metadata about the document.",
"required": ["title_statement"],
"additionalProperties": false,
"properties": {
"title_statement": {
"$ref": "#/$defs/title_statement"
},
"authors": {
"type": "array",
"description": "List of document authors.",
"items": {
"$ref": "#/$defs/author"
}
},
"date_created": {
"type": "string",
"description": "Date the document was created. ISO 8601 format: YYYY-MM-DD."
},
"date_available": {
"type": "string",
"description": "Date the document was made available. ISO 8601 format: YYYY-MM-DD."
},
"date_modified": {
"type": "string",
"description": "Date the document was last modified. ISO 8601 format: YYYY-MM-DD."
},
"date_published": {
"type": "string",
"description": "Date the document was published. ISO 8601 format: YYYY-MM-DD."
},
"identifiers": {
"type": "array",
"description": "External identifiers (DOI, ISBN, ISSN, etc.).",
"items": {
"$ref": "#/$defs/identifier"
}
},
"type": {
"type": "string",
"description": "Document type (e.g., 'Working Paper', 'Report')."
},
"abstract": {
"type": "string",
"description": "Abstract or summary of the document."
},
"ref_country": {
"type": "array",
"description": "Countries referenced in the document.",
"items": {
"$ref": "#/$defs/country"
}
},
"geographic_units": {
"type": "array",
"description": "Geographic units or regions referenced.",
"items": {
"$ref": "#/$defs/geographic_unit"
}
},
"spatial_coverage": {
"type": "string",
"description": "Free-text description of spatial coverage."
},
"languages": {
"type": "array",
"description": "Languages of the document.",
"items": {
"$ref": "#/$defs/language"
}
},
"volume": {
"type": "string",
"description": "Volume number."
},
"number": {
"type": "string",
"description": "Issue or report number."
},
"series": {
"type": "string",
"description": "Series or collection name."
},
"publisher_address": {
"type": "string",
"description": "Publisher address or place of production."
},
"organization": {
"type": "string",
"description": "Publishing or sponsoring organization."
},
"url": {
"type": "string",
"description": "URL to the document."
},
"keywords": {
"type": "array",
"description": "Keywords associated with the document.",
"items": {
"$ref": "#/$defs/keyword"
}
},
"themes": {
"type": "array",
"description": "Thematic classifications.",
"items": {
"$ref": "#/$defs/theme"
}
},
"topics": {
"type": "array",
"description": "Topic classifications.",
"items": {
"$ref": "#/$defs/topic"
}
},
"relations": {
"type": "array",
"description": "Related resources (alternate formats, parent collections).",
"items": {
"$ref": "#/$defs/relation"
}
},
"security_classification": {
"type": "string",
"description": "Security classification level."
},
"access_restrictions": {
"type": "string",
"description": "Access restrictions or disclosure status."
},
"edition": {
"type": "string",
"description": "Edition or version type."
},
"contacts": {
"type": "array",
"description": "Contact information for inquiries.",
"items": {
"$ref": "#/$defs/contact"
}
},
"usage_terms": {
"type": "string",
"description": "Terms of use for the document."
},
"notes": {
"type": "array",
"description": "Additional notes about the document.",
"items": {
"$ref": "#/$defs/note"
}
},
"disclaimer": {
"type": "string",
"description": "Disclaimer text associated with the document."
},
"pricing": {
"type": "string",
"description": "Pricing or availability information."
},
"reproducibility": {
"$ref": "#/$defs/reproducibility"
}
}
},
"title_statement": {
"type": "object",
"description": "Title information for the document.",
"additionalProperties": false,
"properties": {
"idno": {
"type": "string",
"description": "Document identifier."
},
"title": {
"type": "string",
"description": "Primary title of the document."
},
"sub_title": {
"type": "string",
"description": "Subtitle of the document."
},
"alternate_title": {
"type": "string",
"description": "Alternate title."
},
"translated_title": {
"type": "string",
"description": "Translated title."
}
}
},
"author": {
"type": "object",
"description": "Document author information.",
"additionalProperties": false,
"properties": {
"first_name": {
"type": "string",
"description": "Author's first name."
},
"initial": {
"type": "string",
"description": "Author's middle initial."
},
"last_name": {
"type": "string",
"description": "Author's last name."
},
"affiliation": {
"type": "string",
"description": "Author's institutional affiliation."
},
"full_name": {
"type": "string",
"description": "Author's full name (used when individual name parts are unavailable)."
}
}
},
"identifier": {
"type": "object",
"description": "External identifier for the document.",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"description": "Identifier type (e.g., 'DOI', 'ISBN', 'ISSN')."
},
"identifier": {
"type": "string",
"description": "Identifier value."
}
}
},
"country": {
"type": "object",
"description": "Country reference.",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Country name."
},
"code": {
"type": "string",
"description": "ISO 3166-1 alpha-3 country code."
}
}
},
"geographic_unit": {
"type": "object",
"description": "Geographic unit or region.",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Name of the geographic unit."
},
"code": {
"type": "string",
"description": "Code for the geographic unit."
},
"type": {
"type": "string",
"description": "Type of geographic unit (e.g., 'region')."
}
}
},
"language": {
"type": "object",
"description": "Language information.",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Language name (e.g., 'English')."
},
"code": {
"type": "string",
"description": "ISO 639 language code (e.g., 'en')."
}
}
},
"keyword": {
"type": "object",
"description": "Keyword entry.",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "Keyword identifier."
},
"name": {
"type": "string",
"description": "Keyword text."
},
"vocabulary": {
"type": "string",
"description": "Source vocabulary or controlled list."
},
"uri": {
"type": "string",
"description": "URI for the keyword in its vocabulary."
}
}
},
"theme": {
"type": "object",
"description": "Thematic classification entry.",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "Theme identifier."
},
"name": {
"type": "string",
"description": "Theme name."
},
"parent_id": {
"type": "string",
"description": "Parent theme identifier (for hierarchical themes)."
},
"vocabulary": {
"type": "string",
"description": "Source vocabulary (e.g., 'World Bank - theme')."
},
"uri": {
"type": "string",
"description": "URI for the theme."
}
}
},
"topic": {
"type": "object",
"description": "Topic classification entry.",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "Topic identifier."
},
"name": {
"type": "string",
"description": "Topic name."
},
"parent_id": {
"type": "string",
"description": "Parent topic identifier."
},
"vocabulary": {
"type": "string",
"description": "Source vocabulary."
},
"uri": {
"type": "string",
"description": "URI for the topic."
}
}
},
"relation": {
"type": "object",
"description": "Related resource entry.",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Name or URL of the related resource."
},
"type": {
"type": "string",
"description": "Relationship type (e.g., 'hasFormat', 'isPartOf')."
}
}
},
"contact": {
"type": "object",
"description": "Contact information.",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Contact name."
},
"affiliation": {
"type": "string",
"description": "Contact's institutional affiliation."
},
"email": {
"type": "string",
"description": "Contact email address."
},
"uri": {
"type": "string",
"description": "Contact URI or URL."
}
}
},
"note": {
"type": "object",
"description": "A free-text note.",
"additionalProperties": false,
"properties": {
"note": {
"type": "string",
"description": "Note text."
}
}
},
"tag": {
"type": "object",
"description": "A tag entry for classification.",
"additionalProperties": false,
"properties": {
"tag": {
"type": "string",
"description": "Tag value."
},
"tag_group": {
"type": "string",
"description": "Tag group or category."
}
}
},
"provenance_entry": {
"type": "object",
"description": "A provenance record.",
"additionalProperties": false,
"properties": {
"origin_description": {
"$ref": "#/$defs/origin_description"
}
}
},
"origin_description": {
"type": "object",
"description": "Description of the metadata's origin and harvest details.",
"additionalProperties": false,
"properties": {
"harvest_date": {
"type": "string",
"description": "Date/time the metadata was harvested. ISO 8601 format."
},
"altered": {
"type": "boolean",
"description": "Whether the metadata was altered after harvest."
},
"base_url": {
"type": "string",
"description": "Base URL of the metadata source."
},
"identifier": {
"type": "string",
"description": "Identifier for the source record."
},
"date_stamp": {
"type": "string",
"description": "Timestamp of the source record. ISO 8601 format."
},
"metadata_namespace": {
"type": "string",
"description": "Namespace identifier for the metadata source."
}
}
},
"reproducibility": {
"type": "object",
"description": "Reproducibility information for the document.",
"additionalProperties": false,
"properties": {
"statement": {
"type": "string",
"description": "Reproducibility statement."
},
"links": {
"type": "array",
"description": "Links to reproducibility resources (code, data).",
"items": {
"$ref": "#/$defs/reproducibility_link"
}
}
}
},
"reproducibility_link": {
"type": "object",
"description": "A link to a reproducibility resource.",
"additionalProperties": false,
"properties": {
"uri": {
"type": "string",
"description": "URI of the reproducibility resource."
},
"description": {
"type": "string",
"description": "Description of the linked resource."
}
}
}
}
}
|