Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add key topics to general #169 #170

Merged
merged 3 commits into from
Oct 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@ Here is a template for new release sections

- Add explicit json types [(#166)](https://github.com/OpenEnergyPlatform/oemetadata/pull/166)

- Add key topics to general [(#170)](https://github.com/OpenEnergyPlatform/oemetadata/pull/170)

### Changed

- Remove comment field as it holds information on how to fill out the metadata and therefore should not be part of the actual oemetadata but the documentation. [#???](https://github.com/OpenEnergyPlatform/oemetadata/pull/)
Expand Down
25 changes: 21 additions & 4 deletions metadata/v20/build_source/schemas/general.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,34 @@
"properties": {
"name": {
"description": "A filename or database conform table name.",
"example": "model_draft.oemetadata_table_example_v20",
"example": "oemetadata_table_example",
"type": [
"string",
"null"
],
"badge": "Iron",
"title": "Name"
},
"topic": {
"description": "A list predefined topics that correspond to the database schemas.",
"example": "[model_draft, reference]",
"type": "array",
"items": {
"description": "The topics are used to group the data in the database.",
"example": "model_draft",
"type": [
"string",
"null"
],
"badge": "Bronze",
"title": "Keyword"
},
"badge": "Bronze",
"title": "Keywords"
},
"title": {
"description": "A human readable table name.",
"example": "OEMetadata example table - Version 2.0",
"example": "OEMetadata example table",
"type": [
"string",
"null"
Expand All @@ -25,15 +42,15 @@
},
"path": {
"description": "A unique identifier (URI/UUID/DOI) for the table or file.",
"example": "http://openenergyplatform.org/dataedit/view/model_draft/oemetadata_table_example_v20",
"example": "http://openenergyplatform.org/dataedit/view/model_draft/oemetadata_table_example",
"type": [
"string",
"null"
],
"badge": "Bronze",
"title": "Path",
"readonly": true
},
},
"description": {
"description": "A description of the table. It should be usable as summary information for the table that is described by the metadata.",
"example": "Example table used to illustrate the oemetadata structure and meaning.",
Expand Down
Loading
Loading