PAYARA-3466 Open API 1.1 #3827

jbee · 2019-03-12T15:51:37Z

Summary:

Add generics to Extensible hierarchy (added in 1.1)
Implemented new methods (mostly explicit type-safe add/remove/contains)
Replaced usage of deprecated methods with type-safe replacements added in 1.1
Removed methods now implemented as default methods in the API interfaces
Added processing of @Parameters (missed both by TCK and us in 1.0)
Added processing of @Extensions (missed both by TCK and us in 1.0)
Added null check to addX methods (I think 1.1 addec this semantic or 1.0 TCK missed to check)
Added copy constructor for Map model types for their "copy getter" (see API javadoc)
Extracted a common base type for Extensible Maps (share impl.)
Some more specific local fixes for minor deviations from the spec since 1.0 that TCK 1.1 now found
Fixed some serialisation issues (present since 1.0)

…h defaults, removed warnings, extracted common base classes for extensible maps, switched to non-deprecated methods

…xtension to JSON

...rofile/openapi/src/main/java/fish/payara/microprofile/openapi/impl/model/ExtensibleImpl.java

jbee · 2019-03-12T15:59:34Z

...rofile/openapi/src/main/java/fish/payara/microprofile/openapi/impl/model/ExtensibleImpl.java

@@ -98,4 +129,34 @@ public static Object convertExtensionValue(String value) {
        return value;
    }

+    @Override
+    public String toString() {


FYI: Added this to ease debugging by providing a helpful toString for the model.

jbee · 2019-03-12T16:03:38Z

...ile/openapi/src/main/java/fish/payara/microprofile/openapi/impl/model/media/ContentImpl.java

+            ExampleImpl.merge(example, to.getMediaType(typeName).getExamples(), override);
+        }
+        if (!from.example().isEmpty()) {
+            to.getMediaType(typeName).setExample(from.example());


FYI: example is a new property in 1.1

jbee · 2019-03-12T16:05:34Z

...e/openapi/src/main/java/fish/payara/microprofile/openapi/impl/model/security/ScopesImpl.java


    @Override
    public Scopes addScope(String name, String item) {
-        this.put(name, item);
+        this.put(name, item); // this DOES accept null!


FYI: This seems inconsistent but this add method explicitly allows for null while usually the add methods do not allow for null or should ignore it.

jbee · 2019-03-12T16:06:57Z

.../main/java/fish/payara/microprofile/openapi/impl/model/security/SecurityRequirementImpl.java

    @Override
    public SecurityRequirement addScheme(String name, String item) {
-        this.put(name, Arrays.asList(item));
+        this.put(name, item == null ? new ArrayList<>() : Arrays.asList(item));


FYI: null should become empty list

jbee · 2019-03-12T16:07:04Z

.../main/java/fish/payara/microprofile/openapi/impl/model/security/SecurityRequirementImpl.java

        return this;
    }

    @Override
    public SecurityRequirement addScheme(String name, List<String> item) {
-        this.put(name, item);
+        this.put(name, item == null ? new ArrayList<>() : item);


FYI: null should become empty list

jbee · 2019-03-12T16:10:05Z

...le/openapi/src/main/java/fish/payara/microprofile/openapi/impl/model/servers/ServerImpl.java

-        return variables;
+        return variables instanceof ServerVariables || variables == null 
+                ? (ServerVariables) variables
+                : new ServerVariablesImpl(variables);


FYI: ServerVariables got "half-removed". It is deprecated and should be removed in the future. In some places it already was replaced with a Map<String, SeverVariable> what causes changes here.

jbee · 2019-03-12T16:11:26Z

...ofile/openapi/src/main/java/fish/payara/microprofile/openapi/impl/model/util/ModelUtils.java

+    public static Boolean mergeProperty(boolean current, boolean offer, boolean override) {
+        return mergeProperty(Boolean.valueOf(current), Boolean.valueOf(offer), override);
+    }
+


FYI: I added this overloaded variants to avoid boxing/unboxing warnings. The module is almost free of warnings and it would be nice to get there.

jbee · 2019-03-12T16:12:21Z

.../test/java/fish/payara/microprofile/openapi/resource/classloader/ApplicationClassLoader.java

+        try (DataInputStream in = new DataInputStream(stream)) {
+            // Reading the binary data
+            in.readFully(buff);
+        }


FYI: fixed potential resource leak.

jbee · 2019-03-12T16:13:42Z

...napi/src/main/java/fish/payara/microprofile/openapi/impl/processor/ApplicationProcessor.java

+        if (element instanceof java.lang.reflect.Parameter) {
+            visitSchemaParameter(schema, (java.lang.reflect.Parameter) element, context);
+        }
+    }


FYI: extracted the cases into one method each to make this more readable.

jbee · 2019-03-12T16:14:37Z

...napi/src/main/java/fish/payara/microprofile/openapi/impl/processor/ApplicationProcessor.java

+        String name = extension.name();
+        if (name != null && !name.isEmpty() && value != null
+                && !value.isEmpty()) {
+            Object parsedValue = ExtensibleImpl.convertExtensionValue(value, extension.parseValue());


FYI: here we were missing applying conversion via convertExtensionValue.

jbee · 2019-03-12T16:15:45Z

...napi/src/main/java/fish/payara/microprofile/openapi/impl/processor/ApplicationProcessor.java

-                    }
-                }
-            }
+            matchedParam = findOperationParameterFor(parameter, (Method) element, context);


FYI: extracted the cases to make it more readable. Also the loop in the cases should stop when a match is found. This is simpler done with a return in a separate method.

jbee · 2019-03-12T16:18:20Z

...napi/src/main/java/fish/payara/microprofile/openapi/impl/processor/ApplicationProcessor.java

+                .removeIf(x -> ModelUtils.getParameterType(x) != In.valueOf(in.name()));
+            }
+            if (matchingMethodParameters.isEmpty()) {
+                return null;


FYI: This is a fix I added. 1.0 TCK simply had no case that would otherwise fail the next line where we always get the first entry of the list. But some cases do not have a matching parameter.

jbee · 2019-03-12T16:19:49Z

jenkins test please

...rofile/openapi/src/main/java/fish/payara/microprofile/openapi/impl/model/ExtensibleImpl.java

jbee · 2019-03-13T10:16:37Z

...napi/src/main/java/fish/payara/microprofile/openapi/impl/processor/ApplicationProcessor.java

+            // Get all parameters with the same name
+            List<java.lang.reflect.Parameter> matchingMethodParameters = Arrays
+                    .asList(annotated.getParameters()).stream()
+                    .filter(x -> name.equals(ModelUtils.getParameterName(x)))


FYI: swapped the equals because ModelUtils.getParameterName(x) can be null causeing NPE while name is from an annotation and cannot be null.

...ofile/openapi/src/main/java/fish/payara/microprofile/openapi/impl/model/util/ModelUtils.java

...microprofile/openapi/src/main/java/fish/payara/microprofile/openapi/impl/OpenApiService.java

MattGill98

Generally good, just a couple of comments from me. As an aside, I'm glad someone has shared my pain of maintaining masses of model classes! 😆

...microprofile/openapi/src/main/java/fish/payara/microprofile/openapi/impl/OpenApiService.java

...ile/openapi/src/main/java/fish/payara/microprofile/openapi/impl/model/ExtensibleTreeMap.java

...ofile/openapi/src/main/java/fish/payara/microprofile/openapi/impl/model/util/ModelUtils.java

...napi/src/main/java/fish/payara/microprofile/openapi/impl/processor/ApplicationProcessor.java

jbee · 2019-03-13T15:43:28Z

jenkins test please

jbee · 2019-03-18T16:49:10Z

...ile/openapi/src/main/java/fish/payara/microprofile/openapi/impl/model/ExtensibleTreeMap.java

+     * {@link ExtensibleTreeMap#extensions} map to the output object unless the value represents a {@link Reference} in
+     * which case only the {@link Reference#getRef()} is added.
+     */
+    static class ExtensibleTreeMapSerializer extends JsonSerializer<ExtensibleTreeMap<?,?>> {


FYI: This fixes two defects in the JSON/YAML serialisation present since 1.0 where properties on Map extending types would be ignored as they are handled by the map serializer. Thereby extensions would not be added and in case of a reference an empty object was rendered instead of the reference.

jbee · 2019-03-18T18:37:31Z

jenkins test please

jbee added 4 commits March 8, 2019 17:58

PAYARA-3466 Open API 1.1 implemented new methods, removed builder wit…

f576f2f

…h defaults, removed warnings, extracted common base classes for extensible maps, switched to non-deprecated methods

PAYARA-3466 new properties and fixes

3229892

PAYARA-3466 Fixed: Parameters and Extensions annotation processing, e…

1ecd722

…xtension to JSON

PAYARA-3466 fixed JSON serialisation issues

d85abf8

jbee added this to the 5.192 milestone Mar 12, 2019

jbee self-assigned this Mar 12, 2019

jbee commented Mar 12, 2019

View reviewed changes

...rofile/openapi/src/main/java/fish/payara/microprofile/openapi/impl/model/ExtensibleImpl.java Show resolved Hide resolved

jbee commented Mar 12, 2019

View reviewed changes

jbee requested review from MattGill98, arjantijms and Pandrex247 March 12, 2019 16:59

pdudits suggested changes Mar 13, 2019

View reviewed changes

...rofile/openapi/src/main/java/fish/payara/microprofile/openapi/impl/model/ExtensibleImpl.java Show resolved Hide resolved

...rofile/openapi/src/main/java/fish/payara/microprofile/openapi/impl/model/ExtensibleImpl.java Outdated Show resolved Hide resolved

jbee commented Mar 13, 2019

View reviewed changes

...ofile/openapi/src/main/java/fish/payara/microprofile/openapi/impl/model/util/ModelUtils.java Outdated Show resolved Hide resolved

PAYARA-3466 fixed extension JSON parsing

5a44ff2

Pandrex247 reviewed Mar 13, 2019

View reviewed changes

...microprofile/openapi/src/main/java/fish/payara/microprofile/openapi/impl/OpenApiService.java Show resolved Hide resolved

MattGill98 suggested changes Mar 13, 2019

View reviewed changes

pdudits approved these changes Mar 13, 2019

View reviewed changes

jbee added 2 commits March 13, 2019 15:11

PAYARA-3466 addressed formatting issue

15a5fe2

PAYARA-3466 reverted logic in getParentSchemaType

d0bbc63

jbee added 3 commits March 15, 2019 09:49

PAYARA-3466 moved all JSON output tweaks to mixin interface

95fe534

PAYARA-3466 FIXED Extensible no longer adds node 'extensions' to JSON

849ff1b

PAYARA-3466 fixed serialisation of extentions and maps with properties

2d2af20

jbee commented Mar 18, 2019

View reviewed changes

MattGill98 approved these changes Mar 19, 2019

View reviewed changes

Pandrex247 merged commit ef8e36d into payara:master Mar 19, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PAYARA-3466 Open API 1.1 #3827

PAYARA-3466 Open API 1.1 #3827

jbee commented Mar 12, 2019 •

edited

Loading

jbee Mar 12, 2019 •

edited

Loading

jbee Mar 12, 2019 •

edited

Loading

jbee Mar 12, 2019 •

edited

Loading

jbee Mar 12, 2019 •

edited

Loading

jbee Mar 12, 2019 •

edited

Loading

jbee Mar 12, 2019

jbee Mar 12, 2019

jbee Mar 12, 2019

jbee Mar 12, 2019

jbee Mar 12, 2019

jbee Mar 12, 2019 •

edited

Loading

jbee Mar 12, 2019

jbee commented Mar 12, 2019

jbee Mar 13, 2019

MattGill98 left a comment

jbee commented Mar 13, 2019

jbee Mar 18, 2019

jbee commented Mar 18, 2019

PAYARA-3466 Open API 1.1 #3827

PAYARA-3466 Open API 1.1 #3827

Conversation

jbee commented Mar 12, 2019 • edited Loading

jbee Mar 12, 2019 • edited Loading

Choose a reason for hiding this comment

jbee Mar 12, 2019 • edited Loading

Choose a reason for hiding this comment

jbee Mar 12, 2019 • edited Loading

Choose a reason for hiding this comment

jbee Mar 12, 2019 • edited Loading

Choose a reason for hiding this comment

jbee Mar 12, 2019 • 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

jbee Mar 12, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jbee commented Mar 12, 2019

Choose a reason for hiding this comment

MattGill98 left a comment

Choose a reason for hiding this comment

jbee commented Mar 13, 2019

Choose a reason for hiding this comment

jbee commented Mar 18, 2019

jbee commented Mar 12, 2019 •

edited

Loading

jbee Mar 12, 2019 •

edited

Loading

jbee Mar 12, 2019 •

edited

Loading

jbee Mar 12, 2019 •

edited

Loading

jbee Mar 12, 2019 •

edited

Loading

jbee Mar 12, 2019 •

edited

Loading

jbee Mar 12, 2019 •

edited

Loading