-
Notifications
You must be signed in to change notification settings - Fork 3.8k
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
cmd/docgen: add HTTP extractor #51803
Conversation
@taroface there's 2 markdown files here. Please comment on them and I can adjust. The current format is bad and I think you'll have a better idea of what you want. |
@mjibson Thanks for generating these. I went ahead and mocked up some Markdown templates, because it seemed easier. I'm open to your feedback on any of this:
|
Ok I think the full markdown will work like that. How about for the single pages one, instead of including multiple separate generated pages, it just includes a single page that has all of the request/response/error data in it? I also don't think there's a way to do error responses. Those I think happen at a higher level, like there's one generic error response or something? It's not in the proto in any case. |
For e.g. |
RFAL. I combined the response and request sections into one for the single page template so you should be able to do it in one include. Error responses are all the same: cockroach/pkg/server/serverpb/status.proto Line 293 in 8997ae2
|
Nope, auth is done in go files, not listed in protos. |
Add a way to extract docs from the status.proto HTTP endpoint. These can be imported into the docs project as needed. Release note: None
RFAL. Any more comments on the markdown? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm. thank you!
bors r+ |
Build succeeded: |
Add a way to extract docs from the status.proto HTTP endpoint. These
can be imported into the docs project as needed.
Release note: None