From 359369c5f54b1107feffdd29d15adab66fe034e0 Mon Sep 17 00:00:00 2001 From: Michael Edgar Date: Wed, 8 Apr 2020 21:25:13 -0400 Subject: [PATCH] Allow missing OAI Parameter name when target also has JAX-RS param --- .../openapi/jaxrs/ParameterProcessor.java | 15 ++++---- .../runtime/scanner/ParameterScanTests.java | 20 +++++++++++ ...arams.common-annotation-target-method.json | 36 +++++++++++++++++++ .../openapi/spring/ParameterProcessor.java | 14 +++----- 4 files changed, 69 insertions(+), 16 deletions(-) create mode 100644 extension-jaxrs/src/test/resources/io/smallrye/openapi/runtime/scanner/params.common-annotation-target-method.json diff --git a/extension-jaxrs/src/main/java/io/smallrye/openapi/jaxrs/ParameterProcessor.java b/extension-jaxrs/src/main/java/io/smallrye/openapi/jaxrs/ParameterProcessor.java index 2e83cf4a4..b228c7e29 100644 --- a/extension-jaxrs/src/main/java/io/smallrye/openapi/jaxrs/ParameterProcessor.java +++ b/extension-jaxrs/src/main/java/io/smallrye/openapi/jaxrs/ParameterProcessor.java @@ -1185,7 +1185,10 @@ ParameterContext getParameterContext(ParameterContextKey key, AnnotationTarget t ParameterContext context = params.get(key); if (context == null) { - context = params.values().stream().filter(c -> haveSameAnnotatedTarget(c, target, key.name)) + context = params + .values() + .stream() + .filter(c -> haveSameAnnotatedTarget(c, target, key.name)) .findFirst() .orElse(null); } @@ -1212,13 +1215,11 @@ boolean haveSameAnnotatedTarget(ParameterContext context, AnnotationTarget targe if (target.equals(context.target)) { /* - * If the annotations have the same (non-method) target or the same name with a common - * method target, it's the same parameter. - * - * This covers the situation where a @Parameter annotation was missing either - * 'name' or 'location' attributes (or both). + * This logic formerly also required that the parameter names matched + * (nameMatches == true) or that the kind of the target was not a + * method. */ - return nameMatches || target.kind() != Kind.METHOD; + return true; } if (nameMatches && target.kind() == Kind.METHOD && context.target.kind() == Kind.METHOD_PARAMETER) { diff --git a/extension-jaxrs/src/test/java/io/smallrye/openapi/runtime/scanner/ParameterScanTests.java b/extension-jaxrs/src/test/java/io/smallrye/openapi/runtime/scanner/ParameterScanTests.java index 69b604e75..ce65434ab 100644 --- a/extension-jaxrs/src/test/java/io/smallrye/openapi/runtime/scanner/ParameterScanTests.java +++ b/extension-jaxrs/src/test/java/io/smallrye/openapi/runtime/scanner/ParameterScanTests.java @@ -211,6 +211,11 @@ public void testParamNameOverride() throws IOException, JSONException { ParamNameOverrideTestResource.class); } + @Test + public void testCommonTargetMethodParameter() throws IOException, JSONException { + test("params.common-annotation-target-method.json", CommonTargetMethodParameterResource.class); + } + /***************** Test models and resources below. ***********************/ public static class Widget { @@ -808,4 +813,19 @@ public String echo( return p1; } } + + @Path("/common-target-method") + static class CommonTargetMethodParameterResource { + @DefaultValue("10") + @QueryParam("limit") + @Parameter(description = "Description of the limit query parameter") + public void setLimit(int limit) { + } + + @GET + @Produces(MediaType.APPLICATION_JSON) + public String[] getRecords() { + return null; + } + } } diff --git a/extension-jaxrs/src/test/resources/io/smallrye/openapi/runtime/scanner/params.common-annotation-target-method.json b/extension-jaxrs/src/test/resources/io/smallrye/openapi/runtime/scanner/params.common-annotation-target-method.json new file mode 100644 index 000000000..c2cbce40c --- /dev/null +++ b/extension-jaxrs/src/test/resources/io/smallrye/openapi/runtime/scanner/params.common-annotation-target-method.json @@ -0,0 +1,36 @@ +{ + "openapi": "3.0.1", + "paths": { + "/common-target-method": { + "get": { + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "Description of the limit query parameter", + "schema": { + "format": "int32", + "default": 10, + "type": "integer" + } + } + ] + } + } +} diff --git a/extension-spring/src/main/java/io/smallrye/openapi/spring/ParameterProcessor.java b/extension-spring/src/main/java/io/smallrye/openapi/spring/ParameterProcessor.java index 966ebc1c4..fe3a86adc 100644 --- a/extension-spring/src/main/java/io/smallrye/openapi/spring/ParameterProcessor.java +++ b/extension-spring/src/main/java/io/smallrye/openapi/spring/ParameterProcessor.java @@ -1201,7 +1201,10 @@ ParameterContext getParameterContext(ParameterContextKey key, AnnotationTarget t ParameterContext context = params.get(key); if (context == null) { - context = params.values().stream().filter(c -> haveSameAnnotatedTarget(c, target, key.name)) + context = params + .values() + .stream() + .filter(c -> haveSameAnnotatedTarget(c, target, key.name)) .findFirst() .orElse(null); } @@ -1227,14 +1230,7 @@ boolean haveSameAnnotatedTarget(ParameterContext context, AnnotationTarget targe boolean nameMatches = Objects.equals(context.name, name); if (target.equals(context.target)) { - /* - * If the annotations have the same (non-method) target or the same name with a common - * method target, it's the same parameter. - * - * This covers the situation where a @Parameter annotation was missing either - * 'name' or 'location' attributes (or both). - */ - return nameMatches || target.kind() != Kind.METHOD; + return true; } if (nameMatches && target.kind() == Kind.METHOD && context.target.kind() == Kind.METHOD_PARAMETER) {