chore: fix ListValue types in swagger spec #4801
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
✅ Deploy Preview for determined-ui ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
hamidzr
reviewed
Aug 17, 2022
There was a problem hiding this comment.
I'm worried about what happens when the endpoint or the proto definitions change :thinking_face: would people realize that their changes didn’t result in generating the change they expected?
update: the JSON patch seems to so precisely target the type of the label that I’m not worried
hbp ➜ determined git:(master) jq '.definitions.v1PatchExperiment' proto/build/swagger/determined/api/v1/api.swagger.json > /tmp/before.json
hbp ➜ determined git:(master) colordiff /tmp/before.json /tmp/after.json
16c16
< "type": "object"
---
> "type": "string"
hbp ➜ determined git:(master)
looking at the rest of changes
rb-determined-ai
force-pushed
the
list-value
branch
2 times, most recently
from
3910dc5
to
0db5a53
Compare
Protobuf google.protobuf.ListValue types come through swagger as:
{"type":"array", "items":{"type":"object"} }
which would convert to `Sequence[Dict[str, Any]]`, which is a pretty
strange field type for v1PatchModel.labels.
This PR adds tweaks via the proto/patches/api.json to force the right
type in the swagger.
rb-determined-ai
force-pushed
the
list-value
branch
from
0db5a53
to
ac48f70
Compare
NicholasBlaskey
pushed a commit
to NicholasBlaskey/determined
that referenced
this pull request
Aug 24, 2022
Protobuf google.protobuf.ListValue types come through swagger as:
{"type":"array", "items":{"type":"object"} }
which would convert to `Sequence[Dict[str, Any]]`, which is a pretty
strange field type for v1PatchModel.labels.
This PR adds tweaks via the proto/patches/api.json to force the right
type in the swagger.
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.
Protobuf google.protobuf.ListValue types come through swagger as:
which would convert to
Sequence[Dict[str, Any]], which is a prettystrange field type for v1PatchModel.labels.
This PR adds tweaks via the proto/patches/api.json to force the right
type in the swagger.