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.

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

docs: re-enable generated swagger documentation #87653

Closed
rickystewart opened this issue Sep 8, 2022 · 1 comment
Closed

docs: re-enable generated swagger documentation #87653

rickystewart opened this issue Sep 8, 2022 · 1 comment
Labels
A-build-system A-docs C-bug Code not up to spec/doc, specs & docs deemed correct. Solution expected to change code/behavior. T-dev-inf

Comments

@rickystewart
Copy link
Collaborator

rickystewart commented Sep 8, 2022

#86049 disabled generating swagger docs. At the time the PR was put together, go-swagger still had issues dealing with Go 1.19. go-swagger/go-swagger#2808 was merged upstream which means we should no longer have these problems.

Someone friendly did a little analysis of why swagger generation continues to fail:

I looked at the errors in the swagger generation. A lot of them have to do with liberal whitespace usage.

Upgrade go-swagger to the latest version and fix our swagger comments so we can generate code. Then, fix the following files:

build/bazelutil/check.sh
docs/generated/bazel_targets.txt
docs/generated/swagger/BUILD.bazel
Makefile
[go:generate comment in pkg/server/api_v2.go]

Epic CRDB-17171
Jira issue: CRDB-19460

@rickystewart rickystewart added C-bug Code not up to spec/doc, specs & docs deemed correct. Solution expected to change code/behavior. A-docs A-build-system T-dev-inf labels Sep 8, 2022
@rickystewart
Copy link
Collaborator Author

#105291 deleted the Swagger docs, apparently no one cares about it, so I'm closing this out. Can re-open if this is what we want to do.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-build-system A-docs C-bug Code not up to spec/doc, specs & docs deemed correct. Solution expected to change code/behavior. T-dev-inf
Projects
None yet
Development

No branches or pull requests

1 participant