Skip to content

OpenAPI spec update from glideapps/glide#30933 #32

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

Merged
merged 6 commits into from
Nov 22, 2024
Merged

Conversation

chkn
Copy link
Contributor

@chkn chkn commented Nov 19, 2024

Includes the OpenAPI spec updates from glideapps/glide#30933.

Please do the following:

  1. Review the spec changes in this PR and ensure they are documented appropriately. If needed, push any additional changes to glideapps/glide#30933.
  2. If the above should be accompanied by changes to other files in this repo, push them to this branch.
  3. When ready, enable auto-merge. Then, when glideapps/glide#30933 is released to prod, the blocked:unreleased label will be removed, and this PR will be automatically merged and published as well.

created with ❤️ by the API docs workflow

@chkn chkn added the blocked:unreleased The changes documented in this PR have not yet been released label Nov 19, 2024
Copy link
Contributor

This PR is being prevented from merging because it has one or more of these labels applied: blocked:unreleased.

Copy link
Contributor

github-actions bot commented Nov 19, 2024

It looks like you've made changes to the API docs! 🙌
☑️ The changelog has been updated 🎉
👉 You may want to preview the changes in a Codespace

@chkn chkn requested a review from rwdaigle November 20, 2024 15:53
Copy link
Contributor

@rwdaigle rwdaigle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we want to push this to Whalesync I'm good (only breaking API change might be the /rows path for table version).

But I think in general we need to beef up our docs with more tutorials content since there are quite a few new concepts here that are dependent on each other and it may not be clear to how to use them all together to accomplish the desired outcome.

@chkn
Copy link
Contributor Author

chkn commented Nov 21, 2024

If we want to push this to Whalesync I'm good (only breaking API change might be the /rows path for table version).

Yeah getting this over to Whalesync is my main goal.

Not sure what you mean by breaking change though? There is a new HEAD endpoint for rows, and I updated the GET endpoint docs to make the limit behavior clearer.

But I think in general we need to beef up our docs with more tutorials content since there are quite a few new concepts here that are dependent on each other and it may not be clear to how to use them all together to accomplish the desired outcome.

Totally agree. I think this PR is a good incremental improvement for now, but we should continue to flesh out the docs over time.

@chkn chkn enabled auto-merge November 22, 2024 13:10
@chkn chkn removed the blocked:unreleased The changes documented in this PR have not yet been released label Nov 22, 2024
@chkn chkn merged commit 4cd93b0 into main Nov 22, 2024
3 of 4 checks passed
@chkn chkn deleted the api-update-glide-pr-30933 branch November 25, 2024 12:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants