Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[Enhancement]: Add CI to autogen the swagger docs #1142

Open
jianoaix opened this issue Jan 23, 2025 · 0 comments
Open

[Enhancement]: Add CI to autogen the swagger docs #1142

jianoaix opened this issue Jan 23, 2025 · 0 comments
Labels
enhancement New feature or request

Comments

@jianoaix
Copy link
Contributor

Use case and current behavior

The swagger docs of dataapi, which currently may get stale if not updated when changing data types.

Enhancement

Swagger docs of dataapi are auto generated. It's desired to keep docs in sync with code.

Solution proposal

We could add CI to auto gen swagger docs similar to the proto gen docs.

Additional Information

No response
@jianoaix jianoaix added the enhancement New feature or request label Jan 23, 2025
@jianoaix jianoaix mentioned this issue Jan 29, 2025
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jianoaix