This is rendered with every value twice:
\n
In the code, that's how it's defined:
\n @Parameter(required = false, description = \"...\")\n @QueryParam(\"environment\") @DefaultValue(\"DATABASE\") final RegisterHistoryEnvironment environmentAnd this is how it's generated:
\n {\n \"name\" : \"environment\",\n \"in\" : \"query\",\n \"required\" : false,\n \"schema\" : {\n \"allOf\" : [ {\n \"$ref\" : \"#/components/schemas/RegisterHistoryEnvironment\"\n }, {\n \"default\" : \"DATABASE\"\n } ]\n }With our old toolchain it was generated like this:
\n {\n \"name\" : \"environment\",\n \"in\" : \"query\",\n \"schema\" : {\n \"type\" : \"string\",\n \"enum\" : [ \"XML\", \"DATABASE\" ],\n \"default\" : \"XML\"\n }\n }And that showed the correct drop-down values in SwaggerUI.
\nIf I omit the default value, it's generated in a different way and then shows the correct drop-down values in SwaggerUI:
\n {\n \"name\" : \"environment\",\n \"in\" : \"query\",\n \"required\" : false,\n \"schema\" : {\n \"$ref\" : \"#/components/schemas/RegisterHistoryEnvironment\"\n }\n }Am I doing something wrong or is SmallRye generated something it shouldn't?
","upvoteCount":1,"answerCount":3,"acceptedAnswer":{"@type":"Answer","text":"4.0.x for sure. If it's not too complicated to backport to 3.1.x then it can be queued up for a bug fix there as well.
","upvoteCount":0,"url":"https://github.com/smallrye/smallrye-open-api/discussions/1996#discussioncomment-11052152"}}}
-
|
I have an enum which looks like this: public enum RegisterHistoryEnvironment {
XML,
DATABASE;
}This is rendered with every value twice:
In the code, that's how it's defined: @Parameter(required = false, description = "...")
@QueryParam("environment") @DefaultValue("DATABASE") final RegisterHistoryEnvironment environmentAnd this is how it's generated: {
"name" : "environment",
"in" : "query",
"required" : false,
"schema" : {
"allOf" : [ {
"$ref" : "#/components/schemas/RegisterHistoryEnvironment"
}, {
"default" : "DATABASE"
} ]
}With our old toolchain it was generated like this: {
"name" : "environment",
"in" : "query",
"schema" : {
"type" : "string",
"enum" : [ "XML", "DATABASE" ],
"default" : "XML"
}
}And that showed the correct drop-down values in SwaggerUI. If I omit the default value, it's generated in a different way and then shows the correct drop-down values in SwaggerUI: {
"name" : "environment",
"in" : "query",
"required" : false,
"schema" : {
"$ref" : "#/components/schemas/RegisterHistoryEnvironment"
}
}Am I doing something wrong or is SmallRye generated something it shouldn't? |
Beta Was this translation helpful? Give feedback.
Replies: 3 comments 9 replies
-
|
How does |
Beta Was this translation helpful? Give feedback.
-
|
It's generated like this: "RegisterHistoryEnvironment" : {
"enum" : [ "XML", "DATABASE" ],
"type" : "string"
}But perhaps I was misleaded. In fact, the class in question is abstract and resides in a dependency which is required when the actual REST endpoints are used in another Maven project. So, project A contains the abstract REST endpoint, and project B uses project B by extending the abstract class. And it's in project B that the To make things easier to test, I generated So, in fact it looks like this in project B: {
"name" : "environment",
"in" : "query",
"required" : false,
"schema" : {
"allOf" : [ {
"$ref" : "#/components/schemas/RegisterHistoryEnvironment"
}, {
"default" : "DATABASE"
}, {
"$ref" : "#/components/schemas/RegisterHistoryEnvironment"
}, {
"default" : "DATABASE"
} ]
}
}
"RegisterHistoryEnvironment" : {
"enum" : [ "XML", "DATABASE" ],
"type" : "string"
} |
Beta Was this translation helpful? Give feedback.
-
|
Yuck, that's not good... this is how your endpoint is defined? Can you show the full method signature with annotations too? @Parameter(required = false, description = "...")
@QueryParam("environment") @DefaultValue("DATABASE") final RegisterHistoryEnvironment environment |
Beta Was this translation helpful? Give feedback.
-
|
Ok, I created a simple example in project A: @GET
@Path("/foo")
@Produces({ MediaType.APPLICATION_JSON })
@Operation(summary = "...")
public Response foo(
@Parameter(required = false)
@QueryParam("environment") @DefaultValue("DATABASE") final RegisterHistoryEnvironment environment) {
return Response.ok().build();
}This results in the following in "/api/foo" : {
"get" : {
"summary" : "...",
"parameters" : [ {
"name" : "environment",
"in" : "query",
"required" : false,
"schema" : {
"allOf" : [ {
"$ref" : "#/components/schemas/RegisterHistoryEnvironment"
}, {
"default" : "DATABASE"
}, {
"$ref" : "#/components/schemas/RegisterHistoryEnvironment"
}, {
"default" : "DATABASE"
} ]
}
} ],
"responses" : {
"200" : {
"description" : "OK"
}
}
}
}By the way, I'll be away on holidays for the next two weeks, so please be patient with answers after today :-) |
Beta Was this translation helpful? Give feedback.
-
|
@MikeEdgar Back from holidays :-) Any news on this question? |
Beta Was this translation helpful? Give feedback.
-
|
This is still on my radar. I need to get release 4.0 done then plan to come back and get some bug fixes/minor enhancements done in the next few weeks. |
Beta Was this translation helpful? Give feedback.
-
|
Ok, great! So will this be part of release 4.0 or part of release 3.x.x? |
Beta Was this translation helpful? Give feedback.
-
|
4.0.x for sure. If it's not too complicated to backport to 3.1.x then it can be queued up for a bug fix there as well. |
Beta Was this translation helpful? Give feedback.
-
|
Thanks a lot! |
Beta Was this translation helpful? Give feedback.
-
|
I just tested it with 4.0.0, works great! |
Beta Was this translation helpful? Give feedback.
-
|
I don't know that it was fixed on purpose or just as a result of the other changes for 4.0 🤣 |
Beta Was this translation helpful? Give feedback.
-
|
Collateral bugfixing :-)) |
Beta Was this translation helpful? Give feedback.
4.0.x for sure. If it's not too complicated to backport to 3.1.x then it can be queued up for a bug fix there as well.