Adding grpc comments designed for api generation #85
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
kw510
commented
Apr 10, 2024
Comment on lines
29
to
30
| get : "/v1/principals?segment={segment}&_limit={pagination_limit}&_start={pagination_token}" | ||
| }; |
There was a problem hiding this comment.
This is a strange way to do this. It makes the openapi generater have a heart attack...
I would suggest not to map variables like this 😬
There was a problem hiding this comment.
🤔 which generator did you try? I haven't actually tried this using a proxy like Envoy either so this might be a no go anyway.
There was a problem hiding this comment.
https://pkg.go.dev/github.com/google/gnostic/cmd/protoc-gen-openapi
Turns into this:
/v1/principals?segment={paginationToken:
get:
tags:
- Principals
description: Lists principals
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.
A rough idea of whats going on. Still needs tweaks to add fullstops