Open
Description
Is it possible to make terminology consistent across the parameters in the API?
For example, the parameter is called 'type' in filter and select, but 'type-name' when used in facet.
This makes it quite hard to hand-write API queries, as I'm never sure whether I've got the right parameter name until I run the query. Here's a table of the discrepancies that regularly trip me up, as they're different or missing across different parameters:
filter | select | facet |
---|---|---|
doi | DOI | |
isbn | ISBN | |
issn | ISSN | issn |
issue | journal-issue | |
orcid | orcid | |
prefix | prefix | |
publisher | publisher-name | |
relation.type | relation-type | |
type | type | |
type-name* | type-name | |
volume | journal-volume |
*Although 'type-name' is permitted as a filter parameter, it doesn't return any results. Compare:
https://api.crossref.org/works/?rows=0&filter=type-name:book-chapter
https://api.crossref.org/works/?rows=0&filter=type:book-chapter