search

OpenEnergyPlatform / oemetadata

Repository for the Open Energy Family metadata. Contains metadata templates, examples and schemas. For metadata conversion see https://github.com/OpenEnergyPlatform/omi
https://openenergyplatform.github.io/oemetadata/
MIT License
21 stars 3 forks source link

Update OEMetadata - Key Description #107

Closed chrwm closed 1 year ago

chrwm commented 1 year ago

The naming conventions for oem-key 15.6.1.1 and oem-key 15.2 have to be updated with regards to using the OEMetadata with the OEP. When creating tables on the OEP with OEMetadata via the API, . and - are not allowed in both keys. The same applies when creating a table via the OEP Wizzard.

I suggest changing the descriptions:

oem-key 15.6.1.1

Current: A name for the entire data package. To comply with the data package standard it must consist of only lowercase alphanumeric character plus ".", "-" and "_". It may not start with a number. In a database, this will be the name of the table within the schema containing it. The name usually corresponds to the file name (minus the file-extension) of the data file describing the resource.

New: A name for the entire data package. The name must consist of only lowercase alphanumeric characters or underscore. It must not start with a number or underscore. In a database, this will be the name of the table within the schema containing it. The name can correspond to the file name (minus the file-extension) of the data file describing the resource, if it complies with the naming convention above. Name also contains information about the shema on the OEP, use "." to seperate shema from table name.

oem-key 15.2

Current: The name of the field.

New: 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.

If you agree, I'll go ahead and change the description on the dev branch. @jh-RLI

jh-RLI commented 1 year ago

I think the text at 15.2 should be at 15.6.1.1 and the other way around :D But i agree with your proposal.

chrwm commented 1 year ago

Yes you're right, ups.

Alright, I'll implement then:

oem-key 15.2

Current: A name for the entire data package. To comply with the data package standard it must consist of only lowercase alphanumeric character plus ".", "-" and "_". It may not start with a number. In a database, this will be the name of the table within the schema containing it. The name usually corresponds to the file name (minus the file-extension) of the data file describing the resource.

New: A name for the entire data package. The name must consist of only lowercase alphanumeric characters or underscore. It must not start with a number or underscore. In a database, this will be the name of the table within the schema containing it. The name can correspond to the file name (minus the file-extension) of the data file describing the resource, if it complies with the naming convention above. Name also contains information about the shema on the OEP, use "." to seperate shema from table name.

oem-key 15.6.1.1

Current: The name of the field.

New: 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.

chrwm commented 1 year ago

Closed with 29a2f69