CrossRef / rest-api-doc

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

API documentation #260

Open henridewinter opened 7 years ago

henridewinter commented 7 years ago

It seems to me that the documentation is out of sync with the API JSON result, e.g. the JSON returns information about references which is not documented. Is there somewhere a newer and more actual version of the documentation?

I used https://api.crossref.org/works?query.bibliographic=vosviewer to find out about these results.

kjw commented 7 years ago

I think that documentation is missing information about references and relations. Will add.

henridewinter commented 7 years ago

Can you tell me the difference between reference-count field and references-count field in the work JSON. They seem to have the same value.

henridewinter commented 7 years ago

Structure changes 2017-8.xlsx

This is an Excel file with fields I've found in the current JSON that are not in the documentation.

kjw commented 7 years ago

They are the same, there's been a slight naming change, but the old field is still there for backwards compatibility.

kjw commented 7 years ago

Thanks for the spreadsheet đź‘Ť

henridewinter commented 7 years ago

Hi Karl Jonathan,

Thank you for updating the documentation.

I still have one question about the documentation. In the JSON I see this for the relation field:

relation: { cites: [ ] }

I can’t seem to find a work where the cites array is filled. Maybe you can tell me what the type of the array is?

kind regards,

Henri de Winter

From: Karl Jonathan Ward [mailto:notifications@github.com] Sent: dinsdag 8 augustus 2017 16:18 To: CrossRef/rest-api-doc Cc: Winter, H.G.C.M. de; Author Subject: Re: [CrossRef/rest-api-doc] API documentation (#260)

Closed #260https://github.com/CrossRef/rest-api-doc/issues/260 via e93f80chttps://github.com/CrossRef/rest-api-doc/commit/e93f80cc12fb08cad907c6d88cdd94d2e7b2c3fd.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHubhttps://github.com/CrossRef/rest-api-doc/issues/260#event-1197309913, or mute the threadhttps://github.com/notifications/unsubscribe-auth/AIDCbuharKAQ1BQma21jVdt6_2YLB5xSks5sWG4tgaJpZM4OwbuH.

jenniferlin15 commented 7 years ago

reopening issue to address followup question