|
Ontology Class
|
Badge
|
Card.
|
+|--------------------------------|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------|------------------------------------|------------------------------------|
+| 1 | @context | Explanation of metadata keys in ontology terms. | [context.json](https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/latest/context.json) | | Platinum | [0..1] |
+| 2 | @id | A unique identifier (UUID/DOI) for the dataset. This is the Databus Artifact. | [databus.openenergyplatform.org/oeplatform/supply/wri_global_power_plant_database/](https://databus.openenergyplatform.org/oeplatform/supply/wri_global_power_plant_database/) | [dct:identifier](http://purl.org/dc/terms/identifier) | Platinum | [0..1] |
+| 3 | path | A unique identifier (URI/UUID/DOI) for the dataset. | [oemetadata_table_template](https://openenergyplatform.org/database/tables/oemetadata_table_template) | [dcat:accessURL](https://www.w3.org/ns/dcat#accessURL) | Bronze | [0..1] |
+| 4 | name | A filename or database conform dataset name. | oep_oemetadata | [rdfs:label](https://www.w3.org/2000/01/rdf-schema#/label) | Iron | [1] |
+| 5 | title | A human readable dataset name. | OEP OEMetadata | [dct:title](http://purl.org/dc/terms/title) | Bronze | [0..1] |
+| 6 | description | A free text description of the dataset. | A collection of tables for the OEMetadata examples. | [dct:description](http://purl.org/dc/terms/description) | Bronze | [0..1] |
+| 7 | **spatial** | An object that describes a covered area or region of the dataset. | | [oeo:spatial region](http://purl.obolibrary.org/obo/BFO_0000006) | | [0..1] |
+| 7.1 | region | The name of the spatial region of the dataset. | Berlin | [rdfs:label](https://www.w3.org/2000/01/rdf-schema#/label) | Silver | [0..1] |
+| 7.2 | @id | A URI reference for the region of the dataset. | [www.wikidata.org/wiki/Q64](https://www.wikidata.org/wiki/Q64) | [dct:identifier](http://purl.org/dc/terms/identifier) | Platinum | [0..1] |
+| 8 | referenceDate | A base year, month or day. The time for which the dataset should be accurate. Date Format is ISO 8601. | 2020-01-01 | [dct:date](http://purl.org/dc/terms/date) | Silver | [0..1] |
+| 9 | languages | An array of languages used within the described data structures (e.g. titles, descriptions). The language key can be repeated if more languages are used. Standard: IETF (BCP47) | en-GB, de-DE | [dct:language](http://purl.org/dc/terms/language) | Gold | [*] |
+| 10 | version | A version string identifying the version of the package. | 0.1.0 | [dcat:version](https://www.w3.org/ns/dcat#version) | Silver | [0..1] |
+| 11 | image | An image to use for this data package. | https://openenergyplatform.org/static/img/about/OpenEnergyFamily_GroupPhoto2.png | [schema.org:image](https://schema.org/image) | Gold | [0..1] |
+| 12 | **subject** | An array of objects that references to the subjects of the resource in ontology terms. | | | - | [*] |
+| 12.1 | name | A class label of the ontology term. | energy | [rdfs:label](https://www.w3.org/2000/01/rdf-schema#/label) | Platinum | [0..1] |
+| 12.2 | @id | A unique identifier (URI/IRI) of the ontology class. | [openenergyplatform.org/ontology/oeo/OEO_00000150](https://openenergyplatform.org/ontology/oeo/OEO_00000150) | [dct:subject](http://purl.org/dc/terms/subject) | Platinum | [0..1] |
+| 13 | keywords | An array of freely selectable keywords that help with searching and structuring. | example, ODbL-1.0, NFDI4Energy | [dcat:keyword](http://www.w3.org/ns/dcat#keyword) | Silver | [*] |
### Dataset - Project Context Keys
|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
|
@@ -105,15 +110,16 @@ If a value is not yet available, use: `ToDo`.
| 3 | name | A filename or database conform table name. | oemetadata_table_template | [rdfs:label](https://www.w3.org/2000/01/rdf-schema#/label) | Iron | [1] |
| 4 | title | A human readable resource or table name. | OEMetadata Table | [dct:title](http://purl.org/dc/terms/title) | Silver | [0..1] |
| 5 | description | A description of the table. It should be usable as summary information for the table that is described by the metadata. | Example table used to illustrate the OEMetadata structure and features. | [dct:description](http://purl.org/dc/terms/description) | Silver | [0..1] |
-| 6 | publicationDate | A date of publication of the data or metadata. The date format is ISO 8601 (YYYY-MM-DD). | 2024-10-15 | [dct:issued](http://purl.org/dc/terms/issued) | Bronze | [0..1] |
-| 7 | **subject** | An array of objects that references to the subjects of the resource in ontology terms. | | | | [*] |
-| 7.1 | name | A class label of the ontology term. | energy | [rdfs:label](https://www.w3.org/2000/01/rdf-schema#/label) | Platinum | [0..1] |
-| 7.2 | @id | A unique identifier (URI/IRI) of the ontology class. | [openenergyplatform.org/ontology/oeo/OEO_00000150](https://openenergyplatform.org/ontology/oeo/OEO_00000150) | [dct:subject](http://purl.org/dc/terms/subject) | Platinum | [0..1] |
-| 8 | keywords | An array of freely selectable keywords that help with searching and structuring. The keyword are used and managed in the OEP as table tags. | example, ODbL-1.0, NFDI4Energy | [dcat:keyword](http://www.w3.org/ns/dcat#keyword) | Silver | [*] |
-| 9 | **embargoPeriod** | An object that describes the embargo period during which public access to the data is not allowed. | | | | [0..1] |
-| 9.1 | start | The start date of the embargo period. The date of the data (metadata) upload. | 2024-10-11 | [dbo:startDateTime](https://dbpedia.org/ontology/startDateTime) | Bronze | [0..1] |
-| 9.2 | end | The end date of the embargo period. This is the envisioned publication date. | 2025-01-01 | [dbo:endDateTime](https://dbpedia.org/ontology/endDateTime) | Bronze | [0..1] |
-| 9.3 | isActive | A boolean key that indicates if the embargo period is currently active. Must be changed to False on the embargo period end date. | True | [adms:status](http://www.w3.org/ns/adms#status) | Bronze | [0..1] |
+| 6 | publicationDate | A date of publication of the data. The date format is ISO 8601 (YYYY-MM-DD). | 2024-10-15 | [dct:issued](http://purl.org/dc/terms/issued) | Bronze | [0..1] |
+| 7 | topics | An array of predefined topics that correspond to the database schemas of the OEP. | model_draft | [foaf:topic](http://xmlns.com/foaf/spec/#term_topic) | Bronze | [*] |
+| 8 | **subject** | An array of objects that references to the subjects of the resource in ontology terms. | | | | [*] |
+| 8.1 | name | A class label of the ontology term. | energy | [rdfs:label](https://www.w3.org/2000/01/rdf-schema#/label) | Platinum | [0..1] |
+| 8.2 | @id | A unique identifier (URI/IRI) of the ontology class. | [openenergyplatform.org/ontology/oeo/OEO_00000150](https://openenergyplatform.org/ontology/oeo/OEO_00000150) | [dct:subject](http://purl.org/dc/terms/subject) | Platinum | [0..1] |
+| 9 | keywords | An array of freely selectable keywords that help with searching and structuring. The keyword are used and managed in the OEP as table tags. | example, ODbL-1.0, NFDI4Energy | [dcat:keyword](http://www.w3.org/ns/dcat#keyword) | Silver | [*] |
+| 10 | **embargoPeriod** | An object that describes the embargo period during which public access to the data is not allowed. | | | | [0..1] |
+| 10.1 | start | The start date of the embargo period. The date of the data (metadata) upload. | 2024-10-11 | [dbo:startDateTime](https://dbpedia.org/ontology/startDateTime) | Bronze | [0..1] |
+| 10.2 | end | The end date of the embargo period. This is the envisioned publication date. | 2025-01-01 | [dbo:endDateTime](https://dbpedia.org/ontology/endDateTime) | Bronze | [0..1] |
+| 10.3 | isActive | A boolean key that indicates if the embargo period is currently active. Must be changed to False on the embargo period end date. | True | [adms:status](http://www.w3.org/ns/adms#status) | Bronze | [0..1] |
### Resources - Spatial Keys
|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
|
@@ -230,24 +236,22 @@ If a value is not yet available, use: `ToDo`.
### Dataset - Module - Energy Systems
|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
|
|--------------------------------|----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|------------------------------------|------------------------------------|
-| 1 | moduleName | The name of the module | Energy Systems | | Platinum | [0..1] |
-| 3 | supplyTechnologies | A supply technology describes how specific technical components and processes are combined to generate or provide energy | (Solar, Wind, Biomass, Biogas, Geo, ST, other) | [oeo:OEO_00020003 energy transformation](https://openenergyplatform.org/ontology/oeo/OEO_00020003) | Platinum | [0..1] |
-| 4 | storageTechnologies | An energy storage technology describes how energy storage components and energy carriers are combined to charge, store, and discharge energy for temporary use. | (Battery, Kinetic, CA, Pump, Chemical) | [oeo:00020366 energy storage technology](https://openenergyplatform.org/ontology/oeo/OEO_00020366) | Platinum | [0..1] |
-| 6 | supplyGrid | A supply grid is a system of interconnected technical components that together enable the distribution and delivery of energy. | (electricity, gas, heating) | [oeo:OEO_00000200 supply grid](https://openenergyplatform.org/ontology/oeo/OEO_00000200) | Platinum | [0..1] |
-| 2 | finalEnergyCarrier | A final energy carrier is an energy carrier that is delivered to and directly used by end users without further transformation. | (electricity, heating, gas, fuel, ...) | [oeo:OEO_00140080 final energy carrier](https://openenergyplatform.org/ontology/oeo/OEO_00140080/) | Platinum | [0..1] |
-| 5 | demandSectors | An energy demand sector is a sector of the energy system that groups together energy consumers with similar usage characteristics. | (building, commercial, households, transport) | [oeo:OEO_00000128 energy demand sector](https://openenergyplatform.org/ontology/oeo/OEO_00000128) | Platinum | [0..1] |
-| 7 | moduleDescription | A description of the module. It should be usable as summary information for the module that is described by the metadata. | Example table used to illustrate the OEMetadata structure and features. | [dct:description](http://purl.org/dc/terms/description) | Platinum | [0..1] |
+| 1 | supplyTechnologies | A supply technology describes how specific technical components and processes are combined to generate or provide energy. | (Solar, Wind, Biomass, Biogas, Geo, ST, other) | [oeo:OEO_00020003 energy transformation](https://openenergyplatform.org/ontology/oeo/OEO_00020003) | Module | [0..1] |
+| 2 | storageTechnologies | An energy storage technology describes how energy storage components and energy carriers are combined to charge, store, and discharge energy for temporary use. | (Battery, Kinetic, CA, Pump, Chemical) | [oeo:00020366 energy storage technology](https://openenergyplatform.org/ontology/oeo/OEO_00020366) | Module | [0..1] |
+| 3 | supplyGrid | A supply grid is a system of interconnected technical components that together enable the distribution and delivery of energy. | (electricity, gas, heating) | [oeo:OEO_00000200 supply grid](https://openenergyplatform.org/ontology/oeo/OEO_00000200) | Module | [0..1] |
+| 4 | finalEnergyCarrier | A final energy carrier is an energy carrier that is delivered to and directly used by end users without further transformation. | (electricity, heating, gas, fuel, ...) | [oeo:OEO_00140080 final energy carrier](https://openenergyplatform.org/ontology/oeo/OEO_00140080/) | Module | [0..1] |
+| 5 | demandSectors | An energy demand sector is a sector of the energy system that groups together energy consumers with similar usage characteristics. | (building, commercial, households, transport) | [oeo:OEO_00000128 energy demand sector](https://openenergyplatform.org/ontology/oeo/OEO_00000128) | Module | [0..1] |
+| 6 | moduleDescription | A description of the module. It should be usable as summary information for the module that is described by the metadata. | Example table used to illustrate the OEMetadata structure and features. | [dct:description](http://purl.org/dc/terms/description) | Module | [0..1] |
### Dataset - Module - Measurement Data
-|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
|
+|
#
|
Key
|
Description
|
Example
|
Semantic Property
|
Badge
|
Card.
|
|--------------------------------|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|---------------------------------------------------------|------------------------------------|------------------------------------|
-| 1 | moduleName | The name of the module WIP | Measurement Data | ? | Platinum | [0..1] |
-| 2 | instrumentIdentifier | Unique string that identifies the instrument instance | http://hdl.handle.net/21.11157/a9250866-bbec-4542-86b3-a5f78c0c6922 | ? | Platinum | [0..1] |
-| 3 | instrumentPath | A landing page that the identifier resolves to | https://sms.atmohub.kit.edu/devices/961 | ? | Platinum | [0..1] |
-| 5 | instrumentName | Name by which the instrument instance is known | MFC_001000_02 - Merck KGaA - FC-2926V - DH9806004 | ? | Platinum | [0..1] |
-| 4 | instrumentOwner | 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. | Karlsruhe Institute of Technology (KIT) | ? | Platinum | [0..1] |
-| 5 | manufacturerName | Full name of the manufacturer | Merck KGaA | ? | Platinum | [0..1] |
-| 6 | moduleDescription | A description of the module. It should be usable as summary information for the module that is described by the metadata. | Example instrument of PIDInst. | [dct:description](http://purl.org/dc/terms/description) | Platinum | [0..1] |
+| 1 | instrumentIdentifier | Unique string that identifies the instrument instance. | http://hdl.handle.net/21.11157/a9250866-bbec-4542-86b3-a5f78c0c6922 | [dct:identifier](http://purl.org/dc/terms/identifier) | Module | [0..1] |
+| 2 | instrumentPath | A landing page that the identifier resolves to. | https://sms.atmohub.kit.edu/devices/961 | [dct:url](http://purl.org/dc/terms/url) | Module | [0..1] |
+| 3 | instrumentName | Name by which the instrument instance is known. | MFC_001000_02 - Merck KGaA - FC-2926V - DH9806004 | [dct:name](http://purl.org/dc/terms/name) | Module | [0..1] |
+| 4 | instrumentOwner | 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. | Karlsruhe Institute of Technology (KIT) | [sc:owner](https://schema.org/owner) | Module | [0..1] |
+| 5 | manufacturerName | Full name of the manufacturer. | Merck KGaA | [sc:manufacturer](https://schema.org/manufacturer) | Module | [0..1] |
+| 6 | moduleDescription | A description of the module. It should be usable as summary information for the module that is described by the metadata. | Example instrument of PIDINST schema. | [dct:description](http://purl.org/dc/terms/description) | Module | [0..1] |
### Dataset - Module - Data Transformations & ERSMeta
|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
|
diff --git a/docs/oemetadata/metadata_key_details.md b/docs/oemetadata/metadata_key_details.md
index d4891cb5..ab2e365b 100644
--- a/docs/oemetadata/metadata_key_details.md
+++ b/docs/oemetadata/metadata_key_details.md
@@ -484,7 +484,7 @@ If a value is not yet available, use: `ToDo`.
| **Badge** | |
| **Card.** | [*] |
-### Resources - @id
+### Resources - General - @id
| | |
|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Key | @id |
@@ -494,7 +494,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Platinum |
| Card. | [0..1] |
-### Resources - path
+### Resources - General - path
| | |
|----------------|----------------------------------------------------------------------------------------------------------------------------|
| Key | path |
@@ -504,7 +504,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Bronze |
| Card. | [0..1] |
-### Resources - name
+### Resources - General - name
| | |
|----------------|------------------------------------------------------------|
| Key | name |
@@ -514,7 +514,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Iron |
| Card. | [1] |
-### Resources - title
+### Resources - General - title
| | |
|----------------|---------------------------------------------|
| Key | title |
@@ -524,7 +524,17 @@ If a value is not yet available, use: `ToDo`.
| Badge | Silver |
| Card. | [0..1] |
-### Resources - description
+### Resource - General - topics
+| | |
+|----------------|-----------------------------------------------------------------------------------|
+| Key | topics |
+| Description | An array of predefined topics that correspond to the database schemas of the OEP. |
+| Example | model_draft |
+| Ontology Class | [foaf:topic](http://xmlns.com/foaf/spec/#term_topic) |
+| Badge | Bronze |
+| Card. | [*] |
+
+### Resources - General - description
| | |
|----------------|-------------------------------------------------------------------------------------------------------------------------|
| Key | description |
@@ -534,7 +544,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Silver |
| Card. | [0..1] |
-### Resources - publicationDate
+### Resources - General - publicationDate
| | |
|----------------|------------------------------------------------------------------------------------------|
| Key | publicationDate |
@@ -544,7 +554,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Bronze |
| Card. | [0..1] |
-### Resources - subject
+### Resources - General - subject
| | |
|----------------|-------------------------------------------------------------------------------------|
| Key | subject |
@@ -554,7 +564,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | |
| Card. | [*] |
-### Resources - subject (name)
+### Resources - General - subject (name)
| | |
|----------------|------------------------------------------------------------|
| Key | name |
@@ -564,7 +574,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Platinum |
| Card. | [0..1] |
-### Resources - subject (@id)
+### Resources - General - subject (@id)
| | |
|----------------|--------------------------------------------------------------------------------------------------------------|
| Key | @id |
@@ -574,7 +584,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Platinum |
| Card. | [0..1] |
-### Resources - keywords
+### Resources - General - keywords
| | |
|----------------|----------------------------------------------------------------------------------|
| Key | keywords |
@@ -584,7 +594,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Silver |
| Card. | [*] |
-### Resources - embargoPeriod
+### Resources - General - embargoPeriod
| | |
|----------------|----------------------------------------------------------------------------------------------------|
| Key | embargoPeriod |
@@ -594,7 +604,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | |
| Card. | [0..1] |
-### Resources - embargoPeriod (start)
+### Resources - General - embargoPeriod (start)
| | |
|----------------|-------------------------------------------------------------------------------|
| Key | start |
@@ -604,7 +614,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Bronze |
| Card. | [0..1] |
-### Resources - embargoPeriod (end)
+### Resources - General - embargoPeriod (end)
| | |
|----------------|------------------------------------------------------------------------------|
| Key | end |
@@ -614,7 +624,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Bronze |
| Card. | [0..1] |
-### Resources - embargoPeriod (isActive)
+### Resources - General - embargoPeriod (isActive)
| | |
|----------------|----------------------------------------------------------------------------------------------------------------------------------|
| Key | isActive |
@@ -624,7 +634,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Bronze |
| Card. | [0..1] |
-### Resources - spatial
+### Resources - Spatial
| | |
|----------------|-----------------------------------------------------------|
| Key | spatial |
@@ -634,7 +644,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | |
| Card. | [0..1] |
-### Resources - spatial (location)
+### Resources - Spatial - location
| | |
|----------------|---------------------------------------------------|
| Key | location |
@@ -644,7 +654,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | |
| Card. | [0..1] |
-### Resources - spatial (location - address)
+### Resources - Spatial - location (address)
| | |
|----------------|-------------------------------------------------------------------------------------------------------------------|
| Key | address |
@@ -654,7 +664,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Silver |
| Card. | [0..1] |
-### Resources - spatial (location - @id)
+### Resources - Spatial - location (@id)
| | |
|----------------|-----------------------------------------------------------------------------|
| Key | @id |
@@ -664,7 +674,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Platinum |
| Card. | [0..1] |
-### Resources - spatial (location - latitude)
+### Resources - Spatial - location (latitude)
| | |
|----------------|-------------------------------------------------|
| Key | latitude |
@@ -674,7 +684,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Gold |
| Card. | [0..1] |
-### Resources - spatial (location - longitude)
+### Resources - Spatial - location (longitude)
| | |
|----------------|--------------------------------------------------|
| Key | longitude |
@@ -684,7 +694,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Gold |
| Card. | [0..1] |
-### Resources - spatial (extent)
+### Resources - Spatial - extent
| | |
|----------------|------------------------------------------------------------------|
| Key | extent |
@@ -694,7 +704,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | |
| Card. | [0..1] |
-### Resources - spatial (extent - name)
+### Resources - Spatial - extent (name)
| | |
|----------------|------------------------------------------------------------|
| Key | name |
@@ -704,7 +714,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Silver |
| Card. | [0..1] |
-### Resources - spatial (extent - @id)
+### Resources - Spatial - extent (@id)
| | |
|----------------|----------------------------------------------------------------|
| Key | @id |
@@ -714,7 +724,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Platinum |
| Card. | [0..1] |
-### Resources - spatial (extent - resolutionValue)
+### Resources - Spatial - extent (resolutionValue)
| | |
|----------------|---------------------------------------------------------------------------------------|
| Key | resolutionValue |
@@ -724,7 +734,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Silver |
| Card. | [0..1] |
-### Resources - spatial (extent - resolutionUnit)
+### Resources - Spatial - extent (resolutionUnit)
| | |
|----------------|---------------------------------------------------------------------|
| Key | resolutionUnit |
@@ -734,7 +744,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Silver |
| Card. | [0..1] |
-### Resources - spatial (extent - boundingBox)
+### Resources - Spatial - extent (boundingBox)
| | |
|----------------|-------------------------------------------------------------------------------------------------------------------------------|
| Key | boundingBox |
@@ -744,7 +754,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Gold |
| Card. | [*] |
-### Resources - spatial (extent - crs)
+### Resources - Spatial - extent (crs)
| | |
|----------------|------------------------------------------------------------------------------------------------------------------------------------------|
| Key | crs |
@@ -754,7 +764,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Gold |
| Card. | [0..1] |
-### Resources - temporal
+### Resources - Temporal
| | |
|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Key | temporal |
@@ -764,7 +774,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | |
| Card. | [0..1] |
-### Resources - temporal (referenceDate)
+### Resources - Temporal - referenceDate
| | |
|----------------|-----------------------------------------------------------------------------------------------------|
| Key | referenceDate |
@@ -774,7 +784,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Silver |
| Card. | [0..1] |
-### Resources - temporal (timeseries)
+### Resources - Temporal - timeseries
| | |
|----------------|-----------------------------------------------------------|
| Key | timeseries |
@@ -784,7 +794,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | |
| Card. | [*] |
-### Resources - temporal (timeseries - start)
+### Resources - Temporal - timeseries (start)
| | |
|----------------|-----------------------------------------------------------------|
| Key | start |
@@ -794,7 +804,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Silver |
| Card. | [0..1] |
-### Resources - temporal (timeseries - end)
+### Resources - Temporal - timeseries (end)
| | |
|----------------|-------------------------------------------------------------|
| Key | end |
@@ -804,7 +814,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Silver |
| Card. | [0..1] |
-### Resources - temporal (timeseries - resolutionValue)
+### Resources - Temporal - timeseries (resolutionValue)
| | |
|----------------|----------------------------------------------------------------------------------------------------|
| Key | resolutionValue |
@@ -814,7 +824,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Silver |
| Card. | [0..1] |
-### Resources - temporal (timeseries - resolutionUnit)
+### Resources - Temporal - timeseries (resolutionUnit)
| | |
|----------------|---------------------------------------------------------------------|
| Key | resolutionUnit |
@@ -824,7 +834,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Silver |
| Card. | [0..1] |
-### Resources - temporal (timeseries - alignment)
+### Resources - Temporal - timeseries (alignment)
| | |
|----------------|----------------------------------------------------------------------------------------------|
| Key | alignment |
@@ -834,7 +844,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Silver |
| Card. | [0..1] |
-### Resources - temporal (timeseries - aggregationType)
+### Resources - Temporal - timeseries (aggregationType)
| | |
|----------------|-----------------------------------------------------------------------------------|
| Key | aggregationType |
@@ -856,7 +866,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | |
| Card. | [*] |
-### Resources - sources (title)
+### Resources - sources - title
| | |
|----------------|------------------------------------------------------------------------------|
| Key | title |
@@ -866,7 +876,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Bronze |
| Card. | [0..1] |
-### Resources - sources (authors)
+### Resources - sources - authors
| | |
|----------------|-------------------------------------------------------------------------|
| Key | authors |
@@ -876,7 +886,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Bronze |
| Card. | [*] |
-### Resources - sources (description)
+### Resources - sources - description
| | |
|----------------|-----------------------------------------------------------|
| Key | description |
@@ -886,7 +896,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Bronze |
| Card. | [0..1] |
-### Resources - sources (publicationYear)
+### Resources - sources - publicationYear
| | |
|----------------|-------------------------------------------------|
| Key | publicationYear |
@@ -896,7 +906,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Bronze |
| Card. | [0..1] |
-### Resources - sources (path)
+### Resources - sources - path
| | |
|----------------|----------------------------------------------------------------------------------------------------------------|
| Key | path |
@@ -986,7 +996,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | |
| Card. | [*] |
-### Resources - resourceLicenses (name)
+### Resources - resourceLicenses - name
| | |
|----------------|------------------------------------------------------------|
| Key | name |
@@ -996,7 +1006,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Bronze |
| Card. | [0..1] |
-### Resources - resourceLicenses (title)
+### Resources - resourceLicenses - title
| | |
|----------------|-----------------------------------------------------|
| Key | title |
@@ -1006,7 +1016,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Bronze |
| Card. | [0..1] |
-### Resources - resourceLicenses (path)
+### Resources - resourceLicenses - path
| | |
|----------------|--------------------------------------------------------------------------------------------------------------|
| Key | path |
@@ -1016,7 +1026,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Bronze |
| Card. | [0..1] |
-### Resources - resourceLicenses (instruction)
+### Resources - resourceLicenses - instruction
| | |
|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Key | instruction |
@@ -1026,7 +1036,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Bronze |
| Card. | [0..1] |
-### Resources - resourceLicenses (attribution)
+### Resources - resourceLicenses - attribution
| | |
|----------------|---------------------------------------------------------------------------------------|
| Key | attribution |
@@ -1036,7 +1046,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Bronze |
| Card. | [0..1] |
-### Resources - resourceLicenses (copyrightStatement)
+### Resources - resourceLicenses - copyrightStatement
| | |
|----------------|---------------------------------------------------------------------------------------------------------------------|
| Key | copyrightStatement |
@@ -1312,7 +1322,7 @@ If a value is not yet available, use: `ToDo`.
| 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. |
| Example | |
| Ontology Class | |
-| Badge | [0..1] |
+| Card. | [0..1] |
### Resources - Review Keys - path
| | |
@@ -1321,7 +1331,7 @@ If a value is not yet available, use: `ToDo`.
| Description | A link or path to the documented open peer review. |
| Example | [open_peer_review/9](https://openenergyplatform.org/dataedit/view/model_draft/oep_table_example/open_peer_review/9/) |
| Ontology Class | [sc:url](https://schema.org/url) |
-| Badge | [0..1] |
+| Card. | [0..1] |
### Resources - Review Keys - badge
| | |
@@ -1330,7 +1340,7 @@ If a value is not yet available, use: `ToDo`.
| Description | A badge of either Iron, Bronze, Silver, Gold or Platinum is used to label the quality of the metadata. |
| Example | Platinum |
| Ontology Class | [oeo:quality control flag](https://openenergyplatform.org/ontology/oeo/OEO_00140098/) |
-| Badge | [0..1] |
+| Card. | [0..1] |
## Dataset - Modules
@@ -1342,7 +1352,7 @@ If a value is not yet available, use: `ToDo`.
| Description | An Object that describes the main concepts of an energy system. |
| Example | |
| Ontology Class | |
-| Badge | [0..1] |
+| Card. | [0..1] |
### Dataset - Module - Energy Systems - supplyTechnologies
| | |
@@ -1351,7 +1361,7 @@ If a value is not yet available, use: `ToDo`.
| Description | A supply technology describes how specific technical components and processes are combined to generate or provide energy. |
| Example | |
| Ontology Class | |
-| Badge | [0..1] |
+| Card. | [0..1] |
### Dataset - Module - Energy Systems - storageTechnologies
| | |
@@ -1360,7 +1370,7 @@ If a value is not yet available, use: `ToDo`.
| Description | An energy storage technology describes how energy storage components and energy carriers are combined to charge, store, and discharge energy for temporary use. |
| Example | |
| Ontology Class | |
-| Badge | [0..1] |
+| Card. | [0..1] |
### Dataset - Module - Energy Systems - supplyGrid
| | |
@@ -1369,16 +1379,16 @@ If a value is not yet available, use: `ToDo`.
| Description | A supply grid is a system of interconnected technical components that together enable the distribution and delivery of energy. |
| Example | |
| Ontology Class | |
-| Badge | [0..1] |
+| Card. | [0..1] |
### Dataset - Module - Energy Systems - finalEnergyCarrier
| | |
|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| Key | **finalEnergyCarrier** |
+| Key | **finalEnergyCarrier** |
| Description | An energy storage technology describes how energy storage components and energy carriers are combined to charge, store, and discharge energy for temporary use. |
| Example | |
| Ontology Class | |
-| Badge | [0..1] |
+| Card. | [0..1] |
### Dataset - Module - Energy Systems - demandSectors
| | |
@@ -1387,7 +1397,7 @@ If a value is not yet available, use: `ToDo`.
| Description | An energy demand sector is a sector of the energy system that groups together energy consumers with similar usage characteristics. |
| Example | |
| Ontology Class | |
-| Badge | [0..1] |
+| Card. | [0..1] |
### Dataset - Module - Energy Systems - moduleDescription
| | |
@@ -1396,7 +1406,71 @@ If a value is not yet available, use: `ToDo`.
| Description | A description of the module. It should be usable as summary information for the module that is described by the metadata. |
| Example | |
| Ontology Class | |
-| Badge | [0..1] |
+| Card. | [0..1] |
+
+
+### Dataset - Module - Measurement Data
+| | |
+|----------------|-------------------------------------------------------------------|
+| Key | **moduleMeasurementData** |
+| Description | An Object that describes the instruments used in the measurement. |
+| Example | |
+| Ontology Class | |
+| Card. | [0..1] |
+
+### Dataset - Module - Measurement Data - instrumentIdentifier
+| | |
+|----------------|---------------------------------------------------------------------|
+| Key | **instrumentIdentifier** |
+| Description | Unique string that identifies the instrument instance. |
+| Example | http://hdl.handle.net/21.11157/a9250866-bbec-4542-86b3-a5f78c0c6922 |
+| Ontology Class | [dct:identifier](http://purl.org/dc/terms/identifier) |
+| Card. | [0..1] |
+
+### Dataset - Module - Measurement Data - instrumentPath
+| | |
+|----------------|-------------------------------------------------|
+| Key | **instrumentPath** |
+| Description | A landing page that the identifier resolves to. |
+| Example | https://sms.atmohub.kit.edu/devices/961 |
+| Ontology Class | [dct:url](http://purl.org/dc/terms/url) |
+| Card. | [0..1] |
+
+### Dataset - Module - Measurement Data - instrumentName
+| | |
+|----------------|---------------------------------------------------|
+| Key | **instrumentName** |
+| Description | Name by which the instrument instance is known. |
+| Example | MFC_001000_02 - Merck KGaA - FC-2926V - DH9806004 |
+| Ontology Class | [dct:name](http://purl.org/dc/terms/name) |
+| Card. | [0..1] |
+
+### Dataset - Module - Measurement Data - instrumentOwner
+| | |
+|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Key | **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. |
+| Example | Karlsruhe Institute of Technology (KIT) |
+| Ontology Class | [sc:owner](https://schema.org/owner) |
+| Card. | [0..1] |
+
+### Dataset - Module - Measurement Data - manufacturerName
+| | |
+|----------------|-----------------------------------------------------|
+| Key | **manufacturerName** |
+| Description | Full name of the manufacturer. |
+| Example | Merck KGaA |
+| Ontology Class | [sc:manufacturer](https://schema.org/manufacturer) |
+| Card. | [0..1] |
+
+### Dataset - Module - Measurement Data - moduleDescription
+| | |
+|----------------|---------------------------------------------------------------------------------------------------------------------------|
+| Key | **moduleDescription** |
+| Description | A description of the module. It should be usable as summary information for the module that is described by the metadata. |
+| Example | Example instrument of PIDINST schema. |
+| Ontology Class | [dct:description](http://purl.org/dc/terms/description) |
+| Card. | [0..1] |
### MetaMetadata Keys
@@ -1406,7 +1480,7 @@ If a value is not yet available, use: `ToDo`.
| Description | An object that describes the metadata themselves, their format, version and license. |
| Example | |
| Ontology Class | |
-| Card. | [1] |
+| Card. | [0..1] |
### MetaMetadata Keys - metadataVersion
| | |
diff --git a/oemetadata/v2/v21/build_source/schemas/context.json b/oemetadata/v2/v21/build_source/schemas/context.json
deleted file mode 100644
index ac5c3f8a..00000000
--- a/oemetadata/v2/v21/build_source/schemas/context.json
+++ /dev/null
@@ -1,139 +0,0 @@
-{
- "$schema": "https://json-schema.org/draft/2020-12/schema",
- "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v2/v20/build_source/schemas/context.json",
- "type": "object",
- "properties": {
- "context": {
- "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"
- }
- }
-}
diff --git a/oemetadata/v2/v21/build_source/schemas/module_measurement_data.json b/oemetadata/v2/v21/build_source/schemas/module_measurement_data.json
index 62776cc5..2294956b 100644
--- a/oemetadata/v2/v21/build_source/schemas/module_measurement_data.json
+++ b/oemetadata/v2/v21/build_source/schemas/module_measurement_data.json
@@ -72,10 +72,7 @@
},
"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"
- ],
+ "type": "string",
"examples": [
"Example instrument of PIDINST schema."
],
diff --git a/oemetadata/v2/v21/context.json b/oemetadata/v2/v21/context.json
index 39f98470..75b7429b 100644
--- a/oemetadata/v2/v21/context.json
+++ b/oemetadata/v2/v21/context.json
@@ -322,6 +322,30 @@
"@id": "oeo:OEO_00140098",
"@type": "xsd:string"
},
+ "moduleMeasurementData": {
+ "@container": "@set",
+ "@id": "dcat:hasPart"
+ },
+ "instrumentIdentifier": {
+ "@id": "dct:identifier",
+ "@type": "@id"
+ },
+ "instrumentPath": {
+ "@id": "dct:url",
+ "@type": "xsd:string"
+ },
+ "instrumentName": {
+ "@id": "dct:name",
+ "@type": "xsd:string"
+ },
+ "instrumentOwner": {
+ "@id": "sc:owner",
+ "@type": "xsd:string"
+ },
+ "manufacturerName": {
+ "@id": "sc:manufacturer",
+ "@type": "xsd:string"
+ },
"metaMetadata": "@nest",
"metadataVersion": {
"@id": "owl:versionInfo",
diff --git a/oemetadata/v2/v21/metadata_key_description.md b/oemetadata/v2/v21/metadata_key_description.md
index a8b85cd8..49c3a985 100644
--- a/oemetadata/v2/v21/metadata_key_description.md
+++ b/oemetadata/v2/v21/metadata_key_description.md
@@ -244,13 +244,13 @@ If a value is not yet available, use: `ToDo`.
| 6 | moduleDescription | A description of the module. It should be usable as summary information for the module that is described by the metadata. | Example table used to illustrate the OEMetadata structure and features. | [dct:description](http://purl.org/dc/terms/description) | Module | [0..1] |
### Dataset - Module - Measurement Data
-|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
|
+|
#
|
Key
|
Description
|
Example
|
Semantic Property
|
Badge
|
Card.
|
|--------------------------------|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|---------------------------------------------------------|------------------------------------|------------------------------------|
-| 1 | instrumentIdentifier | Unique string that identifies the instrument instance. | http://hdl.handle.net/21.11157/a9250866-bbec-4542-86b3-a5f78c0c6922 | | Module | [0..1] |
-| 2 | instrumentPath | A landing page that the identifier resolves to. | https://sms.atmohub.kit.edu/devices/961 | | Module | [0..1] |
-| 3 | instrumentName | Name by which the instrument instance is known. | MFC_001000_02 - Merck KGaA - FC-2926V - DH9806004 | | Module | [0..1] |
-| 4 | instrumentOwner | 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. | Karlsruhe Institute of Technology (KIT) | | Module | [0..1] |
-| 5 | manufacturerName | Full name of the manufacturer. | Merck KGaA | | Module | [0..1] |
+| 1 | instrumentIdentifier | Unique string that identifies the instrument instance. | http://hdl.handle.net/21.11157/a9250866-bbec-4542-86b3-a5f78c0c6922 | [dct:identifier](http://purl.org/dc/terms/identifier) | Module | [0..1] |
+| 2 | instrumentPath | A landing page that the identifier resolves to. | https://sms.atmohub.kit.edu/devices/961 | [dct:url](http://purl.org/dc/terms/url) | Module | [0..1] |
+| 3 | instrumentName | Name by which the instrument instance is known. | MFC_001000_02 - Merck KGaA - FC-2926V - DH9806004 | [dct:name](http://purl.org/dc/terms/name) | Module | [0..1] |
+| 4 | instrumentOwner | 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. | Karlsruhe Institute of Technology (KIT) | [sc:owner](https://schema.org/owner) | Module | [0..1] |
+| 5 | manufacturerName | Full name of the manufacturer. | Merck KGaA | [sc:manufacturer](https://schema.org/manufacturer) | Module | [0..1] |
| 6 | moduleDescription | A description of the module. It should be usable as summary information for the module that is described by the metadata. | Example instrument of PIDINST schema. | [dct:description](http://purl.org/dc/terms/description) | Module | [0..1] |
### Dataset - Module - Data Transformation Software
diff --git a/oemetadata/v2/v21/metadata_key_details.md b/oemetadata/v2/v21/metadata_key_details.md
index c05f28dd..ab2e365b 100644
--- a/oemetadata/v2/v21/metadata_key_details.md
+++ b/oemetadata/v2/v21/metadata_key_details.md
@@ -1384,7 +1384,7 @@ If a value is not yet available, use: `ToDo`.
### Dataset - Module - Energy Systems - finalEnergyCarrier
| | |
|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| Key | **finalEnergyCarrier** |
+| Key | **finalEnergyCarrier** |
| Description | An energy storage technology describes how energy storage components and energy carriers are combined to charge, store, and discharge energy for temporary use. |
| Example | |
| Ontology Class | |
@@ -1424,7 +1424,7 @@ If a value is not yet available, use: `ToDo`.
| Key | **instrumentIdentifier** |
| Description | Unique string that identifies the instrument instance. |
| Example | http://hdl.handle.net/21.11157/a9250866-bbec-4542-86b3-a5f78c0c6922 |
-| Ontology Class | |
+| Ontology Class | [dct:identifier](http://purl.org/dc/terms/identifier) |
| Card. | [0..1] |
### Dataset - Module - Measurement Data - instrumentPath
@@ -1433,17 +1433,17 @@ If a value is not yet available, use: `ToDo`.
| Key | **instrumentPath** |
| Description | A landing page that the identifier resolves to. |
| Example | https://sms.atmohub.kit.edu/devices/961 |
-| Ontology Class | |
+| Ontology Class | [dct:url](http://purl.org/dc/terms/url) |
| Card. | [0..1] |
### Dataset - Module - Measurement Data - instrumentName
-| | |
-|----------------|----------------------------------------------------|
-| Key | **instrumentName** |
-| Description | Name by which the instrument instance is known. |
-| Example | MFC_001000_02 - Merck KGaA - FC-2926V - DH9806004 |
-| Ontology Class | |
-| Card. | [0..1] |
+| | |
+|----------------|---------------------------------------------------|
+| Key | **instrumentName** |
+| Description | Name by which the instrument instance is known. |
+| Example | MFC_001000_02 - Merck KGaA - FC-2926V - DH9806004 |
+| Ontology Class | [dct:name](http://purl.org/dc/terms/name) |
+| Card. | [0..1] |
### Dataset - Module - Measurement Data - instrumentOwner
| | |
@@ -1451,26 +1451,26 @@ If a value is not yet available, use: `ToDo`.
| Key | **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. |
| Example | Karlsruhe Institute of Technology (KIT) |
-| Ontology Class | |
+| Ontology Class | [sc:owner](https://schema.org/owner) |
| Card. | [0..1] |
### Dataset - Module - Measurement Data - manufacturerName
-| | |
-|----------------|--------------------------------|
-| Key | **manufacturerName** |
-| Description | Full name of the manufacturer. |
-| Example | Merck KGaA |
-| Ontology Class | |
-| Card. | [0..1] |
+| | |
+|----------------|-----------------------------------------------------|
+| Key | **manufacturerName** |
+| Description | Full name of the manufacturer. |
+| Example | Merck KGaA |
+| Ontology Class | [sc:manufacturer](https://schema.org/manufacturer) |
+| Card. | [0..1] |
### Dataset - Module - Measurement Data - moduleDescription
-| | |
-|----------------|----------------------------------------------------------------------------------------------------------------------------|
-| Key | **moduleDescription** |
-| Description | A description of the module. It should be usable as summary information for the module that is described by the metadata. |
-| Example | |
-| Ontology Class | |
-| Card. | [0..1] |
+| | |
+|----------------|---------------------------------------------------------------------------------------------------------------------------|
+| Key | **moduleDescription** |
+| Description | A description of the module. It should be usable as summary information for the module that is described by the metadata. |
+| Example | Example instrument of PIDINST schema. |
+| Ontology Class | [dct:description](http://purl.org/dc/terms/description) |
+| Card. | [0..1] |
### MetaMetadata Keys
@@ -1480,7 +1480,7 @@ If a value is not yet available, use: `ToDo`.
| Description | An object that describes the metadata themselves, their format, version and license. |
| Example | |
| Ontology Class | |
-| Card. | [1] |
+| Card. | [0..1] |
### MetaMetadata Keys - metadataVersion
| | |
diff --git a/oemetadata/v2/v21/schema.json b/oemetadata/v2/v21/schema.json
index 1a909092..f9143fb6 100644
--- a/oemetadata/v2/v21/schema.json
+++ b/oemetadata/v2/v21/schema.json
@@ -732,10 +732,7 @@
},
"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"
- ],
+ "type": "string",
"examples": [
"Example instrument of PIDINST schema."
],