Content Comparison

...

Note: The GET /doi and /doi/association only allow to fetch a single DOI/Associations for an entity in the context of a portal or synapse.org, we might need a new set of API to fetch all the minted DOIs/Associations given just an entity since the current API is not compatible with a list of DOI/Associations. It is not clear if the portal DOIs should be shown on synapse.org.Note however that an entity bundle includes DOI association information (see below).

Entity Bundle API

The entity API bundle API can include in the response the DOI association, if includeDOIAssociation is set to true in the request body then the response will include a property doiAssociation with the potential DOI association information. To support the multiple DOIs we should include a new doiAssociations that is a list of all the DOI associations (the doiAssociation property will contain the Synapse.org association if any):

{
	"description": "Bundle to transport an Entity and related data objects",
	"properties": {
		...
		"doiAssociation": {
			"description": "Contains the DOI association with Synapse.org if any."
			"$ref": "org.sagebionetworks.repo.model.doi.v2.DoiAssociation"
		},
		"doiAssociations": {
			"description": "All the DOI associations for the entity, including Synapse.org and any portal specific DOI."
			"type": "array",
			"items": {
				"$ref": "org.sagebionetworks.repo.model.doi.v2.DoiAssociation"
			}
		},
		...
	}
}