I’m trying to get my documentation in sync with the API described at https://api.crossref.org/ - it points readers to REST API filters - Crossref - which unfortunately lists some filters that DO NOT WORK with the actual API.
What I’m asking is could the documentation be in sync with the API somehow? Otherwise, I guess I can check every filter against the live API and see which give errors and which do not.
Thanks for reporting, this is an error in the documentation. We’ll remove has-description from the website. The other documented filters should work. You can also see a list of valid filters in the error response when you use an invalid filter.
Thanks. However, there’s more discrepancies. The following are all not in your docs, but are listed in the error response from the API. Could they be fully removed, or docs for them added to the documentation page?
Hi Scott. Thanks again, it looks like we need to do some tidying up. gte-citation and lte-citation seem to work but don’t do what you’d expect. We’ll take a look.
A cheap way to keep them in sync going forward: the error message on an invalid filter already returns the authoritative list, so a small scheduled script could fetch that list, diff it against the filters table on the documentation page, and flag anything added, removed or renamed. That would catch cases like has-description and directory before a reader has to report them, and it also gives you a natural place to note oddities such as gte-citation/lte-citation behaving unexpectedly. Worth folding into whatever cleanup ticket comes out of this.