Improve comments for RPC funcs #1287
Conversation
There was a problem hiding this comment.
Changes in proto file is good. A bit worried of why swagger.json so significantly changed. Can you test this with kind and make proxy-ui to see if it looks good on http://localhost:51500/:
make create-kind-cluster
make get-kind-kubeconfig
make push-images
make install-chart
| @@ -111,8 +111,7 @@ message GetBackfillRequest { | |||
| // BETA FEATURE WARNING: This Request message is not finalized and still subject | |||
| // to possible change or removal. | |||
| message UpdateBackfillRequest { | |||
| // A Backfill object with SearchFields defined. | |||
| Backfill backfill_ticket = 1; | |||
| Backfill backfill = 1; | |||
There was a problem hiding this comment.
I like this more as it is consistent with CreateBackfillRequest. 👍
| "description": "BETA FEATURE WARNING: This call and the associated Request and Response\nmessages are not finalized and still subject to possible change or removal.", | ||
| "operationId": "FrontendService_DeleteBackfill", |
There was a problem hiding this comment.
Not sure why there are so many changes to swagger.json files. Do you use a different version of it?
|
i used an online swagger editor to verify how the output json file looks like. And it looks like |
|
Tried to regenerate |
api/frontend.proto
Outdated
|
|
||
| // Side effects: Any tickets waiting for this backfill will be returned to the active pool, no longer pending. | ||
|
|
||
| // UpdateBackfill updates a Backfill object with an ID set and SearchFields defined. |
There was a problem hiding this comment.
extensions will be updated to. Perhaps something like "UpdateBackfill updates search_fields and extensions for the backfill with the provided id"?
syntxerror
added
area/developer-experience
What this PR does / Why we need it:
This PR adds some modifications to the comments of the Backfill funcs inside the FrontendService since they weren't so easy to read and understand its usage.