You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@polaris.apache.org by "adutra (via GitHub)" <gi...@apache.org> on 2026/02/10 18:25:39 UTC
[PR] Update the generated OpenAPI spec bundle [polaris]
adutra opened a new pull request, #3732:
URL: https://github.com/apache/polaris/pull/3732
It was out of sync.
The changes in this PR are the result of running:
```
redocly bundle spec/polaris-catalog-service.yaml -o spec/generated/bundled-polaris-catalog-service.yaml
```
<!--
๐ Describe what changes you're proposing, especially breaking or user-facing changes.
๐ See https://github.com/apache/polaris/blob/main/CONTRIBUTING.md for more.
-->
## Checklist
- [ ] ๐ก๏ธ Don't disclose security issues! (contact security@apache.org)
- [ ] ๐ Clearly explained why the changes are needed, or linked related issues: Fixes #
- [ ] ๐งช Added/updated tests with good coverage, or manually tested (and explained how)
- [ ] ๐ก Added comments for complex logic
- [ ] ๐งพ Updated `CHANGELOG.md` (if needed)
- [ ] ๐ Updated documentation in `site/content/in-dev/unreleased` (if needed)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update the generated OpenAPI spec bundle [polaris]
Posted by "adutra (via GitHub)" <gi...@apache.org>.
adutra merged PR #3732:
URL: https://github.com/apache/polaris/pull/3732
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update the generated OpenAPI spec bundle [polaris]
Posted by "dimas-b (via GitHub)" <gi...@apache.org>.
dimas-b commented on code in PR #3732:
URL: https://github.com/apache/polaris/pull/3732#discussion_r2790738108
##########
spec/generated/bundled-polaris-catalog-service.yaml:
##########
Review Comment:
I was thinking about generating it at docs build time :thinking:
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update the generated OpenAPI spec bundle [polaris]
Posted by "adutra (via GitHub)" <gi...@apache.org>.
adutra commented on code in PR #3732:
URL: https://github.com/apache/polaris/pull/3732#discussion_r2790111132
##########
spec/generated/bundled-polaris-catalog-service.yaml:
##########
Review Comment:
Docs only, from what I could find.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update the generated OpenAPI spec bundle [polaris]
Posted by "dimas-b (via GitHub)" <gi...@apache.org>.
dimas-b commented on code in PR #3732:
URL: https://github.com/apache/polaris/pull/3732#discussion_r2789858709
##########
spec/generated/bundled-polaris-catalog-service.yaml:
##########
Review Comment:
Is it used in build? in docs?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update the generated OpenAPI spec bundle [polaris]
Posted by "snazy (via GitHub)" <gi...@apache.org>.
snazy commented on code in PR #3732:
URL: https://github.com/apache/polaris/pull/3732#discussion_r2797829482
##########
spec/generated/bundled-polaris-catalog-service.yaml:
##########
Review Comment:
I am a huge fan of automating "all the things" and let CI "catch all the things".
As mentioned in my other comment, the process to update the OpenAPI is a very manual process in which people can easily miss those steps.
I've been experimenting with a process to generate the OpenAPI spec from Java types, using the microprofile OpenAPI annotations with an additional check that verifies that the generated OpenAPI-yaml has no breaking changes against a reference OpenAPI-yaml.
Starting from Java types has the advantage that there are no more manual steps needed. Currently, one has to update not just the spec but also a bunch of build scripts for most OpenAPI spec changes, leaking spec specific type names into build scripts.
Thinking further, it is pretty much impossible to make REST endpoints work asynchronously/reactive, because the endpoint functions' signatures are dictated by the code generator.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update the generated OpenAPI spec bundle [polaris]
Posted by "dimas-b (via GitHub)" <gi...@apache.org>.
dimas-b commented on code in PR #3732:
URL: https://github.com/apache/polaris/pull/3732#discussion_r2790126310
##########
spec/generated/bundled-polaris-catalog-service.yaml:
##########
Review Comment:
Would it make sense to move the generate YAML out of `spec/` into something under "docs" perhaps?.. in a separate PR, of course.
##########
spec/generated/bundled-polaris-catalog-service.yaml:
##########
Review Comment:
Would it make sense to move the generated YAML out of `spec/` into something under "docs" perhaps?.. in a separate PR, of course.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update the generated OpenAPI spec bundle [polaris]
Posted by "adutra (via GitHub)" <gi...@apache.org>.
adutra commented on code in PR #3732:
URL: https://github.com/apache/polaris/pull/3732#discussion_r2798743857
##########
spec/generated/bundled-polaris-catalog-service.yaml:
##########
Review Comment:
> the endpoint functions' signatures are dictated by the code generator.
You could change the method signatures in the mustache templates and make everything async or reactive. We are already customizing almost all templates anyways ๐
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update the generated OpenAPI spec bundle [polaris]
Posted by "adutra (via GitHub)" <gi...@apache.org>.
adutra commented on code in PR #3732:
URL: https://github.com/apache/polaris/pull/3732#discussion_r2790141808
##########
spec/generated/bundled-polaris-catalog-service.yaml:
##########
Review Comment:
I think it could get even more easily out of sync, don't you think?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org