*: Build APIv2 spec using go-swagger, annotate endpoints #62560
Merged
Conversation
This file contains 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
|
This change is |
|
/cc @mikeCRL , @piyush-singh |
knz
approved these changes
Mar 25, 2021
There was a problem hiding this comment.
👏 👏 👏
LGTM
you may want to backport this too
Reviewed 4 of 4 files at r1, 13 of 13 files at r2.
Reviewable status:complete! 0 of 0 LGTMs obtained (waiting on @dhartunian and @itsbilal)
docs/generated/swagger/spec.json, line 23 at r2 (raw file):
"/health/": { "get": { "description": "Helper endpoint to check for node helath. If `ready` is true, it also checks\nif this node is fully operational and ready to accept SQL connections.\nOtherwise, this endpoint always returns a successful response (if the API\nserver is up, of course).",
node helath -> node health
This commit adds go-swagger annotations for API v2 endpoints, so that the swagger spec and by extension docs can be generated as part of `make generate`. Due to a limitation in go-swagger, the only map key type that's supported for swagger models is string, so some maps had to be modified to use that type instead. Part of cockroachdb#55947 , and the docs story around it. Release note (general change): Add docs for api v2 endpoints.
itsbilal
force-pushed
the
swagger-apiv2-docs
branch
from
66acfc5
to
6ed1b31
Compare
itsbilal
commented
Mar 25, 2021
There was a problem hiding this comment.
TFTR!
Reviewable status:
docs/generated/swagger/spec.json, line 23 at r2 (raw file):
Previously, knz (kena) wrote…
node helath -> node health
Done.
itsbilal
force-pushed
the
swagger-apiv2-docs
branch
3 times, most recently
from
0cf9e5d
to
6f08342
Compare
This change adds a dependency on `go-swagger/go-swagger`, and
uses it as part of `make generate` to regenerate the swagger
spec in `docs/generated/swagger/spec.json`, whenever
one of the APIv2 files in `pkg/server/` are changed.
The spec, once generated, can be served as docs using
the command:
bin/swagger serve -p 8080 ./docs/generated/swagger/spec.json
Release note (build change): Adds go-swagger dependency, updates
Makefile to call it to rebuild spec in docs/generated/swagger/
which will eventually be used for API docs.
itsbilal
force-pushed
the
swagger-apiv2-docs
branch
from
6f08342
to
41e6ed1
Compare
|
TFTR! bors r=knz |
|
Build succeeded: |
Closed
4 tasks
This was referenced Jun 29, 2021
This was referenced Sep 8, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 change adds a dependency on
go-swagger/go-swagger, anduses it as part of
make generateto regenerate the swaggerspec in
docs/generated/swagger/spec.json, wheneverone of the APIv2 files in
pkg/server/are changed.The spec, once generated, can be served as docs using
the command:
Also adds related annotations to
pkg/server/api*.goto populatesaid spec.
Part of #55947 , and the docs story around it.
Release note (general change): Add docs for api v2 endpoints.
Release note (build change): Adds go-swagger dependency, updates
Makefile to call it to rebuild spec in docs/generated/swagger/
which will eventually be used for API docs.