Improve schema building, bug fixes #1012

altro3 · 2023-05-09T14:45:54Z

Main changes:

Added correct processing for optional path variables (routing like this: "/test{/pathVar1,pathVar2}")
Fixes process oneOf block on field level
Added unwrapping allOf block when it possible
Now the in field for parameters without annotation is determined automatically (path in all cases, query for get requests)
Fixed duplicate elements in oneOf and anyOf blocks

Code changes

Now all tests check final openApi object for more correct checks (found some incorrect tests after it)
Now all modifications for the OpenAPI object after the analysis of the class structure are moved to the method postProcessOpenApi
Some minor code fixes

dstepanov

It's hard to understand what is fixed/changed. Can you keep the old tests as they are if modification is not needed and add new ones? Or please comment on every test change and describe why it changed. Thanks!

altro3 · 2023-05-09T15:21:48Z

openapi/src/test/groovy/io/micronaut/openapi/visitor/OpenApiPojoControllerSpec.groovy

-        ((MapSchema) petSchema.properties['freeForm']).description == "A free-form object"
-        ((MapSchema) petSchema.properties['freeForm']).getAdditionalProperties() == true
+        petSchema.properties['freeForm'].type == "object"
+        petSchema.properties['freeForm'].description == "A free-form object"


Now we have just instance of Schema class

altro3 · 2023-05-09T15:22:12Z

openapi/src/test/groovy/io/micronaut/openapi/visitor/OpenApiPathParamRegexSpec.groovy

@@ -21,7 +21,7 @@ import io.swagger.v3.oas.annotations.Operation;
 class OpenApiController {

    @Operation(summary = "Update tag", description = "Updates an existing tag", tags = "users_tag")
-    @Post("/tags/{tagId: \\\\d+}/{path:.*}{.ext}/update{/id:[a-zA-Z]+}/{+path}{?max,offset}")
+    @Post("/tags/{tagId: \\\\d+}/{path:.*}{.ext}/update/{+path}{?max,offset}{/id:[a-zA-Z]+}")


optional path variable must be last

altro3 · 2023-05-09T15:22:35Z

openapi/src/test/groovy/io/micronaut/openapi/visitor/OpenApiParameterSchemaSpec.groovy

 @Controller("/path")
 class OpenApiController {

    @Patch
-    public HttpResponse<String> processSync4(@Parameter(schema = @Schema(type = "string", format = "uuid")) String param) {
+    public HttpResponse<String> processSync4(@Parameter(schema = @Schema(type = "string", format = "uuid")) @QueryValue String param) {


Added lost annotation @QueryValue

We support no-annotation parameters, which can also be query value, but for proper OpenApi it might be needed

@dstepanov I didn't test it for Patch method, can tell you what I know:

For Get method - it is true. And I've add support it in openapi

For Post method, if you dont's set annotation, parameters are automatically treated as wrapped, i.e. they must be passed in the request body (by the way, I don’t understand at all why the logic is different for different methods. This is not at all obvious), or as path variables (it's supported too)
Which logic for other methods - I didn't test

In this test before my changes in field in was null value

altro3 · 2023-05-09T15:23:23Z

openapi/src/test/groovy/io/micronaut/openapi/visitor/OpenApiParameterSchemaSpec.groovy

        return HttpResponse.ok();
    }

    @Put
    public HttpResponse<String> processSync3(
-            @Parameter(schema = @Schema(ref = "#/components/schemas/MyParamSchema")) Optional<Period> period) {
+            @Parameter(schema = @Schema(ref = "#/components/schemas/MyParamSchema")) @QueryValue Optional<Period> period) {


Added lost @QueryValue annotation

altro3 · 2023-05-09T15:23:44Z

openapi/src/test/groovy/io/micronaut/openapi/visitor/OpenApiParameterMappingSpec.groovy

+    String test7(String someId, @Nullable String someNotRequired, java.util.Optional<String> someNotRequired2, HttpRequest req, Principal principal, @Body Greeting myBody);
+
+    @Get("/test8{/pathVar1,pathVar2}")
+    String test8(String pathVar1, String pathVar2, String queryVar, @Nullable String name);


new test case for optional path vars

altro3 · 2023-05-09T15:29:57Z

openapi/src/test/groovy/io/micronaut/openapi/visitor/OpenApiApplicationVisitorSpec.groovy

@@ -918,7 +899,6 @@ class MyBean {}
 ''')
        then: "the state is correct"
        !Utils.testReference
-        !Utils.testReferenceAfterPlaceholders


Utils.testReferenceAfterPlaceholders - this filed deleted and we need to check testReference always

altro3 · 2023-05-09T15:30:53Z

openapi/src/test/groovy/io/micronaut/openapi/MyJaxbElement4.java

+
+import io.swagger.v3.oas.annotations.media.Schema;
+
+public class MyJaxbElement4 {


@Schema(oneOf = {DiscountSizeOpenApi.class, DiscountFixedOpenApi.class, MultiplierSizeOpenApi.class})
Test for this block. Fixed processing in this PR

altro3 · 2023-05-09T15:33:23Z

openapi/src/test/groovy/io/micronaut/openapi/visitor/OpenApiRecordsSpec.groovy

@@ -84,7 +83,6 @@ class MyBean {}
        then:
        openAPI.components.schemas
        openAPI.components.schemas.size() == 1
-        openAPI.components.schemas['Person'].name == 'Person'


schema name always null. Schema name contains in schemas map

altro3 · 2023-05-09T15:33:44Z

openapi/src/test/groovy/io/micronaut/openapi/visitor/OpenApiSchemaInContentSpec.groovy

@@ -36,7 +36,7 @@ class OpenApiController {
            description = "This is description",
            tags = "Normalize",
            responses = {
-                    @ApiResponse(responseCode = "200", description = "Desc1", content = @Content(mediaType = MediaType.ALL, schema = @Schema(type = "blob", format = "binary"))),
+                    @ApiResponse(responseCode = "200", description = "Desc1", content = @Content(mediaType = MediaType.ALL, schema = @Schema(type = "string", format = "binary"))),


we can't use custom values for type field

altro3 · 2023-05-09T15:34:09Z

openapi/src/test/groovy/io/micronaut/openapi/visitor/OpenapiCustomSchemaSpec.groovy

@@ -35,6 +35,7 @@ class MyDto {
    private JAXBElement<? extends XmlElement> xmlElement;
    private JAXBElement<? extends XmlElement2> xmlElement2;
    public JAXBElement<? extends XmlElement3> xmlElement3;
+    public JAXBElement<? extends XmlElement4> xmlElement4;


new test case for oneOf block

altro3 · 2023-05-09T15:36:00Z

@dstepanov added comments to most of changes in tests. Need to double check to places (without comments now, I don't remember why I did these changes). You can check places with comments

graemerocher · 2023-05-10T08:37:50Z

openapi/src/test/groovy/io/micronaut/openapi/visitor/OpenApiApplicationVisitorSpec.groovy

-        withRef.openIdConnectUrl == null
-        withRef.bearerFormat == null
-        withRef.flows == null
-        withRef.scheme == null


Why was this deleted?

@graemerocher Because the swagger doesn't really support links to other security schemes. Therefore, when you try to deserialize a swagger file with such a scheme, it will be ignored, because. type is not specified. See class SecuritySchemeDeserializer:

That is, this test case is not correct.

altro3 mentioned this pull request May 9, 2023

Fixed duplicate elements inside oneof and anyof blocks #1011

Closed

altro3 force-pushed the improve_schema_building branch from 53f1e9e to 48a4288 Compare May 9, 2023 14:48

altro3 requested a review from dstepanov May 9, 2023 14:50

dstepanov requested changes May 9, 2023

View reviewed changes

altro3 commented May 9, 2023

View reviewed changes

dstepanov approved these changes May 9, 2023

View reviewed changes

dstepanov requested a review from graemerocher May 9, 2023 18:35

graemerocher reviewed May 10, 2023

View reviewed changes

altro3 added 2 commits May 10, 2023 23:29

Fixed duplicate elements inside oneof and anyof blocks

0eba7f2

Improved schema building

061f1ce

altro3 force-pushed the improve_schema_building branch from 48a4288 to 061f1ce Compare May 10, 2023 16:29

altro3 requested a review from graemerocher May 12, 2023 22:04

graemerocher merged commit df1792b into micronaut-projects:4.9.x May 15, 2023

altro3 mentioned this pull request May 23, 2023

Schema oneOf ignored on properties #1023

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve schema building, bug fixes #1012

Improve schema building, bug fixes #1012

altro3 commented May 9, 2023

dstepanov left a comment

altro3 May 9, 2023

altro3 May 9, 2023

altro3 May 9, 2023

dstepanov May 9, 2023

altro3 May 9, 2023

altro3 May 9, 2023 •

edited

Loading

altro3 May 9, 2023

altro3 May 9, 2023

altro3 May 9, 2023

altro3 May 9, 2023

altro3 May 9, 2023

altro3 May 9, 2023

altro3 May 9, 2023

altro3 commented May 9, 2023

graemerocher May 10, 2023

altro3 May 12, 2023


		import io.swagger.v3.oas.annotations.media.Schema;

		public class MyJaxbElement4 {

Improve schema building, bug fixes #1012

Improve schema building, bug fixes #1012

Conversation

altro3 commented May 9, 2023

dstepanov left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

altro3 May 9, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

altro3 commented May 9, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

altro3 May 9, 2023 •

edited

Loading