This repository has been archived by the owner on Oct 23, 2023. It is now read-only.
Comment annotations and doc generation #minor #350
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
Signed-off-by: Eduardo Apolinario <eapolinario@users.noreply.github.com>
Signed-off-by: Eduardo Apolinario <eapolinario@users.noreply.github.com>
Codecov Report
@@ Coverage Diff @@
## master #350 +/- ##
=======================================
Coverage 73.12% 73.12%
=======================================
Files 18 18
Lines 1362 1362
=======================================
Hits 996 996
Misses 315 315
Partials 51 51
Flags with carried forward coverage won't be shown. Click here to find out more. Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
eapolinario
changed the title
wild-endeavor
approved these changes
Dec 7, 2022
pingsutw
approved these changes
Dec 7, 2022
eapolinario
added a commit
that referenced
this pull request
Sep 8, 2023
* Comment swagger annotations in proto Signed-off-by: Eduardo Apolinario <eapolinario@users.noreply.github.com> * Regenerate proto stubs Signed-off-by: Eduardo Apolinario <eapolinario@users.noreply.github.com> Signed-off-by: Eduardo Apolinario <eapolinario@users.noreply.github.com> Co-authored-by: Eduardo Apolinario <eapolinario@users.noreply.github.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
TL;DR
Comment annotations and generation of docs to aid in the migration to buf+monorepo
Type
Are all requirements met?
Complete description
Swagger annotations are commented out in order to unblock python protobuf stubs generated via buf. Note that we rely on grpc-gateway to leverage the annotations, but as part of the grpc-gateway v2 migration, the swagger annotations need to be migrated to openapiv2 (as described here).
Unfortunately moving all protobuf generation (across all languages) to buf will incur into too much risk and potentially some incompatibility problems (since admin is using the v1 of the grpc-gateway protoc plugin). In order to de-risk this project we'll take this piece-meal and only rely on buf for the python stubs.
Tracking Issue
flyteorg/flyte#3139
Follow-up issue
NA
OR
https://github.com/flyteorg/flyte/issues/