ETT-1140 catalog needs a default error page -- Bib API side #112
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Right now this just has some tests for successful queries against `htid` and `recordnumber`. - TODO: handle any errors that make it thru the rewrite rules, in `static/api/volumes.php` - TODO: provide an `api/error.tpl` file for API queries that don't conform to a structure the rewrite rules can handle.
…ty` params, make sure it is set in `volumes.php` if not set. - Pass `brevity` parameter to `QObj` initializer so `$brevity` does not have to be flagged as a global variable.
… and htid-to-MARCXML facility.
aelkiss
approved these changes
Dec 23, 2025
… was being returned as HTML instead of `application/json`. - Fixed in `volumes.php` and tested in playwright. - Explicitly test emptiness of empty responses. - Add notes about the forms `records` may take in different JSON structures due to the stupidity of PHP.
Contributor
Author
|
@aelkiss this branch has been tested on dev-2 against the example API error URLs (found in the playwright tests) and none of them appear to produce anything in the error logs there. |
liseli
approved these changes
Dec 24, 2025
Contributor
liseli
left a comment
liseli
left a comment
There was a problem hiding this comment.
All these changes make sense, I've tested it locally and it works fine.
I've created this wiki to document the volume endpoint.
Please review it and probably update it with additional information after these changes.
Approved it
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
static/api/volumes.phpmodified to handle thebrevityparameter with an appropriate default even when unset. (May still cause errors on production API, not sure about the PHP 8-adjacent variants we have floating around.)api/error.tpl(which originate in handlePEARError [index.php]) for API queries that don't conform to a structure the rewrite rules can handle. This PR just bails out but we could consider putting some JSON in a template and pointing to it in the error handler -- if we wanted to provide something more developer-tailored for an API error.See also https://github.com/hathitrust/catalog/wiki/Volume-API which has been modified as a companion document to the work on the API tests.