...
We should strongly consider deprecating these calls in favor of the new API, see below section 'API Additions'
URL | HTTP Type | Description | Response Object |
|---|---|---|---|
| /entity/{id}/doi | PUT | Creates a DOI for the specified entity. The DOI will associated with the most recent version where applicable. | Doi |
| /entity/{id}/version/{versionNumber}/doi | PUT | Creates a new DOI for the specified entity version. | Doi |
| /entity/{id}/doi | GET | Gets the DOI status for the specified entity. | Doi |
| /entity/{id}/version/{versionNumber}/doi | GET | Gets the DOI status for the specified entity version. | Doi |
Proposed Changes
Object changes:
- Creation of new Doi (v2) data transfer object that implements new interface DataciteMetadata and new class DoiAssociation
- DataciteMetadata
- Separates DOI metadata (that is stored by DataCite) from Synapse-associated metadata
- The client never uses this object, but it clearly delineates metadata that DataCite stores and metadata Synapse stores (in DoiAssociation)
- DoiAssociation
- Stores data that describes a Synapse object's association with a DOI object (like the object ID, type, version, etag, etc.)
- Client can request this object to quickly get a DOI without relying on DataCite service availability to collect additional metadata.
- We can return the DOI URI and URL to the client (currently, the URI is "guessed" by the client)
- By using Doi (v2):
- The client can supply and update metadata
- We have the option to extend support to additional metadata fields
- We decouple our API URI from /entity/{id}
- We have the option to extend support to mint DOIs for non-entity objects in Synapse
- DataciteMetadata
- Creation of DoiRequest object to retrieve a DOI and all of its metadata
The new fields in object is a direct mapping of the most recent version (v4.1) of DataCite's metadata schema, simplified to contain only required fields and a small amount of optional fields that we curate. This ensures that we don't need to deprecate our API if we wish to support more of their optional metadata fields. If we do wish to support new optional metadata fields, we can easily extend our object.
Similarly, this is likely to simplify future transitions if DataCite deprecates the schema that we configure to use.
DataCite-imposed constraints for implementing clients to consider:
- There cannot be more than 8000-10000 creators
- Publication year must be in 'YYYY' format (regex:
/[\d]{4}/) - There must be at least one creator
- Each creator must have a creatorName that is at least 1 character long
- nameIdentifier is not required, but if an identifier is provided, the scheme must also be provided
- There must be at least one title
- The title should be at least one character long
- There must be a resourceTypeGeneral
- One of the following
- Audiovisual
- Collection
- Data Paper
- Dataset
- Event
- Image
- Interactive Resource
- Model
- Physical Object
- Service
- Software
- Sound
- Text
- Workflow
- Other
- One of the following
API Additions
| URL | HTTP Verb | Description | Request Object | Response Object | Notes |
|---|---|---|---|---|---|
| /doi/async/start | POST | Asynchronously create or update a DOI. If the DOI does not exist, start a DOI creation job that will attempt to register a DOI with the DOI provider with the supplied metadata. If the DOI does exist, then it will simply update the DOI with the supplied metadata. Note: The caller must have the ACCESS_TYPE.UPDATE permission on the Entity to make this call. | Doi (application/json) | Shift the work to an asynchronous worker queue (as we have been doing with other asynchronous services). We combine the create and update calls because they require the same information and are both idempotent. The Doi object must contain all fields required to mint or update a DOI with DataCite. | |
| /doi/async/get/{asyncToken} | GET | Asynchronously get the results of a DOI transaction started with POST /doi/async/start Note: When the result is not ready yet, this method will return a status code of 202 (ACCEPTED) and the response body will be a AsynchronousJobStatus object. | None | Get the status of the asynchronous job. If complete, returns the Doi object created by the job. | |
| /doi | GET | Get a Doi object (including associated metadata) for the object referred to in DoiRequest, if the Doi object exists. | None (supply required path parameters id, objectType, and optional objectVersion) | Doi | This call relies on availability of DataCite's API to return the metadata, as we do not store it. |
| /doi/association | GET | Get a DoiAssociation object that contains the DOI of an object referred to in DOI. | None (supply required path parameters id, objectType, and optional objectVersion) | DoiAssociation | By making this call, a client can get the DOI of an object without certain metadata that relies on availability of DataCite's API. |
| /doi/locate | GET | Redirect to a specific object in the web portal, or a "Not found" page if the object cannot be located. | None (supply required path parameters id, objectType, and optional objectVersion) | Redirect | This redirects a URL that we supply to DataCite to the current URL of an associated object. This allows us to register a more "permanent" URL with DataCite in case the URL to an object changes. For example, http://synapse.org/#!Synapse:syn123 may change and become http://sage.gov/syn123. This service can be updated to support that and as a result, the DOI does not break. |
...