-
Notifications
You must be signed in to change notification settings - Fork 7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add support for '/_fields' endpoint #104
Conversation
We'll drop the /_infos endpoint, so let's not add it here |
Codecov Report
@@ Coverage Diff @@
## main #104 +/- ##
==========================================
+ Coverage 71.85% 71.91% +0.06%
==========================================
Files 41 41
Lines 1304 1314 +10
==========================================
+ Hits 937 945 +8
- Misses 222 223 +1
- Partials 145 146 +1
Continue to review full report at Codecov.
|
This is ready for review and can be merged when CI passes on staging. |
46c467e
to
51e6ab6
Compare
Updated to PR description to reflect the latest state of the discussion. I re-ran tests and made some minor adjustments. |
2f60b98
to
a2e7d76
Compare
6e67a49
to
3122fa8
Compare
3122fa8
to
40863e8
Compare
This PR/issue depends on:
|
This is finally ready to merge! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
This has long been outstanding but went unnoticed: There has been a new/_info
endpoint for a while, now. This is basically a list of dataset infos as returned by a normal call to:id/info
. The/_stats
call shares the same response model, apart from omitting the fields so this was never an issue. But it is desirable to have the separate call available.I was able to refactor this slightly to compensate for the missing fields and enhanced the documentation along the way.As explained by @mhr3, the/_info
endpoint is deprecated and - after discussion - will be replaced by/_fields
. The rest of the information that could be obtained through/_info
is still available through/_stats
. The recent commit accounts for that change but I kept the improvements to theDatasetInfo
andDatasetStats
types as well as the documentation improvements. Until the change is live, this PR will remain in draft status.After more evaluation, there will be one new endpoint introduced with this PR:
/_fields
, for retrieving fields of all datasets of a deployment. However, in addition,/_info
is deleted as it is essentially the infomration provided by/_fields
plus some information only useful for the frontend but not actual costumers. The recent commit accounts for that change but I kept the improvements to theDatasetInfo
andDatasetStats
types as well as the documentation improvements. Until the change is live, this PR will remain in draft status.Needs #106.