-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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
openapi: Fix generated types for duration strings #20841
Conversation
@@ -918,8 +918,8 @@ func convertType(t FieldType) schemaType { | |||
ret.baseType = "integer" | |||
ret.format = "int64" | |||
case TypeDurationSecond, TypeSignedDurationSecond: | |||
ret.baseType = "integer" | |||
ret.format = "seconds" | |||
ret.baseType = "string" |
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.
don't these endpoints accept both int OR string?
if that's the case, wouldn't it break those passing in ints?
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.
I was mostly looking at how these fields are returned in responses today. Do you have an example of where this is used as int or string in a request?
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.
there's at least one, still looking for a request, but this is a response that returns int or string
framework.Path
callback fcn
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.
couldn't find any requests that handle both int or string, would need to take a closer look
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.
The sys/rotate/config
example you mentioned seems to be a bug where two different types are returned. Unfortunately, it would not be easy to fix, since it would break backwards compatibility.
As far as requests go, I think we should be fine as long as both string and int are accepted. As long as the user provides a string, it should work.
Duration are sent as strings today (e.g.
"10s"
,"20m"
, etc.), which breaks the code generated based on the current OpenAPI spec which encodes them as integers. This small fix addresses the issue.