Editor / Associated resources panel / Extend DOI to support Crossref in addition to Datacite searches

[josegar74]

Follow up of #7669.

For associated resources, enable DOI search of CrossRef DOI providers. Previously only DataCite providers were supported.

Can be configured to search both types of providers or only one of them. When both types of providers are configured, results from both are combined in the results list.

Configuration:

• doiapi source types: doiapi, crossref
• prefix: DOI prefix for of the DOI resources to search.

For each type of source:

• url: API end-point.
• params: search parameters. Currently supported query value, with the query to use. It allows the following placeholders:
  • {query}: replaced with the text entered in the search field.
  • {prefix}: replaced with the DOI prefix configured.

Example configuration for both providers: Datacite and CrossRef

{
    "fields": {
        "associationType": "crossReference",
        "initiativeType": "platform"
    },
    "sources": {"doiapi": {
        "prefix": "10.1111",
        "datacite": {
            "url": "https://api.datacite.org/dois",
            "params": {"query": "titles.title:{query}* OR doi:{query} OR id:{query}"}
        },
        "crossref": {
            "url": "https://api.crossref.org/works?select=DOI%2Ctitle%2Ctype%2Cprefix%2Cabstract%2CURL",
            "params": {"query": "rows=10&query={prefix}%2F{query}&filter=doi%3A{prefix}%2F{query}"}
        }
    }}
}

Example configuration only for Datacite provider

{
    "fields": {
        "associationType": "crossReference",
        "initiativeType": "platform"
    },
    "sources": {"doiapi": {
        "prefix": "10.1111",
        "datacite": {
            "url": "https://api.datacite.org/dois",
            "params": {"query": "titles.title:{query}* OR doi:{query} OR id:{query}"}
        }
    }}
}

Example configuration only for Crossref provider

{
    "fields": {
        "associationType": "crossReference",
        "initiativeType": "platform"
    },
    "sources": {"doiapi": {
        "prefix": "10.1111",
        "crossref": {
            "url": "https://api.crossref.org/works?select=DOI%2Ctitle%2Ctype%2Cprefix%2Cabstract%2CURL",
            "params": {"query": "rows=10&query={prefix}%2F{query}&filter=doi%3A{prefix}%2F{query}"}
        }
    }}
}

Checklist

• I have read the contribution guidelines
• Pull request provided for main branch, backports managed with label
• Good housekeeping of code, cleaning up comments, tests, and documentation
• Clean commit history broken into understandable chucks, avoiding big commits with hundreds of files, cautious of reformatting and whitespace changes
• Clean commit messages, longer verbose messages are encouraged
• API Changes are identified in commit messages
• Testing provided for features or enhancements using automatic tests
• User documentation provided for new features or enhancements in manual
• Build documentation provided for development instructions in README.md files
• Library management using pom.xml dependency management. Update build documentation with intended library use and library tutorials or documentation

Funded by Ifremer

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud