Skip to content
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

Merged
merged 3 commits into from
Jun 5, 2023

Conversation

averche
Copy link
Contributor

@averche averche commented May 29, 2023

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.

Note: "duration" is not yet officially supported in the OpenAPI spec as of v3.0.3, but it is planned in future versions. For now, this format will be ignored by the openapi-generator.

@averche averche added this to the 1.15 milestone May 29, 2023
@averche averche requested review from dhuckins and AnPucel May 30, 2023 23:58
@@ -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"
Copy link
Contributor

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?

Copy link
Contributor Author

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?

Copy link
Contributor

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

Copy link
Contributor

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

Copy link
Contributor Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants