Skip to content

Commit

Permalink
Merge branch 'develop' into feature-140-embargo
Browse files Browse the repository at this point in the history
  • Loading branch information
@jh-RLI
jh-RLI authored Oct 14, 2024
2 parents 7b671ce + a06b6be commit 7431514
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 163 deletions.
10 changes: 9 additions & 1 deletion CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,16 @@ Here is a template for new release sections
- We use json schema $ref elements to reference the schema modules and we provide code to resolve the reference´s and generate the complete schema.json.

- Add code to generate a example.json based on the schema.json. We read the example values for each of the fields specified in the schema and generate the example. [#???](https://github.com/OpenEnergyPlatform/oemetadata/pull/)

- Add embargoPeriod section with keys start, end, isActive [(#155)](https://github.com/OpenEnergyPlatform/oemetadata/pull/155)

- Add path to contributors [(#157)](https://github.com/OpenEnergyPlatform/oemetadata/pull/157)

- Add organization to contributors [(#157)](https://github.com/OpenEnergyPlatform/oemetadata/pull/157)

- Add roles to contributors [(#157)](https://github.com/OpenEnergyPlatform/oemetadata/pull/157)


### 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 All @@ -50,7 +58,7 @@ Here is a template for new release sections

### Removed

-
- Remove email from contributors [(#157)](https://github.com/OpenEnergyPlatform/oemetadata/pull/157)

## [1.6.0] - Release - Introduce badges in json schema - 2023-05-30

Expand Down
194 changes: 35 additions & 159 deletions metadata/v200_draft/build_source/schemas/provenance.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,182 +7,58 @@
"description": "An object that specifies provenance information of the data contained.",
"type": "object",
"properties": {
"alternateOf": {
"description": "A PID pointing to another FAIR Digital Object which is an alternate of the object referenced by digitalObjectLocation",
"example": "12.T34567/abcdefghij1234567890",
"type": [
"string",
"null"
],
"badge": null,
"title": "Alternate of"
},
"checksum": {
"description": "A checksum used to validate the integrity of the data.",
"example": "abcdefghij1234567890",
"type": [
"string",
"null"
],
"badge": null,
"title": "Checksum"
},
"dateModified": {
"description": "Date of the last modification. Date Format is ISO 8601.",
"example": "2016-06-16",
"type": [
"string",
"null"
],
"badge": null,
"title": "Last modified"
},
"digtalObjectLocationAccessProtocol": {
"description": "Additional information which can be used by an access client for accessing",
"example": null,
"type": [
"string",
"null"
],
"badge": null,
"title": "Digital Object Location Access Protocol"
},
"digitalObjectType": {
"description": "A PID pointing to a data type in a Data Type Registry describing the object referenced by digtalObject Location",
"example": "12.T34567/abcdefghij1234567890",
"type": [
"string",
"null"
],
"badge": null,
"title": "Digital Object Type"
},
"hadPrimarySource": {
"description": "A PID pointing to another FAIR DO which is the primary source of the object referenced by digitalObjectLocation",
"example": "12.T34567/abcdefghij1234567890",
"type": [
"string",
"null"
],
"badge": null,
"title": "Primary Source"
},
"hasMetadata": {
"description": "One or more PIDs referring to related FAIR Digital Objects provding metadata for the object referenced by digitalObjectLocation. It is the innverse to isMetadata for",
"example": "12.T34567/abcdefghij1234567890",
"type": [
"string",
"null"
],
"badge": null,
"title": "Has Metadata"
},
"isMetadataFor": {
"description": "A PID pointing to another FAIR Digital Object decribing the object referenced by digitalObjectLocation. It is the inverse to hasMetadata",
"example": "12.T34567/abcdefghij1234567890",
"type": [
"string",
"null"
],
"badge": null,
"title": "Is Metadata for"
},
"policy": {
"description": "A web-resolveable pointer to a policy object describing e.g. object access and modification policies",
"example": "https://www.example.com",
"type": [
"string",
"null"
],
"badge": null,
"title": "Policy"
},
"provenanceGraph": {
"description": "A PID pointing to another FAIR DO which refers to the provenance graph of the object referenced by digitalObjectLocation",
"example": "12.T34567/abcdefghij1234567890",
"type": [
"string",
"null"
],
"badge": null,
"title": "Provenance Graph"
},
"specializationOf": {
"description": "A PID pointing to another FAIR DO which is a specialization of the object referenced by digitalObjectLocation",
"example": "12.T34567/abcdefghij1234567890",
"type": [
"string",
"null"
],
"badge": null,
"title": "Specialization of"
},
"version": {
"description": "Version of the object referenced by digitalObjectLocation",
"example": "1.2.3",
"type": [
"string",
"null"
],
"badge": null,
"title": "Version"
},

"wasDerivedFrom": {
"description": "A PID pointing to another FAIR Digital Object which the object referenced by digitalObjectLocation was derived from",
"example": "12.T34567/abcdefghij1234567890",
"type": [
"string",
"null"
],
"badge": null,
"title": "Was derived from"
},
"wasRevisionOf": {
"description": "A PID pointing to another FAIR DO which is a revisionof the object referenced by digitalObjectLocation",
"example": "12.T34567/abcdefghij1234567890",
"type": [
"string",
"null"
],
"badge": null,
"title": "Was Revision of"
},
"wasQuotedFrom": {
"description": "A PID pointing to another FAIR DO from which the object referenced by digitalObjectLocation was folly or partly quoted.",
"example": "12.T34567/abcdefghij1234567890",
"type": [
"string",
"null"
],
"badge": null,
"title": "Was quoted from"
},
"contributors": {
"description": "A list of objects that describe contributors and contributions. It contains title, email, date, object and comment.",
"description": "A list of objects that describe contributors and contributions. It contains title, path, organization, roles, date, object and comment.",
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"description": "Name/title of the contributor (name for a person, name or title for an organization).",
"example": "John Doe",
"description": "A full Name of the contributor.",
"example": "Ludwig Hülk",
"type": [
"string",
"null"
],
"badge": null,
"title": "Title"
},
"email": {
"description": "E-mail address of the contributor.",
"example": "contact@example.com",
"path": {
"description": "A qualified URL pointing to a relevant location online for the contributor. This can be the GitHub page or ORCID.",
"example": "https://github.com/Ludee",
"type": [
"string",
"null"
],
"badge": null,
"title": "Email"
"title": "Path"
},
"organization": {
"description": "A string describing the organization this contributor is affiliated to. This can be relevant for the copyright.",
"example": "Reiner Lemoine Institut",
"type": [
"string",
"null"
],
"badge": null,
"title": "Organization"
},
"roles": {
"description": "An array of strings describing the roles of the contributor.",
"example": "[creator, dataCurator]",
"type": "array",
"items": {
"description": "A role is RECOMMENDED to follow an established vocabulary, such as DataCite Metadata Schema’s contributorRole or CreDIT. Useful roles to indicate are: creator, contact, and dataCurator.",
"example": "creator",
"type": [
"string",
"null"
],
"badge": null,
"title": "Role"
},
"badge": null,
"title": "Roles"
},
"date": {
"description": "Date of the contribution. If the contribution took more than a day, use the date of the final contribiution. Date Format is ISO 8601.",
Expand Down Expand Up @@ -227,4 +103,4 @@
"additionalProperties": false
}
}
}
}
8 changes: 5 additions & 3 deletions metadata/v200_draft/metadata_key_description.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,11 +107,13 @@ The JSON format offers different formats:
|#|Key |Description |Example |
|---|---|---|---|
| 14 | **contributors** | An array of objects of the people or organizations who contributed to the data or metadata. Each object refers to one contributor. Every contributor must have a title and property. The path, email, role and organization properties are optional. | |
| 14.1 | title | A name of the contributor. | Ludwig Hülk |
| 14.2 | email | A email address of the contributor or GitHub handle. | @Ludee |
| 14.1 | title | A full Name of the contributor. | Ludwig Hülk |
| 14.2 | path | A qualified URL pointing to a relevant location online for the contributor. This can be the GitHub page or ORCID. | https://github.com/Ludee |
| 14.2 | organization | A string describing the organization this contributor is affiliated to. This can be relevant for the copyright. | Reiner Lemoine Institut |
| 14.2 | roles | An array of strings describing the roles of the contributor. A role is RECOMMENDED to follow an established vocabulary, such as DataCite Metadata Schema’s contributorRole or CreDIT. Useful roles to indicate are: creator, contact, and dataCurator. | creator, dataCurator |
| 14.3 | date | The date of the contribution. If the contribution took more than a day, use the date of the final contribiution. Date Format is ISO 8601. | 2016-06-16 |
| 14.4 | object | The target of the contribution. Which part of the package was supplied or changed. Can be the data, metadata or both (data and metadata). | data and metadata |
| 14.5 | comment | A free text commentary on what has been done. | Fixed a typo in the title. |
| 14.5 | comment | A free text commentary on what has been done. | Updated the description. |

### Resource Keys
|#|Key |Description |Example |
Expand Down

0 comments on commit 7431514

Please sign in to comment.