search

CrossRef / rest-api-doc

Documentation for Crossref's REST API. For questions or suggestions, see https://community.crossref.org/
Other
721 stars 270 forks source link

'Label' instead of 'ID' for facet 'type-name' - API #559

Closed AkshayBhanawala closed 3 years ago

AkshayBhanawala commented 3 years ago

A difference I saw in API response in facet.

While the documentation here says that 'type-name' facet will be 'ID', but instead it'll return 'label' values.

Facet name Maximum values Description
type-name *``** Work type name, such as journal-article or book-chapter

The given Facet URL will be enough to show it.

https://api.crossref.org/works?rows=0&facet=type-name:*

it should be returning IDs like

but it returns

One more about the same stuff is, type-name 'Labels' in following URL,

https://api.crossref.org/types

not all match with labels in 

https://api.crossref.org/works?rows=0&facet=type-name:*

As one example look at Book Chapter in types list API endpoint and try to look same in facet list for type-name. in here, it'll be given as Chapter only.

Also in documentation it's written as book-chap instead of book-chapter

Just some small stuff..

ppolischuk commented 3 years ago

Looks like a lot overlap with this issue. I've pasted your details there as well. We'll try to cover it as part of that issue.