DEV-991 Rights API: Return Standard Results Structure #3
Conversation
This file contains 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
- Add `RightsAPI::Result` with basic count and pagination fields, as well as `data` array. - Not clear that `message` is of use here yet because we don't parse query parameters (yet). - Prevent clutter and repetition by introducing `Schema` class to account for `ht_rights` quirks. - Major redesign of `query.rb` as a class. - All tables are now treated the same as `rights_*` in that `SELECT` is invoked. - Previously `RightsDatabase` methods were faked up as datasets. - Tables have a default sort order. - Enable Sequel logging when running as web service. - Remove "usage" landing page that looked like crap in JSON and was not worth the upkeep. - Did not expand the tests since DEV-992 is imminent and there is enough churn as is.
|
Note to self: update README |
aelkiss
reviewed
Dec 12, 2023
There was a problem hiding this comment.
Overall I think this makes sense; however, I would like to see some sense in the tests of what the expected format of the data returned is - right now for example it's not clear to me if a query to /v1/rights/:id would return the symbolic names for the attribute & value (which is what I would sort of expect from an API) or if it would return the numeric value (if it's just serializing rows directly from the database) -- I guess e.g. https://github.com/hathitrust/rights_api/blob/51cf84810a1738bc6a348615d00d895a931976e0/lib/rights_api/schema/rights_schema.rb is the abstraction on top of the database layer, and I think it would be good if that had a test
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.
RightsAPI::Resultwith basic count and pagination fields, as well asdataarray.result[:message]is of use here yet because we don't parse query parameters.Schemaclass to account forht_rightsquirks.query.rbas a class.rights_*in thatSELECTis invoked more directly.RightsDatabasemethods were used to simulate datasets. (RightsDatabasewill be going away.)