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

Improve id/DOI documentation #1078

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve id/DOI documentation #1078

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions profiles/dictionary/common.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ name:
id:
title: ID
description: A property reserved for globally unique identifiers. Examples of
identifiers that are unique include UUIDs and DOIs.
identifiers that are unique include UUIDs and DOI links.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
identifiers that are unique include UUIDs and DOI links.
identifiers that are unique include UUIDs and DOIs.

Reverting this one, it is fine to just call it DOIs here.

context: A common usage pattern for Data Packages is as a packaging format within
the bounds of a system or platform. In these cases, a unique identifier for
a package is desired for common data handling workflows, such as updating an
existing package. While at the level of the specification, global uniqueness
cannot be validated, consumers using the `id` property `MUST` ensure identifiers
are globally unique.
are globally unique. When using a DOI, specify the full DOI link.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
are globally unique. When using a DOI, specify the full DOI link.
are globally unique. When providing a DOI, it is `RECOMMENDED` to provide the full URL (e.g. `https://doi.org/10.5281/zenodo.10053903`).

type: string
examples:
- |
Expand Down