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.

Sign up for GitHub

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 a key to make fields (columns) nullable #161

Merged
merged 5 commits into from
Oct 15, 2024
Merged

Add a key to make fields (columns) nullable #161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e6565a6
Add key isNullable to fields section #96
Ludee Oct 15, 2024
7676026
Sort the key unit #96
Ludee Oct 15, 2024
1bf1456
Rename to nullable #96
Ludee Oct 15, 2024
91cb9be
Update key description #96
Ludee Oct 15, 2024
3a21a63
Update changelog #96
Ludee Oct 15, 2024
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ Here is a template for new release sections

- Add mandatory fields to the json schema (Iron Badge) [(#160)](https://github.com/OpenEnergyPlatform/oemetadata/pull/160)

- Add key nullable to fields section (columns) [(#161)](https://github.com/OpenEnergyPlatform/oemetadata/pull/161)

### 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
33 changes: 22 additions & 11 deletions metadata/v200_draft/build_source/schemas/resource.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,27 @@
"title": "Type",
"readonly": true
},
"nullable": {
"description": "A boolean key to specify that a column can be nullable. True is the default value.",
"example": "True",
"type": [
"boolean",
"null"
],
"badge": "Iron",
"title": "Nullable",
"readonly": true
},
"unit": {
"description": "The unit, preferably SI-unit, that values in this field are mapped to. If 'unit' doesn't apply to a field, use 'null'. If the unit is given in a seperate field, reference this field.",
"example": "MW",
"type": [
"string",
"null"
],
"badge": "Silver",
"title": "Unit"
},
"isAbout": {
"description": "Ontology URI to describe the column header",
"type": "array",
Expand Down Expand Up @@ -187,21 +208,11 @@
},
"badge": "Platinum",
"title": "valueReference"
},
"unit": {
"description": "The unit, preferably SI-unit, that values in this field are mapped to. If 'unit' doesn't apply to a field, use 'null'. If the unit is given in a seperate field, reference this field.",
"example": "MW",
"type": [
"string",
"null"
],
"badge": "Silver",
"title": "Unit"
}
},
"additionalProperties": false,
"title": "Field",
"required": ["name", "type"]
"required": ["name", "type", "nullable"]
},
"title": "Field"
},
Expand Down
17 changes: 9 additions & 8 deletions metadata/v200_draft/metadata_key_description.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,14 +133,15 @@ The JSON format offers different formats:
| 16.6.1.1 | name | The name of the field. The name must consist of only lowercase alphanumeric characters or underscore. It must not start with a number or underscore. | year |
| 16.6.1.2 | description | A text describing the field. | Reference year for which the data were collected. |
| 16.6.1.3 | type | The data type of the field. In case of a geom column in a database, also indicate the shape and CRS. | geometry(Point, 4326) |
| 16.6.1.4 | unit | The unit, preferably SI-unit, that values in this field are mapped to. If 'unit' doesn't apply to a field, use 'null'. If the unit is given in a seperate field, reference this field. | MW |
| 16.6.1.5 | **isAbout** | An array of objects with describe the field in [OEO](https://openenergy-platform.org/ontology/oeo/) terms. |
| 16.6.1.5.1 | name | The class label of the OEO terms. | wind energy converting unit |
| 16.6.1.5.2 | path | The URI of the class. | https://openenergy-platform.org/ontology/oeo/OEO_00000044 |
| 16.6.1.6 | **valueReference** | An array of objects for an extended description of the values in the column in [OEO](https://openenergy-platform.org/ontology/oeo/) terms. | |
| 16.6.1.6.1 | value | The name of the value in the column. | onshore |
| 16.6.1.6.2 | name | The class label of the OEO terms. | onshore wind farm |
| 16.6.1.6.3 | path | The URI of the class. | https://openenergy-platform.org/ontology/oeo/OEO_00000311 |
| 16.6.1.4 | nullable | A boolean key to specify that a column can be nullable. True is the default value. | True |
| 16.6.1.5 | unit | The unit, preferably SI-unit, that values in this field are mapped to. If 'unit' doesn't apply to a field, use 'null'. If the unit is given in a seperate field, reference this field. | MW |
| 16.6.1.6 | **isAbout** | An array of objects with describe the field in [OEO](https://openenergy-platform.org/ontology/oeo/) terms. |
| 16.6.1.6.1 | name | The class label of the OEO terms. | wind energy converting unit |
| 16.6.1.6.2 | path | The URI of the class. | https://openenergy-platform.org/ontology/oeo/OEO_00000044 |
| 16.6.1.7 | **valueReference** | An array of objects for an extended description of the values in the column in [OEO](https://openenergy-platform.org/ontology/oeo/) terms. | |
| 16.6.1.7.1 | value | The name of the value in the column. | onshore |
| 16.6.1.7.2 | name | The class label of the OEO terms. | onshore wind farm |
| 16.6.1.7.3 | path | The URI of the class. | https://openenergy-platform.org/ontology/oeo/OEO_00000311 |

#### Resource Keys - Properties
|#|Key |Description |Example |
Expand Down
Loading