From 023b8047d47ae5be8aae15c15ecaaaaf10edd701 Mon Sep 17 00:00:00 2001 From: roll Date: Fri, 26 Jan 2024 11:06:20 +0000 Subject: [PATCH 1/7] Updted the spec --- content/docs/specifications/data-package.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/content/docs/specifications/data-package.md b/content/docs/specifications/data-package.md index a9e5392b..0fe06297 100644 --- a/content/docs/specifications/data-package.md +++ b/content/docs/specifications/data-package.md @@ -255,24 +255,28 @@ The raw sources for this data package. It `MUST` be an array of Source objects. ##### `contributors` -The people or organizations who contributed to this Data Package. It `MUST` be an array. Each entry is a Contributor and `MUST` be an `object`. A Contributor `MUST` have at least one property. A Contributor is RECOMMENDED to have `title` property and MAY contain `path`, `email`, `role`, and `organization` properties. An example of the object structure is as follows: +The people or organizations who contributed to this Data Package. It `MUST` be an array. Each entry is a Contributor and `MUST` be an `object`. A Contributor `MUST` have at least one property. A Contributor is RECOMMENDED to have `title` property and MAY contain `path`, `email`, `roles`, and `organization` properties. An example of the object structure is as follows: -```javascript +```json "contributors": [{ "title": "Joe Bloggs", "email": "joe@bloggs.com", "path": "http://www.bloggs.com", - "role": "author" + "roles": ["author"] }] ``` - `title`: name/title of the contributor (name for person, name/title of organization) - `path`: a fully qualified http URL pointing to a relevant location online for the contributor - `email`: An email address -- `role`: a string describing the role of the contributor. It's `RECOMMENDED` to be one of: `author`, `publisher`, `maintainer`, `wrangler`, and `contributor`. Defaults to `contributor`. +- `roles`: an array of strings describing the roles of the contributor. A role is `RECOMMENDED` to be one of: `author`, `publisher`, `maintainer`, `wrangler`, and `contributor`. The default role is `contributor`. - Note on semantics: use of the "author" property does not imply that that person was the original creator of the data in the data package - merely that they created and/or maintain the data package. It is common for data packages to "package" up data from elsewhere. The original origin of the data can be indicated with the `sources` property - see above. - `organization`: a string describing the organization this contributor is affiliated to. +:::note[Backward Compatibility] +If the `roles` property is not provided a data consumer MUST fall back to using `role` property which was a part of the `v1.0` of the specification +::: + ##### `keywords` An Array of string keywords to assist users searching for the package in catalogs. From 1682871b4600b3f33a7ed832a1f16f13fcbae93b Mon Sep 17 00:00:00 2001 From: roll Date: Fri, 26 Jan 2024 11:09:54 +0000 Subject: [PATCH 2/7] Updated the profile --- profiles/dictionary/common.yaml | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/profiles/dictionary/common.yaml b/profiles/dictionary/common.yaml index f89ccf8a..4748b57b 100644 --- a/profiles/dictionary/common.yaml +++ b/profiles/dictionary/common.yaml @@ -196,9 +196,11 @@ contributor: title: Organization description: An organizational affiliation for this contributor. type: string - role: - type: string - default: contributor + roles: + type: array + minItems: 1 + items: + type: string minProperties: 1 context: Use of this property does not imply that the person was the original creator of, or a contributor to, the data in the descriptor, but refers to the From 9462f5baa1415ac653004ff91303e4b731d30706 Mon Sep 17 00:00:00 2001 From: roll Date: Fri, 26 Jan 2024 11:14:15 +0000 Subject: [PATCH 3/7] Updated wording --- content/docs/specifications/data-package.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/specifications/data-package.md b/content/docs/specifications/data-package.md index 0fe06297..47e73d02 100644 --- a/content/docs/specifications/data-package.md +++ b/content/docs/specifications/data-package.md @@ -274,7 +274,7 @@ The people or organizations who contributed to this Data Package. It `MUST` be a - `organization`: a string describing the organization this contributor is affiliated to. :::note[Backward Compatibility] -If the `roles` property is not provided a data consumer MUST fall back to using `role` property which was a part of the `v1.0` of the specification +If the `roles` property is not provided a data consumer MUST fall back to using `role` property which was a part of the `v1.0` of the specification. This property has the same symantics but it is a string allowing to specify only a single role ::: ##### `keywords` From 908c810a0c7de9839d00b9ed46b75fa431887a39 Mon Sep 17 00:00:00 2001 From: roll Date: Tue, 20 Feb 2024 11:59:16 +0000 Subject: [PATCH 4/7] Fixed type Co-authored-by: Peter Desmet --- content/docs/specifications/data-package.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/specifications/data-package.md b/content/docs/specifications/data-package.md index 47e73d02..bf57fb32 100644 --- a/content/docs/specifications/data-package.md +++ b/content/docs/specifications/data-package.md @@ -274,7 +274,7 @@ The people or organizations who contributed to this Data Package. It `MUST` be a - `organization`: a string describing the organization this contributor is affiliated to. :::note[Backward Compatibility] -If the `roles` property is not provided a data consumer MUST fall back to using `role` property which was a part of the `v1.0` of the specification. This property has the same symantics but it is a string allowing to specify only a single role +If the `roles` property is not provided a data consumer MUST fall back to using `role` property which was a part of the `v1.0` of the specification. This property has the same semantics but it is a string allowing to specify only a single role. ::: ##### `keywords` From 1751679e91db79e10a774e7e163fd098f78230de Mon Sep 17 00:00:00 2001 From: roll Date: Mon, 18 Mar 2024 14:25:28 +0000 Subject: [PATCH 5/7] Updated `contributor.roles` --- content/docs/specifications/data-package.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/content/docs/specifications/data-package.md b/content/docs/specifications/data-package.md index 61753d91..a4aebf55 100644 --- a/content/docs/specifications/data-package.md +++ b/content/docs/specifications/data-package.md @@ -273,10 +273,11 @@ The people or organizations who contributed to this Data Package. It `MUST` be a - `familyName`: familial name that a person inherits, if the contributor is a person. - `path`: a fully qualified http URL pointing to a relevant location online for the contributor - `email`: An email address -- `roles`: an array of strings describing the roles of the contributor. A role is `RECOMMENDED` to be one of: `author`, `publisher`, `maintainer`, `wrangler`, and `contributor`. The default role is `contributor`. - - Note on semantics: use of the "author" property does not imply that that person was the original creator of the data in the data package - merely that they created and/or maintain the data package. It is common for data packages to "package" up data from elsewhere. The original origin of the data can be indicated with the `sources` property - see above. +- `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](https://support.datacite.org/docs/datacite-metadata-schema-v44-recommended-and-optional-properties#7a-contributortype) or [CreDIT](https://credit.niso.org/). Useful roles to indicate are: creator, contact, rightsHolder, and dataCurator. - `organization`: a string describing the organization this contributor is affiliated to. +Use of the "creator" role does not imply that that person was the original creator of the data in the data package - merely that they created and/or maintain the data package. It is common for data packages to "package" up data from elsewhere. The original origin of the data can be indicated with the `sources` property - see above. + References: - [Citation Style Language](https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html#name-fields) From 6896a9b13c865fecc2815e95e093f4285ef45554 Mon Sep 17 00:00:00 2001 From: roll Date: Mon, 18 Mar 2024 14:26:40 +0000 Subject: [PATCH 6/7] Updated example --- content/docs/specifications/data-package.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/specifications/data-package.md b/content/docs/specifications/data-package.md index a4aebf55..291089ac 100644 --- a/content/docs/specifications/data-package.md +++ b/content/docs/specifications/data-package.md @@ -264,7 +264,7 @@ The people or organizations who contributed to this Data Package. It `MUST` be a "title": "Joe Bloggs", "email": "joe@bloggs.com", "path": "http://www.bloggs.com", - "roles": ["author"] + "roles": ["creator"] }] ``` From 48eb4e7d23b16b78d670b79c5c7bd766678188b1 Mon Sep 17 00:00:00 2001 From: roll Date: Thu, 28 Mar 2024 08:59:53 +0000 Subject: [PATCH 7/7] Update content/docs/specifications/data-package.md Co-authored-by: Peter Desmet --- content/docs/specifications/data-package.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/specifications/data-package.md b/content/docs/specifications/data-package.md index c990e9eb..fecfca55 100644 --- a/content/docs/specifications/data-package.md +++ b/content/docs/specifications/data-package.md @@ -273,7 +273,7 @@ The people or organizations who contributed to this Data Package. It `MUST` be a - `familyName`: familial name that a person inherits, if the contributor is a person. - `path`: a fully qualified http URL pointing to a relevant location online for the contributor - `email`: An email address -- `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](https://support.datacite.org/docs/datacite-metadata-schema-v44-recommended-and-optional-properties#7a-contributortype) or [CreDIT](https://credit.niso.org/). Useful roles to indicate are: creator, contact, rightsHolder, and dataCurator. +- `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](https://support.datacite.org/docs/datacite-metadata-schema-v44-recommended-and-optional-properties#7a-contributortype) or [CreDIT](https://credit.niso.org/). Useful roles to indicate are: `creator`, `contact`, `rightsHolder`, and `dataCurator`. - `organization`: a string describing the organization this contributor is affiliated to. Use of the "creator" role does not imply that that person was the original creator of the data in the data package - merely that they created and/or maintain the data package. It is common for data packages to "package" up data from elsewhere. The original origin of the data can be indicated with the `sources` property - see above.