docs: Generate API docs for connect-go API #4408
Open
Conversation
This file contains hidden or 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
simonswine
force-pushed
the
20250903_api-docs-generation
branch
from
a0a5d02 to
b4c9dad
Compare
simonswine
force-pushed
the
20250903_api-docs-generation
branch
5 times, most recently
from
e630e92 to
11e9fec
Compare
This adds the preferred but currently undocumented connect API calls. It uses openapi v3 as intermediate format and then generates the documentation page.
simonswine
force-pushed
the
20250903_api-docs-generation
branch
from
11e9fec to
97047ba
Compare
simonswine
changed the title
simonswine
requested review from
a team,
aleks-p and
marcsanmi
as code owners
There was a problem hiding this comment.
Generic question: why is a generated file committed to the repo?
There was a problem hiding this comment.
In it is a very common pattern in Go, basically when doing dependency management using go mod, not all repo files are included (tests non go files are removed). So often it is impossible to execute the code generation commands then.
There for it is common to commit the generated files (With all of the problems this causes)
oleg-kozlyuk-grafana
approved these changes
Oct 13, 2025
marcsanmi
reviewed
Oct 13, 2025
marcsanmi
reviewed
Oct 13, 2025
marcsanmi
approved these changes
Oct 13, 2025
alsoba13
approved these changes
Oct 16, 2025
Co-authored-by: Marc Sanmiquel <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Still needs a bit more tests and attention and removal of AI slop, but the idea is to include this in the user facing documentation.
The actual docs can be fully seen by running:
And the navigate to: http://localhost:3002/docs/pyroscope/latest/reference-server-api/#connect-api