update API spec and add some tests for it - #600
Merged
Conversation
✅ Deploy Preview for grist-help-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
paulfitz
commented
Jan 29, 2026
paulfitz
marked this pull request as ready for review
January 30, 2026 04:09
georgegevoian
self-requested a review
February 5, 2026 06:57
This updates api/grist.yml based on setting a bot loose on the `grist-core` source code and asking it to look for undocumented endpoints or wrong information. To make sure the `yml` is solid OpenAPI code, the bot is directed to exercise the spec using `swagger-client`. The tests added are machine written, with human nudges to make them useful. The bot has limited understanding of Grist, but some sanity check of the `yml` seems much better than none. The bottleneck on keeping API docs up to date has been mostly developer time, it isn't a hard task, so this does seem a plausible job to offload. An alternative would be to change how endpoints are created in `grist-core` to make them self-documenting. This is still a possibility, but there isn't an obviously great way to do it.
paulfitz
force-pushed
the
paulfitz/flesh-out-apidocs
branch
from
February 5, 2026 15:40
cdbb47b to
4a1d3ac
Compare
georgegevoian
approved these changes
Feb 5, 2026
georgegevoian
left a comment
georgegevoian
left a comment
Collaborator
There was a problem hiding this comment.
Scanned the tests and they look reasonable. Thanks @paulfitz!
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This updates
api/grist.ymlbased on setting a bot loose on thegrist-coresource code and asking it to look for undocumented endpoints or wrong information.To make sure the
ymlis solid OpenAPI code, the bot is directed to exercise the spec usingswagger-client. The tests added are machine written, with human nudges to make them useful. The bot has limited understanding of Grist, but some sanity check of theymlseems much better than none.The bottleneck on keeping API docs up to date has been mostly developer time, it isn't a hard task, so this does seem a plausible job to offload. An alternative would be to change how endpoints are created in
grist-coreto make them self-documenting. This is still a possibility, but there isn't an obviously great way to do it.Remember, the point of this change is to flesh out
api/grist.yml, everything else is just to sanity-check it.