schema.json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v2/v21/schema.json",
  "description": "Open Energy Metadata (OEMetadata) - metadata schema",
  "type": "object",
  "required": [
    "resources"
  ],
  "properties": {
    "@context": {
      "description": "Explanation of metadata keys in ontology terms.",
      "examples": [
        "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/latest/context.json"
      ],
      "type": [
        "string",
        "null"
      ],
      "badge": "Platinum",
      "title": "@context",
      "readOnly": true
    },
    "@id": {
      "description": "A unique identifier (UUID/DOI) for the collection.",
      "type": [
        "string",
        "null"
      ],
      "examples": [
        "https://databus.openenergyplatform.org/oeplatform/supply/wri_global_power_plant_database/"
      ],
      "badge": "Platinum",
      "title": "Dataset Identifier",
      "format": "uri",
      "readOnly": true
    },
    "name": {
      "description": "A filename or database conform dataset name.",
      "type": [
        "string",
        "null"
      ],
      "examples": [
        "oep_oemetadata"
      ],
      "badge": "Iron",
      "title": "Dataset Name"
    },
    "title": {
      "description": "A human readable dataset name.",
      "type": [
        "string",
        "null"
      ],
      "examples": [
        "OEP OEMetadata Dataset"
      ],
      "badge": "Bronze",
      "title": "Dataset Title"
    },
    "description": {
      "description": "A free text description of the dataset.",
      "type": [
        "string",
        "null"
      ],
      "examples": [
        "A dataset for the OEMetadata examples."
      ],
      "badge": "Bronze",
      "title": "Dataset Description"
    },
    "extent": {
      "description": "An object that describes a covered area or region of the dataset.",
      "type": "object",
      "properties": {
        "name": {
          "description": "The name of the spatial region of the dataset.",
          "type": [
            "string",
            "null"
          ],
          "examples": [
            "Europe"
          ],
          "badge": "Silver",
          "title": "Dataset Extent Name"
        },
        "@id": {
          "description": "A URI reference for the region of the dataset.",
          "type": [
            "string",
            "null"
          ],
          "examples": [
            "https://www.wikidata.org/wiki/Q458"
          ],
          "format": "uri",
          "badge": "Platinum",
          "title": "Dataset Extent Identifier"
        }
      }
    },
    "referenceDate": {
      "description": "A base year, month or day. The time for which the dataset should be accurate. Date Format is ISO 8601.",
      "type": [
        "string",
        "null"
      ],
      "examples": [
        "2020-01-01"
      ],
      "badge": "Silver",
      "title": "Dataset Reference Date",
      "format": "date"
    },
    "languages": {
      "description": "An array of languages used within the described data structures (e.g. titles, descriptions) or metadata.",
      "type": "array",
      "items": {
        "description": "The language keys must follow the Standard IETF (BCP47) and can be repeated if more languages are used.",
        "type": [
          "string",
          "null"
        ],
        "examples": [
          "en-GB",
          "de-DE"
        ],
        "badge": "Gold",
        "title": "Language"
      },
      "badge": "Gold",
      "title": "Languages"
    },
    "version": {
      "description": "A version string identifying the version of the package.",
      "type": [
        "string",
        "null"
      ],
      "examples": [
        "0.1.0"
      ],
      "badge": "Silver",
      "title": "Dataset Version"
    },
    "image": {
      "description": "An image to use for this data package",
      "type": [
        "string",
        "null"
      ],
      "examples": [
        "https://openenergyplatform.org/static/img/about/OpenEnergyFamily_GroupPhoto2.png"
      ],
      "badge": "Gold",
      "title": "Image"
    },
    "subject": {
      "description": "An array of objects that references to the subjects of the resource in ontology terms.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "description": "A class label of the ontology term.",
            "type": [
              "string",
              "null"
            ],
            "examples": [
              "energy"
            ],
            "badge": "Platinum",
            "title": "Subject Name"
          },
          "@id": {
            "description": "A unique identifier (URI/IRI) of the ontology class.",
            "type": [
              "string",
              "null"
            ],
            "examples": [
              "https://openenergyplatform.org/ontology/oeo/OEO_00000150"
            ],
            "badge": "Platinum",
            "title": "Subject Identifier",
            "format": "uri"
          }
        },
        "badge": "Platinum",
        "title": "Subject"
      },
      "badge": "Platinum",
      "title": "Subject"
    },
    "keywords": {
      "description": "An array of freely selectable keywords that help with searching and structuring.",
      "type": "array",
      "items": {
        "description": "The keyword are used and managed in the OEP as table tags.",
        "type": [
          "string",
          "null"
        ],
        "examples": [
          "example",
          "ODbL-1.0",
          "NFDI4Energy"
        ],
        "badge": "Silver",
        "title": "Keyword"
      },
      "badge": "Silver",
      "title": "Keywords"
    },
    "projectContext": {
      "description": "An Object that describes the general setting, environment or project leading to the creation or maintenance of this dataset. In science this can be the research project.",
      "type": "object",
      "properties": {
        "title": {
          "description": "A title of the associated project.",
          "type": [
            "string",
            "null"
          ],
          "examples": [
            "NFDI4Energy"
          ],
          "badge": "Gold",
          "title": "Context Title"
        },
        "homepage": {
          "description": "A URL of the project.",
          "type": [
            "string",
            "null"
          ],
          "examples": [
            "https://nfdi4energy.uol.de/"
          ],
          "badge": "Gold",
          "title": "Homepage",
          "format": "uri"
        },
        "documentation": {
          "description": "A URL of the project documentation.",
          "type": [
            "string",
            "null"
          ],
          "examples": [
            "https://nfdi4energy.uol.de/sites/about_us/"
          ],
          "badge": "Gold",
          "title": "Documentation"
        },
        "sourceCode": {
          "description": "A URL of the source code of the project.",
          "type": [
            "string",
            "null"
          ],
          "examples": [
            "https://github.com/NFDI4Energy"
          ],
          "badge": "Gold",
          "title": "Source Code"
        },
        "publisher": {
          "description": "The publishing agency of the data. This can be the OEP.",
          "type": [
            "string",
            "null"
          ],
          "examples": [
            "Open Energy Platform (OEP)"
          ],
          "badge": "Bronze",
          "title": "Publisher"
        },
        "publisherLogo": {
          "description": "A URL to the logo of the publishing agency of data.",
          "type": [
            "string",
            "null"
          ],
          "examples": [
            "https://github.com/OpenEnergyPlatform/organisation/blob/production/logo/OpenEnergyFamily_Logo_OpenEnergyPlatform.svg"
          ],
          "badge": "Gold",
          "title": "Publisher Logo",
          "format": "uri"
        },
        "contact": {
          "description": "A reference to the creator or maintainer of the data set. This can be an email address or a GitHub handle.",
          "type": [
            "string",
            "null"
          ],
          "examples": [
            "contact@example.com"
          ],
          "badge": "Gold",
          "title": "E-Mail Contact",
          "format": "email"
        },
        "fundingAgency": {
          "description": "A name of the entity providing the funding. This can be a government agency or a company.",
          "type": [
            "string",
            "null"
          ],
          "examples": [
            " Deutsche Forschungsgemeinschaft (DFG)"
          ],
          "badge": "Gold",
          "title": "Funding Agency"
        },
        "fundingAgencyLogo": {
          "description": "A URL to the logo or image of the funding agency.",
          "type": [
            "string",
            "null"
          ],
          "examples": [
            "https://upload.wikimedia.org/wikipedia/commons/8/86/DFG-logo-blau.svg"
          ],
          "badge": "Gold",
          "title": "Funding Agency Logo",
          "format": "uri"
        },
        "grantNo": {
          "description": "An identifying grant number. In case of a publicly funded project, this number is assigned by the funding agency.",
          "type": [
            "string",
            "null"
          ],
          "examples": [
            "501865131"
          ],
          "badge": "Gold",
          "title": "Grant Number"
        }
      },
      "badge": "Gold",
      "title": "Context"
    },
    "contributors": {
      "description": "An array of objects of contributors and contributions to the data or metadata.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "description": "A full name of the contributor.",
            "type": [
              "string",
              "null"
            ],
            "examples": [
              "Ludwig Hülk"
            ],
            "badge": "Bronze",
            "title": "Contributor Title"
          },
          "path": {
            "description": "A qualified link or path pointing to a relevant location online for the contributor. This can be the GitHub page or ORCID.",
            "type": [
              "string",
              "null"
            ],
            "examples": [
              "https://github.com/Ludee"
            ],
            "badge": "Bronze",
            "title": "Path"
          },
          "organization": {
            "description": "A string describing the organization this contributor is affiliated to. This can be relevant for the copyright.",
            "type": [
              "string",
              "null"
            ],
            "examples": [
              "Reiner Lemoine Institut"
            ],
            "badge": "Bronze",
            "title": "Organization"
          },
          "roles": {
            "description": "An array describing the roles of the contributor.",
            "type": "array",
            "items": {
              "description": "A role is recommended to follow an established vocabulary: DataCite Metadata Schema’s contributorRole. Useful roles to indicate are: DataCollector, ContactPerson, and DataCurator.",
              "type": [
                "string",
                "null"
              ],
              "examples": [
                "DataCollector",
                "DataCurator"
              ],
              "badge": "Bronze",
              "title": "Role"
            },
            "badge": "Bronze",
            "title": "Roles"
          },
          "date": {
            "description": "The date of the contribution. Date Format is ISO 8601.",
            "type": [
              "string",
              "null"
            ],
            "examples": [
              "2024-10-21"
            ],
            "badge": "Bronze",
            "title": "Date",
            "format": "date"
          },
          "object": {
            "description": "The object of the contribution. Which part of the package was supplied or changed.",
            "type": [
              "string",
              "null"
            ],
            "examples": [
              "dataset, data, metadata"
            ],
            "badge": "Bronze",
            "title": "Object"
          },
          "comment": {
            "description": "A free-text commentary on what has been done.",
            "type": [
              "string",
              "null"
            ],
            "examples": [
              "Add metadata example."
            ],
            "badge": "Bronze",
            "title": "Comment"
          }
        },
        "required": [
          "title"
        ],
        "badge": "Bronze",
        "title": "Contributor"
      }
    },
    "moduleEnergySystems": {
      "description": "An Object that describes the main concepts of an energy system.",
      "type": "object",
      "properties": {
        "supplyTechnologies": {
          "description": "A supply technology describes how specific technical components and processes are combined to generate or provide energy.",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "description": "A class label of the ontology term.",
                "type": [
                  "string",
                  "null"
                ],
                "examples": [
                  "energy transformation"
                ],
                "badge": "Module",
                "title": "Supply Technologies Subject Name"
              },
              "@id": {
                "description": "A unique identifier (URI/IRI) of the ontology class.",
                "type": [
                  "string",
                  "null"
                ],
                "examples": [
                  "https://openenergyplatform.org/ontology/oeo/OEO_00020003"
                ],
                "badge": "Module",
                "title": "Supply Technologies Subject Identifier",
                "format": "uri"
              }
            },
            "badge": "Module",
            "title": "Supply Technologies Subject"
          },
          "badge": "Module",
          "title": "Supply Technologies"
        },
        "storageTechnologies": {
          "description": "An energy storage technology describes how energy storage components and energy carriers are combined to charge, store, and discharge energy for temporary use.",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "description": "A class label of the ontology term.",
                "type": [
                  "string",
                  "null"
                ],
                "examples": [
                  "energy storage technology"
                ],
                "badge": "Module",
                "title": "Storage Technologies Subject Name"
              },
              "@id": {
                "description": "A unique identifier (URI/IRI) of the ontology class.",
                "type": [
                  "string",
                  "null"
                ],
                "examples": [
                  "https://openenergyplatform.org/ontology/oeo/OEO_00020366"
                ],
                "badge": "Module",
                "title": "Storage Technologies Subject Identifier",
                "format": "uri"
              }
            },
            "badge": "Module",
            "title": "Storage Technologies Subject"
          },
          "badge": "Module",
          "title": "Storage Technologies"
        },
        "supplyGrid": {
          "description": "A supply grid is a system of interconnected technical components that together enable the distribution and delivery of energy.",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "description": "A class label of the ontology term.",
                "type": [
                  "string",
                  "null"
                ],
                "examples": [
                  "supply grid"
                ],
                "badge": "Module",
                "title": "Supply Grid Subject Name"
              },
              "@id": {
                "description": "A unique identifier (URI/IRI) of the ontology class.",
                "type": [
                  "string",
                  "null"
                ],
                "examples": [
                  "https://openenergyplatform.org/ontology/oeo/OEO_00000200"
                ],
                "badge": "Module",
                "title": "Supply Grid Subject Identifier",
                "format": "uri"
              }
            },
            "badge": "Module",
            "title": "Supply Grid Subject"
          },
          "badge": "Module",
          "title": "Supply Grid"
        },
        "finalEnergyCarrier": {
          "description": "A final energy carrier is an energy carrier that is delivered to and directly used by end users without further transformation.",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "description": "A class label of the ontology term.",
                "type": [
                  "string",
                  "null"
                ],
                "examples": [
                  "final energy carrier"
                ],
                "badge": "Module",
                "title": "Final Energy Carrier Subject Name"
              },
              "@id": {
                "description": "A unique identifier (URI/IRI) of the ontology class.",
                "type": [
                  "string",
                  "null"
                ],
                "examples": [
                  "https://openenergyplatform.org/ontology/oeo/OEO_00140080"
                ],
                "badge": "Module",
                "title": "Final Energy Carrier Subject Identifier",
                "format": "uri"
              }
            },
            "badge": "Module",
            "title": "Final Energy Carrier Subject"
          },
          "badge": "Module",
          "title": "Final Energy Carrier"
        },
        "demandSectors": {
          "description": "An energy demand sector is a sector of the energy system that groups together energy consumers with similar usage characteristics.",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "description": "A class label of the ontology term.",
                "type": [
                  "string",
                  "null"
                ],
                "examples": [
                  "energy demand sector"
                ],
                "badge": "Module",
                "title": "Demand Sectors Subject Name"
              },
              "@id": {
                "description": "A unique identifier (URI/IRI) of the ontology class.",
                "type": [
                  "string",
                  "null"
                ],
                "examples": [
                  "https://openenergyplatform.org/ontology/oeo/OEO_00000128"
                ],
                "badge": "Module",
                "title": "Demand Sectors Subject Identifier",
                "format": "uri"
              }
            },
            "badge": "Module",
            "title": "Demand Sectors Subject"
          },
          "badge": "Module",
          "title": "Demand Sectors"
        },
        "moduleDescription": {
          "description": "A description of the module. It should be usable as summary information for the module that is described by the metadata.",
          "type": [
            "string",
            "null"
          ],
          "examples": [
            "Example module for an energy system dataset"
          ],
          "badge": "Module",
          "title": "Energy Systems Module Description"
        }
      },
      "badge": "Module",
      "title": "Energy Systems Module"
    },
    "moduleMeasurementData": {
      "description": "An Object that describes the instruments used in the measurement.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "instrumentIdentifier": {
            "description": "Unique string that identifies the instrument instance.",
            "type": [
              "string",
              "null"
            ],
            "examples": [
              "http://hdl.handle.net/21.11157/a9250866-bbec-4542-86b3-a5f78c0c6922"
            ],
            "badge": "Module",
            "title": "Instrument Identifier"
          },
          "instrumentPath": {
            "description": "A landing page that the identifier resolves to.",
            "type": [
              "string",
              "null"
            ],
            "examples": [
              "https://sms.atmohub.kit.edu/devices/961"
            ],
            "badge": "Module",
            "title": "Instrument Path",
            "format": "uri"
          },
          "instrumentName": {
            "description": "Name by which the instrument instance is known.",
            "type": [
              "string",
              "null"
            ],
            "examples": [
              "MFC_001000_02 - Merck KGaA - FC-2926V - DH9806004"
            ],
            "badge": "Module",
            "title": "Instrument Name"
          },
          "instrumentOwner": {
            "description": "Institution(s) responsible for the management of the instrument. This may include the legal owner, the operator, or an institute providing access to the instrument.",
            "type": [
              "string",
              "null"
            ],
            "examples": [
              "Karlsruhe Institute of Technology (KIT)"
            ],
            "badge": "Module",
            "title": "Instrument Owner"
          },
          "manufacturerName": {
            "description": "Full name of the manufacturer.",
            "type": [
              "string",
              "null"
            ],
            "examples": [
              "Merck KGaA"
            ],
            "badge": "Module",
            "title": "Manufacturer Name"
          },
          "moduleDescription": {
            "description": "A description of the module. It should be usable as summary information for the module that is described by the metadata.",
            "type": "string",
            "examples": [
              "Example instrument of PIDINST schema."
            ],
            "badge": "Module",
            "title": "Module Description"
          }
        },
        "badge": "Module",
        "title": "Instrument"
      },
      "badge": "Module",
      "title": "Measurement Data Module"
    },
    "datasetLicenses": {
      "description": "An array of objects of licenses under which the described data is provided.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "description": "The SPDX identifier.",
            "type": [
              "string",
              "null"
            ],
            "examples": [
              "ODbL-1.0"
            ],
            "badge": "Bronze",
            "title": "Name"
          },
          "title": {
            "description": "The official (human readable) title of the license.",
            "type": [
              "string",
              "null"
            ],
            "examples": [
              "Open Data Commons Open Database License 1.0"
            ],
            "badge": "Bronze",
            "title": "Title"
          },
          "path": {
            "description": "A link or path to the license text.",
            "type": [
              "string",
              "null"
            ],
            "examples": [
              "https://opendatacommons.org/licenses/odbl/1-0/index.html"
            ],
            "badge": "Bronze",
            "title": "Path",
            "format": "uri"
          },
          "instruction": {
            "description": "A short description of rights and obligations. The use of tl;drLegal is recommended.",
            "type": [
              "string",
              "null"
            ],
            "examples": [
              "You are free to share and change, but you must attribute, and share derivations under the same license. See https://tldrlegal.com/license/odc-open-database-license-(odbl) for further information."
            ],
            "badge": "Bronze",
            "title": "Instruction"
          },
          "attribution": {
            "description": "A copyright holder of the data. Must be provided if attribution licenses are used.",
            "type": [
              "string",
              "null"
            ],
            "examples": [
              "© Reiner Lemoine Institut"
            ],
            "badge": "Bronze",
            "title": "Attribution"
          },
          "copyrightStatement": {
            "description": "A link or path that proves that the source or data has the appropriate license. This can be a page number or website imprint.",
            "type": [
              "string",
              "null"
            ],
            "examples": [
              "https://github.com/OpenEnergyPlatform/oemetadata/blob/production/LICENSE.txt"
            ],
            "badge": "Bronze",
            "title": "Copyright Statement"
          }
        },
        "badge": "Bronze",
        "title": "Dataset License"
      },
      "badge": "Bronze",
      "title": "Dataset Licenses"
    },
    "review": {
      "description": "The metadata on the OEP can go through an open peer review process. See the Academy course [Open Peer Review](https://openenergyplatform.github.io/academy/courses/09_peer_review/) for further information.",
      "type": "object",
      "properties": {
        "path": {
          "description": "A link or path to the documented open peer review.",
          "type": [
            "string",
            "null"
          ],
          "examples": [
            "https://openenergyplatform.org/database/"
          ],
          "badge": null,
          "title": "Path",
          "format": "uri"
        },
        "badge": {
          "description": "A badge of either Iron, Bronze, Silver, Gold or Platinum is used to label the quality of the metadata.",
          "type": [
            "string",
            "null"
          ],
          "examples": [
            "Platinum"
          ],
          "badge": null,
          "title": "Badge"
        }
      },
      "title": "Review",
      "options": {
        "hidden": true
      }
    },
    "resources": {
      "description": "A collection of related resources.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "@id": {
            "description": "A Uniform Resource Identifier (URI) that links the resource via the OpenEnergyDatabus (DBpedia Databus).",
            "type": [
              "string",
              "null"
            ],
            "examples": [
              "https://databus.openenergyplatform.org/oeplatform/supply/wri_global_power_plant_database/2022-11-07/wri_global_power_plant_database_variant=data.csv"
            ],
            "badge": "Platinum",
            "title": "@Id",
            "readOnly": true
          },
          "path": {
            "description": "A unique identifier (URI/UUID/DOI) for the table or file.",
            "type": [
              "string",
              "null"
            ],
            "examples": [
              "example.csv"
            ],
            "badge": "Bronze",
            "title": "Path",
            "readOnly": true
          },
          "name": {
            "description": "A filename or database conform table name.",
            "type": [
              "string",
              "null"
            ],
            "examples": [
              "oemetadata_table_example"
            ],
            "badge": "Iron",
            "title": "Name"
          },
          "title": {
            "description": "A human readable resource or table name.",
            "type": [
              "string",
              "null"
            ],
            "examples": [
              "OEMetadata Table Example"
            ],
            "badge": "Silver",
            "title": "Title"
          },
          "description": {
            "description": "A description of the table. It should be usable as summary information for the table that is described by the metadata.",
            "type": [
              "string",
              "null"
            ],
            "examples": [
              "Example metadata and table used to illustrate the OEMetadata structure and features."
            ],
            "badge": "Silver",
            "title": "Description"
          },
          "publicationDate": {
            "description": "A date of publication of the data or metadata. The date format is ISO 8601 (YYYY-MM-DD).",
            "type": [
              "string",
              "null"
            ],
            "examples": [
              "2024-10-15"
            ],
            "badge": "Bronze",
            "title": "Publication Date",
            "format": "date"
          },
          "topics": {
            "description": "An array of predefined topics that correspond to the database schemas of the OEP.",
            "type": "array",
            "items": {
              "description": "The topics are used to group the data in the database.",
              "type": [
                "string",
                "null"
              ],
              "examples": [
                "model_draft"
              ],
              "badge": "Bronze",
              "title": "Topic"
            },
            "badge": "Bronze",
            "title": "Topics"
          },
          "subject": {
            "description": "An array of objects that references to the subjects of the resource in ontology terms.",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "description": "A class label of the ontology term.",
                  "type": [
                    "string",
                    "null"
                  ],
                  "examples": [
                    "energy"
                  ],
                  "badge": "Platinum",
                  "title": "Subject Name"
                },
                "@id": {
                  "description": "A unique identifier (URI/IRI) of the ontology class.",
                  "type": [
                    "string",
                    "null"
                  ],
                  "examples": [
                    "https://openenergyplatform.org/ontology/oeo/OEO_00000150"
                  ],
                  "badge": "Platinum",
                  "title": "Subject Identifier",
                  "format": "uri"
                }
              },
              "badge": "Platinum",
              "title": "Subject"
            },
            "badge": "Platinum",
            "title": "Subject"
          },
          "keywords": {
            "description": "An array of freely selectable keywords that help with searching and structuring.",
            "type": "array",
            "items": {
              "description": "The keyword are used and managed in the OEP as table tags.",
              "type": [
                "string",
                "null"
              ],
              "examples": [
                "example",
                "ODbL-1.0",
                "NFDI4Energy"
              ],
              "badge": "Silver",
              "title": "Keyword"
            },
            "badge": "Silver",
            "title": "Keywords"
          },
          "embargoPeriod": {
            "description": "An object that describes the embargo period during which public access to the data is not allowed.",
            "type": "object",
            "properties": {
              "start": {
                "description": "The start date of the embargo period. The date of the data (metadata) upload.",
                "type": [
                  "string",
                  "null"
                ],
                "examples": [
                  "2024-10-11"
                ],
                "badge": "Bronze",
                "title": "Embargo Period Start",
                "format": "date"
              },
              "end": {
                "description": "The end date of the embargo period. This is the intended publication date.",
                "type": [
                  "string",
                  "null"
                ],
                "examples": [
                  "2025-01-01"
                ],
                "badge": "Bronze",
                "title": "Embargo Period End (Publication Date)",
                "format": "date"
              },
              "isActive": {
                "description": "A boolean key that indicates if the embargo period is currently active. Must be changed to False on the embargo period end date.",
                "type": [
                  "boolean",
                  "null"
                ],
                "examples": [
                  true
                ],
                "badge": "Bronze",
                "title": "Embargo Period is Active "
              }
            },
            "badge": "Bronze",
            "title": "Embargo Period"
          },
          "spatial": {
            "description": "An object that describes the spatial context of the data.",
            "type": "object",
            "properties": {
              "location": {
                "description": "An object that describes a covered area or region.",
                "type": "object",
                "properties": {
                  "address": {
                    "description": "An address of the location of the data. May be specified with street name, house number, zip code, and city name.",
                    "type": [
                      "string",
                      "null"
                    ],
                    "examples": [
                      "Rudower Chaussee 12, 12489 Berlin"
                    ],
                    "badge": "Silver",
                    "title": "Address"
                  },
                  "@id": {
                    "description": "A path or URI to a specific location. It can use Wikidata or OpenStreetMap.",
                    "type": [
                      "string",
                      "null"
                    ],
                    "examples": [
                      "https://www.wikidata.org/wiki/Q77077223"
                    ],
                    "badge": "Platinum",
                    "title": "Address Identifier"
                  },
                  "latitude": {
                    "description": "The latitude (lat) information of the location. Specifies the north / south position of the geometry.",
                    "type": [
                      "string",
                      "null"
                    ],
                    "examples": [
                      "52.432822"
                    ],
                    "badge": "Gold",
                    "title": "Latitude"
                  },
                  "longitude": {
                    "description": "The longitude (lon) information of the location. Specifies the east / west position of the geometry.",
                    "type": [
                      "string",
                      "null"
                    ],
                    "examples": [
                      "13.5351004"
                    ],
                    "badge": "Gold",
                    "title": "Longitude"
                  }
                },
                "badge": "Silver",
                "title": "Location"
              },
              "extent": {
                "description": "An object that describes a covered area or region.",
                "type": "object",
                "properties": {
                  "name": {
                    "description": "The name of the region.",
                    "type": [
                      "string",
                      "null"
                    ],
                    "examples": [
                      "Berlin"
                    ],
                    "badge": "Silver",
                    "title": "Extent Name"
                  },
                  "@id": {
                    "description": "A URI reference for the region.",
                    "type": [
                      "string",
                      "null"
                    ],
                    "examples": [
                      "https://www.wikidata.org/wiki/Q64"
                    ],
                    "format": "uri",
                    "badge": "Platinum",
                    "title": "Extent Identifier"
                  },
                  "resolutionValue": {
                    "description": "The value of the spatial resolution.",
                    "type": [
                      "string",
                      "null"
                    ],
                    "examples": [
                      "100"
                    ],
                    "badge": "Silver",
                    "title": "Spatial Resolution Value"
                  },
                  "resolutionUnit": {
                    "description": "The unit of the spatial resolution.",
                    "type": [
                      "string",
                      "null"
                    ],
                    "examples": [
                      "m"
                    ],
                    "badge": "Silver",
                    "title": "Spatial Resolution Unit"
                  },
                  "boundingBox": {
                    "description": "The covered area specified by the coordinates of a bounding box. The format is [minLon, minLat, maxLon, maxLat] or [W,S,E,N].",
                    "type": "array",
                    "examples": [
                      13.08825,
                      52.33859,
                      13.76104,
                      52.6754
                    ],
                    "items": {
                      "type": "number"
                    },
                    "minItems": 4,
                    "maxItems": 4,
                    "badge": "Gold",
                    "title": "Bounding Box"
                  },
                  "crs": {
                    "description": "The Coordinate Reference System, specified as an EPSG code.",
                    "type": [
                      "string",
                      "null"
                    ],
                    "examples": [
                      "EPSG:4326"
                    ],
                    "badge": "Gold",
                    "title": " Coordinate Reference System (CRS)"
                  }
                },
                "badge": "Silver",
                "title": "Extent"
              }
            },
            "badge": "Silver",
            "title": "Spatial"
          },
          "temporal": {
            "description": "An object with the time period covered in the data. Temporal information should contain a \"referenceDate\" or the keys that describe a time series, or both.",
            "type": "object",
            "properties": {
              "referenceDate": {
                "description": "A base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601.",
                "type": [
                  "string",
                  "null"
                ],
                "examples": [
                  "2020-01-01"
                ],
                "badge": "Silver",
                "title": "Reference Date",
                "format": "date"
              },
              "timeseries": {
                "description": "An array that describe the timeseries.",
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "start": {
                      "description": "The start time of a time series.",
                      "type": [
                        "string",
                        "null"
                      ],
                      "examples": [
                        "2020-01-01T00:00:00+01:00"
                      ],
                      "badge": "Silver",
                      "title": "Timeseries Start",
                      "format": "date-time"
                    },
                    "end": {
                      "description": "The temporal end point of a time series.",
                      "type": [
                        "string",
                        "null"
                      ],
                      "examples": [
                        "2020-01-01T23:59:30+01:00"
                      ],
                      "badge": "Silver",
                      "title": "Timeseries End",
                      "format": "date-time"
                    },
                    "resolutionValue": {
                      "description": "The time span between individual information points in a time series. The value of the resolution.",
                      "type": [
                        "string",
                        "null"
                      ],
                      "examples": [
                        "15"
                      ],
                      "badge": "Silver",
                      "title": "Timeseries Resolution Value"
                    },
                    "resolutionUnit": {
                      "description": "The unit of the temporal resolution.",
                      "type": [
                        "string",
                        "null"
                      ],
                      "examples": [
                        "min"
                      ],
                      "badge": "Silver",
                      "title": "Timeseries Resolution Unit"
                    },
                    "alignment": {
                      "description": "An indicator of whether timestamps in a time series are to the left, right or in the centre.",
                      "type": [
                        "string",
                        "null"
                      ],
                      "examples": [
                        "left"
                      ],
                      "badge": "Gold",
                      "title": "Timeseries Alignment"
                    },
                    "aggregationType": {
                      "description": "An indicator of whether the values are a sum, an average or a current value.",
                      "type": [
                        "string",
                        "null"
                      ],
                      "examples": [
                        "current"
                      ],
                      "badge": "Gold",
                      "title": "Timeseries Aggregation Type"
                    }
                  },
                  "badge": "Silver",
                  "title": "Timeseries"
                },
                "badge": "Silver",
                "title": "Timeseries"
              }
            },
            "badge": "Silver",
            "title": "Temporal"
          },
          "sources": {
            "description": "An array of objects with the used and underlying sources of the data and metadata.",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "title": {
                  "description": "A human readable title of the source, a document title or organisation name.",
                  "type": [
                    "string",
                    "null"
                  ],
                  "examples": [
                    "IPCC Sixth Assessment Report (AR6) - Climate Change 2023 - Synthesis Report"
                  ],
                  "badge": "Bronze",
                  "title": "Source Title"
                },
                "authors": {
                  "description": "An array of the full names of the authors of the source material.",
                  "type": "array",
                  "items": {
                    "description": "The authors of the source.",
                    "type": [
                      "string",
                      "null"
                    ],
                    "examples": [
                      "Hoesung Lee",
                      "José Romero",
                      "The Core Writing Team"
                    ],
                    "badge": "Bronze",
                    "title": "Author"
                  },
                  "badge": "Bronze",
                  "title": "Authors"
                },
                "description": {
                  "description": "A free text description of the source.",
                  "type": [
                    "string",
                    "null"
                  ],
                  "examples": [
                    "A Report of the Intergovernmental Panel on Climate Change."
                  ],
                  "badge": "Bronze",
                  "title": "Source Description"
                },
                "publicationYear": {
                  "description": "Indicates the year when the work was published.",
                  "type": [
                    "string",
                    "null"
                  ],
                  "examples": [
                    "2023"
                  ],
                  "badge": "Bronze",
                  "title": "Publication Year"
                },
                "path": {
                  "description": "A DOI or link to the original source.",
                  "type": [
                    "string",
                    "null"
                  ],
                  "examples": [
                    "https://www.ipcc.ch/report/ar6/syr/downloads/report/IPCC_AR6_SYR_FullVolume.pdf"
                  ],
                  "badge": "Bronze",
                  "title": "DOI",
                  "format": "uri"
                },
                "sourceLicenses": {
                  "type": "array",
                  "items": {
                    "description": "An array of objects of licenses under which the described source is provided. See https://openenergyplatform.github.io/academy/courses/08_licensing/ for further information.",
                    "type": "object",
                    "properties": {
                      "name": {
                        "description": "The SPDX identifier.",
                        "type": [
                          "string",
                          "null"
                        ],
                        "examples": [
                          "CC-BY-4.0"
                        ],
                        "badge": "Bronze",
                        "title": "Name"
                      },
                      "title": {
                        "description": "The official (human readable) title of the license.",
                        "type": [
                          "string",
                          "null"
                        ],
                        "examples": [
                          "Creative Commons Attribution 4.0 International"
                        ],
                        "badge": "Bronze",
                        "title": "Title"
                      },
                      "path": {
                        "description": "A link or path to the license text.",
                        "type": [
                          "string",
                          "null"
                        ],
                        "examples": [
                          "https://creativecommons.org/licenses/by/4.0/legalcode"
                        ],
                        "badge": "Bronze",
                        "title": "License Identifier",
                        "format": "uri"
                      },
                      "instruction": {
                        "description": "A short description of rights and obligations. The use of tl;drLegal is recommended.",
                        "type": [
                          "string",
                          "null"
                        ],
                        "examples": [
                          "You are free to share and change, but you must attribute. See https://www.tldrlegal.com/license/creative-commons-attribution-4-0-international-cc-by-4 for further information."
                        ],
                        "badge": "Bronze",
                        "title": "Instruction"
                      },
                      "attribution": {
                        "description": "A copyright owner of the source. Must be provided if attribution licenses are used.",
                        "type": [
                          "string",
                          "null"
                        ],
                        "examples": [
                          "© Intergovernmental Panel on Climate Change 2023"
                        ],
                        "badge": "Bronze",
                        "title": "Attribution"
                      },
                      "copyrightStatement": {
                        "description": "A link or path that proves that the source or data has the appropriate license. This can be a page number or website imprint.",
                        "type": [
                          "string",
                          "null"
                        ],
                        "examples": [
                          "https://www.ipcc.ch/copyright/"
                        ],
                        "badge": "Bronze",
                        "title": "Copyright Statement"
                      }
                    },
                    "badge": "Bronze",
                    "title": "Licenses"
                  },
                  "badge": "Bronze",
                  "title": "Licenses"
                }
              },
              "badge": "Bronze",
              "title": "Sources"
            },
            "badge": "Bronze",
            "title": "Sources"
          },
          "resourceLicenses": {
            "description": "An array of objects of licenses under which the described data is provided.",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "description": "The SPDX identifier.",
                  "type": [
                    "string",
                    "null"
                  ],
                  "examples": [
                    "ODbL-1.0"
                  ],
                  "badge": "Bronze",
                  "title": "Name"
                },
                "title": {
                  "description": "The official (human readable) title of the license.",
                  "type": [
                    "string",
                    "null"
                  ],
                  "examples": [
                    "Open Data Commons Open Database License 1.0"
                  ],
                  "badge": "Bronze",
                  "title": "Title"
                },
                "path": {
                  "description": "A link or path to the license text.",
                  "type": [
                    "string",
                    "null"
                  ],
                  "examples": [
                    "https://opendatacommons.org/licenses/odbl/1-0/index.html"
                  ],
                  "badge": "Bronze",
                  "title": "Path",
                  "format": "uri"
                },
                "instruction": {
                  "description": "A short description of rights and obligations. The use of tl;drLegal is recommended.",
                  "type": [
                    "string",
                    "null"
                  ],
                  "examples": [
                    "You are free to share and change, but you must attribute, and share derivations under the same license. See https://tldrlegal.com/license/odc-open-database-license-(odbl) for further information."
                  ],
                  "badge": "Bronze",
                  "title": "Instruction"
                },
                "attribution": {
                  "description": "A copyright holder of the data. Must be provided if attribution licenses are used.",
                  "type": [
                    "string",
                    "null"
                  ],
                  "examples": [
                    "© Reiner Lemoine Institut"
                  ],
                  "badge": "Bronze",
                  "title": "Attribution"
                },
                "copyrightStatement": {
                  "description": "A link or path that proves that the source or data has the appropriate license. This can be a page number or website imprint.",
                  "type": [
                    "string",
                    "null"
                  ],
                  "examples": [
                    "https://github.com/OpenEnergyPlatform/oemetadata/blob/production/LICENSE.txt"
                  ],
                  "badge": "Bronze",
                  "title": "Copyright Statement"
                }
              },
              "badge": "Bronze",
              "title": "License"
            },
            "badge": "Bronze",
            "title": "Licenses"
          },
          "type": {
            "description": "The 'table' type indicates that the resource is tabular as per 'Frictionless Tabular Data' definition.",
            "type": [
              "string",
              "null"
            ],
            "examples": [
              "table"
            ],
            "badge": "Gold",
            "title": "Type",
            "options": {
              "hidden": true
            }
          },
          "format": {
            "description": "A file extension format. Possible options are 'csv', 'xlsx', 'json', 'PostgreSQL', 'SQLite' and other standard file extensions.",
            "type": [
              "string",
              "null"
            ],
            "examples": [
              "csv"
            ],
            "badge": "Gold",
            "title": "Format",
            "options": {
              "hidden": true
            }
          },
          "encoding": {
            "description": "Specifies the character encoding of the resource's data file. The default is 'UTF-8'. The values should be one of the 'Preferred MIME Names'.",
            "type": [
              "string",
              "null"
            ],
            "examples": [
              "UTF-8"
            ],
            "badge": "Gold",
            "title": "Encoding",
            "options": {
              "hidden": true
            }
          },
          "schema": {
            "description": "An object that describes the structure of a table. It contains all fields (columns of the table), the primary key and optional foreign keys.",
            "type": "object",
            "properties": {
              "fields": {
                "description": "An array of objects that describes a field (column) and its detailed information.",
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "description": "The name of the field. The name may only consist of lowercase alphanumeric characters or underscores. It must not begin with a number or an underscore.",
                      "type": [
                        "string",
                        "null"
                      ],
                      "examples": [
                        "year"
                      ],
                      "badge": "Iron",
                      "title": "Column Name",
                      "readOnly": true
                    },
                    "description": {
                      "description": "A text describing the field.",
                      "type": [
                        "string",
                        "null"
                      ],
                      "examples": [
                        "Reference year for which the data was collected."
                      ],
                      "badge": "Silver",
                      "title": "Description"
                    },
                    "type": {
                      "description": "The data type of the field. In case of a geom column in a database, also indicate the shape and CRS.",
                      "type": [
                        "string",
                        "null"
                      ],
                      "examples": [
                        "geometry(Point, 4326)"
                      ],
                      "badge": "Iron",
                      "title": "Type",
                      "readOnly": true
                    },
                    "nullable": {
                      "description": "A boolean key to specify that a column can be nullable. True is the default value.",
                      "type": [
                        "boolean",
                        "null"
                      ],
                      "examples": [
                        true
                      ],
                      "badge": "Iron",
                      "title": "Nullable",
                      "readOnly": true
                    },
                    "unit": {
                      "description": "The unit of a field. If it does not apply, use 'null'. If the unit is given in a separate field, reference this field (e.g. 'unit'). Use a space between numbers and units (100 m).",
                      "type": [
                        "string",
                        "null"
                      ],
                      "examples": [
                        "MW"
                      ],
                      "badge": "Silver",
                      "title": "Unit"
                    },
                    "isAbout": {
                      "description": "An array of objects that describes the field in ontology terms.",
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "name": {
                            "description": "The class label of the ontology term.",
                            "type": [
                              "string",
                              "null"
                            ],
                            "examples": [
                              "wind energy converting unit"
                            ],
                            "badge": "Platinum",
                            "title": "Is About Name"
                          },
                          "@id": {
                            "description": "The path of the ontology term (IRI).",
                            "type": [
                              "string",
                              "null"
                            ],
                            "examples": [
                              "https://openenergyplatform.org/ontology/oeo/OEO_00000044"
                            ],
                            "badge": "Platinum",
                            "title": "Is About Identifier",
                            "format": "uri"
                          },
                          "mappingRelation": {
                            "description": "Using SKOS mapping properties to state mapping (alignment).",
                            "type": [
                              "string",
                              "null"
                            ],
                            "examples": [
                              "skos:closeMatch"
                            ],
                            "badge": "Platinum",
                            "title": "Is About SKOS Mapping Relation"
                          }
                        },
                        "badge": "Platinum",
                        "title": "isAbout"
                      },
                      "badge": "Platinum",
                      "title": "isAbout"
                    },
                    "valueReference": {
                      "description": "An array of objects for an extended description of the values in the column in ontology terms.",
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "value": {
                            "description": "The name of the value in the column.",
                            "type": [
                              "string",
                              "null"
                            ],
                            "examples": [
                              "onshore"
                            ],
                            "badge": "Platinum",
                            "title": "Value Reference"
                          },
                          "name": {
                            "description": "The class label of the ontology term in the column.",
                            "type": [
                              "string",
                              "null"
                            ],
                            "examples": [
                              "onshore wind farm"
                            ],
                            "badge": "Platinum",
                            "title": "Value Reference Name"
                          },
                          "@id": {
                            "description": "The path of the ontology term (IRI) in the column.",
                            "type": [
                              "string",
                              "null"
                            ],
                            "examples": [
                              "https://openenergyplatform.org/ontology/oeo/OEO_00000311"
                            ],
                            "badge": "Platinum",
                            "title": "Value Reference Identifier",
                            "format": "uri"
                          },
                          "mappingRelation": {
                            "description": "Using SKOS mapping properties to state mapping (alignment).",
                            "type": [
                              "string",
                              "null"
                            ],
                            "examples": [
                              "skos:exactMatch"
                            ],
                            "badge": "Platinum",
                            "title": "Value Reference SKOS Mapping Relation"
                          }
                        },
                        "badge": "Platinum",
                        "title": "valueReference"
                      },
                      "badge": "Platinum",
                      "title": "valueReference"
                    }
                  },
                  "title": "Field",
                  "required": [
                    "name",
                    "type",
                    "nullable"
                  ]
                },
                "title": "Field"
              },
              "primaryKey": {
                "description": "An array of fields that uniquely identifies each row in the table.",
                "type": "array",
                "items": {
                  "description": "The default value is the “id” column.",
                  "type": [
                    "string",
                    "null"
                  ],
                  "examples": [
                    "id"
                  ],
                  "badge": "Iron",
                  "title": "Primary key"
                },
                "badge": "Iron",
                "title": "Primary key"
              },
              "foreignKeys": {
                "description": "List of foreign keys.",
                "type": "array",
                "items": {
                  "description": "An array of objects with foreign keys that describe a field that relates to a field in another table.",
                  "type": "object",
                  "properties": {
                    "fields": {
                      "description": "An array of fields in the table that is constrained by the foreign key.",
                      "type": "array",
                      "items": {
                        "description": "The column in the table that is constrained by the foreign key.",
                        "type": [
                          "string",
                          "null"
                        ],
                        "examples": [
                          "version"
                        ],
                        "badge": "Iron",
                        "title": "Foreign Key Field"
                      },
                      "badge": "Iron",
                      "title": "Fields"
                    },
                    "reference": {
                      "description": "The reference to the foreign table.",
                      "type": "object",
                      "properties": {
                        "resource": {
                          "description": "The referenced foreign table.",
                          "type": [
                            "string",
                            "null"
                          ],
                          "examples": [
                            "example_version.csv"
                          ],
                          "badge": "Iron",
                          "title": "Foreign Resource"
                        },
                        "fields": {
                          "description": "The foreign resource column.",
                          "type": "array",
                          "items": {
                            "description": "The foreign resource column.",
                            "type": [
                              "string",
                              "null"
                            ],
                            "examples": [
                              "version"
                            ],
                            "badge": "Iron",
                            "title": "Field"
                          },
                          "badge": "Iron",
                          "title": "Field"
                        }
                      },
                      "badge": "Iron",
                      "title": "Reference",
                      "required": [
                        "resource",
                        "fields"
                      ]
                    }
                  },
                  "title": "Foreign Key",
                  "required": [
                    "fields"
                  ]
                },
                "badge": "Iron",
                "title": "Foreign Keys"
              }
            },
            "title": "Schema",
            "required": [
              "primaryKey"
            ]
          },
          "dialect": {
            "description": "The Dialect defines a simple format for describing the various dialects of CSV files in a language-independent manner. In a database, the values in the fields are 'null'.",
            "type": "object",
            "properties": {
              "delimiter": {
                "description": "The delimiter specifies the character sequence which should separate fields (columns). Common characters are ',' (comma), ';' (semicolon), '.' (point) and '\\t' (tab).",
                "type": [
                  "string",
                  "null"
                ],
                "examples": [
                  ";"
                ],
                "badge": "Silver",
                "title": "Delimiter"
              },
              "decimalSeparator": {
                "description": "The symbol used to separate the integer part from the fractional part of a number written in decimal form. Depending on language and region this symbol can be '.' or ','.",
                "type": [
                  "string",
                  "null"
                ],
                "examples": [
                  "."
                ],
                "badge": "Silver",
                "title": "Decimal separator"
              }
            },
            "badge": "Silver",
            "title": "Dialect",
            "options": {
              "hidden": true
            }
          },
          "review": {
            "description": "The metadata on the OEP can go through an open peer review process. See the Academy course [Open Peer Review](https://openenergyplatform.github.io/academy/courses/09_peer_review/) for further information.",
            "type": "object",
            "properties": {
              "path": {
                "description": "A link or path to the documented open peer review.",
                "type": [
                  "string",
                  "null"
                ],
                "examples": [
                  "https://openenergyplatform.org/database/"
                ],
                "badge": null,
                "title": "Path",
                "format": "uri"
              },
              "badge": {
                "description": "A badge of either Iron, Bronze, Silver, Gold or Platinum is used to label the quality of the metadata.",
                "type": [
                  "string",
                  "null"
                ],
                "examples": [
                  "Platinum"
                ],
                "badge": null,
                "title": "Badge"
              }
            },
            "title": "Review",
            "options": {
              "hidden": true
            }
          }
        }
      },
      "title": "Resources"
    },
    "metaMetadata": {
      "description": "An object that describes the metadata themselves, their format, version and license.",
      "type": "object",
      "properties": {
        "metadataVersion": {
          "description": "Type and version number of the metadata.",
          "examples": [
            "OEMetadata-2.1.0"
          ],
          "type": [
            "string",
            "null"
          ],
          "badge": null,
          "title": "Metadata Version"
        },
        "metadataLicense": {
          "description": "The license of the OEMetadata. ",
          "type": "object",
          "properties": {
            "name": {
              "description": "The SPDX identifier.",
              "type": [
                "string",
                "null"
              ],
              "examples": [
                "CC0-1.0"
              ],
              "badge": null,
              "title": "License Name"
            },
            "title": {
              "description": "The official (human readable) title of the license.",
              "type": [
                "string",
                "null"
              ],
              "examples": [
                "Creative Commons Zero v1.0 Universal"
              ],
              "badge": null,
              "title": "License Title"
            },
            "path": {
              "description": "A link or path to the license text.",
              "type": [
                "string",
                "null"
              ],
              "examples": [
                "https://creativecommons.org/publicdomain/zero/1.0"
              ],
              "badge": null,
              "title": "License Path",
              "format": "uri"
            }
          },
          "badge": null,
          "title": "Metadata License"
        }
      },
      "title": "Meta Metadata",
      "options": {
        "hidden": true
      }
    }
  },
  "additionalProperties": true
}