feat: initial implementation of microprofile-openapi-3 #483

dcdh · 2024-10-12T17:45:29Z

No description provided.

codescene-delta-analysis

✅ Code Health Quality Gates: OK

Change in average Code Health of affected files: +0.04 (9.69 -> 9.73)

Declining Code Health: 1 findings(s) 🚩

View detailed results in CodeScene

.../com/github/victools/jsonschema/module/microprofile/openapi3/MicroProfileOpenApi3Module.java

...com/github/victools/jsonschema/module/microprofile/openapi3/integration-test-result-Foo.json

codescene-delta-analysis

✅ Code Health Quality Gates: OK

Change in average Code Health of affected files: +0.04 (9.69 -> 9.73)

Declining Code Health: 1 findings(s) 🚩

View detailed results in CodeScene

.../com/github/victools/jsonschema/module/microprofile/openapi3/MicroProfileOpenApi3Module.java

codescene-delta-analysis

✅ Code Health Quality Gates: OK

Change in average Code Health of affected files: +0.04 (9.69 -> 9.73)

Declining Code Health: 1 findings(s) 🚩

View detailed results in CodeScene

jsonschema-maven-plugin/README.md

...en-plugin/src/main/java/com/github/victools/jsonschema/plugin/maven/SchemaGeneratorMojo.java

jsonschema-module-microprofile-openapi-3/README.md

.../com/github/victools/jsonschema/module/microprofile/openapi3/MicroProfileOpenApi3Module.java

...com/github/victools/jsonschema/module/microprofile/openapi3/integration-test-result-Foo.json

codescene-delta-analysis

✅ Code Health Quality Gates: OK

Change in average Code Health of affected files: +0.04 (9.69 -> 9.73)

Declining Code Health: 1 findings(s) 🚩

View detailed results in CodeScene

codescene-delta-analysis

✅ Code Health Quality Gates: OK

Change in average Code Health of affected files: +0.04 (9.69 -> 9.73)

Declining Code Health: 1 findings(s) 🚩

View detailed results in CodeScene

codescene-delta-analysis

✅ Code Health Quality Gates: OK

Change in average Code Health of affected files: +0.04 (9.69 -> 9.73)

Declining Code Health: 1 findings(s) 🚩

View detailed results in CodeScene

codescene-delta-analysis

✅ Code Health Quality Gates: OK

Change in average Code Health of affected files: +0.04 (9.69 -> 9.73)

Declining Code Health: 1 findings(s) 🚩

View detailed results in CodeScene

codescene-delta-analysis · 2024-10-12T20:44:34Z

.../com/github/victools/jsonschema/module/microprofile/openapi3/MicroProfileOpenApi3Module.java

+    protected void overrideInstanceAttributes(ObjectNode memberAttributes, MemberScope<?, ?> member, SchemaGenerationContext context) {
+        Schema annotation = this.getSchemaAnnotationValue(member, Function.identity(), x -> true)
+                .orElse(null);
+        if (annotation == null) {
+            return;
+        }
+        if (annotation.not() != Void.class) {
+            memberAttributes.set(context.getKeyword(SchemaKeyword.TAG_NOT),
+                    context.createDefinitionReference(context.getTypeContext().resolve(annotation.not())));
+        }
+        if (annotation.allOf().length > 0) {
+            ArrayNode allOfArray = memberAttributes.withArray(context.getKeyword(SchemaKeyword.TAG_ALLOF));
+            Stream.of(annotation.allOf())
+                    .map(context.getTypeContext()::resolve)
+                    .map(context::createDefinitionReference)
+                    .forEach(allOfArray::add);
+        }
+        if (annotation.anyOf().length > 0) {
+            ArrayNode allOfArray = memberAttributes.withArray(context.getKeyword(SchemaKeyword.TAG_ALLOF));
+            ArrayNode anyOfArray = allOfArray.addObject().withArray(context.getKeyword(SchemaKeyword.TAG_ANYOF));
+            Stream.of(annotation.anyOf())
+                    .map(context.getTypeContext()::resolve)
+                    .map(context::createDefinitionReference)
+                    .forEach(anyOfArray::add);
+        }
+        if (annotation.oneOf().length > 0) {
+            ArrayNode allOfArray = memberAttributes.withArray(context.getKeyword(SchemaKeyword.TAG_ALLOF));
+            ArrayNode oneOfArray = allOfArray.addObject().withArray(context.getKeyword(SchemaKeyword.TAG_ONEOF));
+            Stream.of(annotation.oneOf())
+                    .map(context.getTypeContext()::resolve)
+                    .map(context::createDefinitionReference)
+                    .forEach(oneOfArray::add);
+        }
+        if (annotation.minProperties() > 0) {
+            memberAttributes.put(context.getKeyword(SchemaKeyword.TAG_PROPERTIES_MIN), annotation.minProperties());
+        }
+        if (annotation.maxProperties() > 0) {
+            memberAttributes.put(context.getKeyword(SchemaKeyword.TAG_PROPERTIES_MAX), annotation.maxProperties());
+        }
+        if (annotation.requiredProperties().length > 0) {
+            Set<String> alreadyMentionedRequiredFields = new HashSet<>();
+            ArrayNode requiredFieldNames = memberAttributes
+                    .withArray(context.getKeyword(SchemaKeyword.TAG_REQUIRED));
+            requiredFieldNames
+                    .forEach(arrayItem -> alreadyMentionedRequiredFields.add(arrayItem.asText()));
+            Stream.of(annotation.requiredProperties())
+                    .filter(field -> !alreadyMentionedRequiredFields.contains(field))
+                    .forEach(requiredFieldNames::add);
+        }
+    }


❌ New issue: Complex Method
overrideInstanceAttributes has a cyclomatic complexity of 11, threshold = 9

_Suppress

…d Schema.True should be taken into account

codescene-delta-analysis

✅ Code Health Quality Gates: OK

Change in average Code Health of affected files: +0.04 (9.69 -> 9.73)

Declining Code Health: 1 findings(s) 🚩

View detailed results in CodeScene

...thub/victools/jsonschema/module/microprofile/openapi3/MicroProfileOpenApi3AnyOfResolver.java

jsonschema-module-microprofile-openapi-3/README.md

...thub/victools/jsonschema/module/microprofile/openapi3/MicroProfileOpenApi3AnyOfResolver.java

.../com/github/victools/jsonschema/module/microprofile/openapi3/MicroProfileOpenApi3Module.java

CarstenWickner · 2024-10-14T20:02:32Z

.../com/github/victools/jsonschema/module/microprofile/openapi3/MicroProfileOpenApi3Module.java

+        if (annotation.anyOf().length > 0) {
+            ArrayNode allOfArray = memberAttributes.withArray(context.getKeyword(SchemaKeyword.TAG_ALLOF));
+            ArrayNode anyOfArray = allOfArray.addObject().withArray(context.getKeyword(SchemaKeyword.TAG_ANYOF));
+            Stream.of(annotation.anyOf())
+                    .map(context.getTypeContext()::resolve)
+                    .map(context::createDefinitionReference)
+                    .forEach(anyOfArray::add);
+        }


suggestion: As per my other comment, I suggest letting the anyOf options be handled as subtypes. This may resolut in a cleaner schema being generated.

By removing this bloc and keep MicroProfileOpenApi3AnyOfResolver my test on Foo.class is failing.

codescene-delta-analysis

✅ Code Health Quality Gates: OK

Change in average Code Health of affected files: +0.03 (9.69 -> 9.72)

Declining Code Health: 1 findings(s) 🚩

View detailed results in CodeScene

codescene-delta-analysis

✅ Code Health Quality Gates: OK

Change in average Code Health of affected files: +0.03 (9.69 -> 9.72)

Declining Code Health: 1 findings(s) 🚩

View detailed results in CodeScene

codescene-delta-analysis

✅ Code Health Quality Gates: OK

Change in average Code Health of affected files: +0.03 (9.69 -> 9.72)

Declining Code Health: 1 findings(s) 🚩

View detailed results in CodeScene

codescene-delta-analysis

✅ Code Health Quality Gates: OK

Change in average Code Health of affected files: +0.03 (9.69 -> 9.72)

Declining Code Health: 1 findings(s) 🚩

View detailed results in CodeScene

…Annotation

codescene-delta-analysis

✅ Code Health Quality Gates: OK

Change in average Code Health of affected files: +0.04 (9.69 -> 9.73)

Declining Code Health: 1 findings(s) 🚩

View detailed results in CodeScene

codescene-delta-analysis

✅ Code Health Quality Gates: OK

Change in average Code Health of affected files: +0.04 (9.69 -> 9.73)

Declining Code Health: 1 findings(s) 🚩

View detailed results in CodeScene

codescene-delta-analysis bot approved these changes Oct 12, 2024

View reviewed changes

.../com/github/victools/jsonschema/module/microprofile/openapi3/MicroProfileOpenApi3Module.java Outdated Show resolved Hide resolved

dcdh mentioned this pull request Oct 12, 2024

support MicroProfile OpenAPI 3.x #484

Open

dcdh commented Oct 12, 2024

View reviewed changes

...com/github/victools/jsonschema/module/microprofile/openapi3/integration-test-result-Foo.json Outdated Show resolved Hide resolved

dcdh force-pushed the microprofile-openapi-3 branch from e59cec4 to ced7387 Compare October 12, 2024 17:59

codescene-delta-analysis bot approved these changes Oct 12, 2024

View reviewed changes

dcdh commented Oct 12, 2024

View reviewed changes

.../com/github/victools/jsonschema/module/microprofile/openapi3/MicroProfileOpenApi3Module.java Outdated Show resolved Hide resolved

dcdh changed the title ~~microprofile-openapi-3 initial implementation~~ feat: initial implementation of microprofile-openapi-3 Oct 12, 2024

victools#484 feat: initial implementation of microprofile-openapi-3

7db5831

dcdh force-pushed the microprofile-openapi-3 branch from ced7387 to 7db5831 Compare October 12, 2024 18:03

codescene-delta-analysis bot approved these changes Oct 12, 2024

View reviewed changes

CarstenWickner reviewed Oct 12, 2024

View reviewed changes

victools#484 preserve the alphabetical order

dcfbc92

codescene-delta-analysis bot approved these changes Oct 12, 2024

View reviewed changes

victools#484 preserve the alphabetical order

0a2f858

codescene-delta-analysis bot approved these changes Oct 12, 2024

View reviewed changes

victools#484 add missing imports

84ae819

codescene-delta-analysis bot approved these changes Oct 12, 2024

View reviewed changes

victools#484 removed comments from copy past Swagger2Module

d8450d4

codescene-delta-analysis bot approved these changes Oct 12, 2024

View reviewed changes

victools#484 fix additionalProperties behavior : only Schema.False an…

6c385a2

…d Schema.True should be taken into account

codescene-delta-analysis bot approved these changes Oct 12, 2024

View reviewed changes

dcdh commented Oct 12, 2024

View reviewed changes

...thub/victools/jsonschema/module/microprofile/openapi3/MicroProfileOpenApi3AnyOfResolver.java Show resolved Hide resolved

dcdh requested a review from CarstenWickner October 13, 2024 09:30

CarstenWickner reviewed Oct 14, 2024

View reviewed changes

codescene-delta-analysis bot approved these changes Oct 16, 2024

View reviewed changes

dcdh added 2 commits October 16, 2024 23:06

victools#484 add missing import

718e6c2

victools#484 re-use isArrayType to be more consistent

66cb37b

victools#484 remove redundant checked condition by getArraySchemaType…

674d3ff

…Annotation

dcdh force-pushed the microprofile-openapi-3 branch from e604d73 to 674d3ff Compare October 16, 2024 21:07

codescene-delta-analysis bot approved these changes Oct 16, 2024

View reviewed changes

dcdh requested a review from CarstenWickner October 16, 2024 21:10

Merge branch 'main' into microprofile-openapi-3

0310591

codescene-delta-analysis bot approved these changes Nov 11, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: initial implementation of microprofile-openapi-3 #483

feat: initial implementation of microprofile-openapi-3 #483

dcdh commented Oct 12, 2024

codescene-delta-analysis bot left a comment

codescene-delta-analysis bot left a comment

codescene-delta-analysis bot left a comment

codescene-delta-analysis bot left a comment

codescene-delta-analysis bot left a comment

codescene-delta-analysis bot left a comment

codescene-delta-analysis bot left a comment

codescene-delta-analysis bot Oct 12, 2024

codescene-delta-analysis bot left a comment

CarstenWickner Oct 14, 2024

dcdh Oct 16, 2024

codescene-delta-analysis bot left a comment

codescene-delta-analysis bot left a comment

codescene-delta-analysis bot left a comment

codescene-delta-analysis bot left a comment

codescene-delta-analysis bot left a comment

codescene-delta-analysis bot left a comment

feat: initial implementation of microprofile-openapi-3 #483

Are you sure you want to change the base?

feat: initial implementation of microprofile-openapi-3 #483

Conversation

dcdh commented Oct 12, 2024

codescene-delta-analysis bot left a comment

Choose a reason for hiding this comment

codescene-delta-analysis bot left a comment

Choose a reason for hiding this comment

codescene-delta-analysis bot left a comment

Choose a reason for hiding this comment

codescene-delta-analysis bot left a comment

Choose a reason for hiding this comment

codescene-delta-analysis bot left a comment

Choose a reason for hiding this comment

codescene-delta-analysis bot left a comment

Choose a reason for hiding this comment

codescene-delta-analysis bot left a comment

Choose a reason for hiding this comment

codescene-delta-analysis bot Oct 12, 2024

Choose a reason for hiding this comment

codescene-delta-analysis bot left a comment

Choose a reason for hiding this comment

CarstenWickner Oct 14, 2024

Choose a reason for hiding this comment

dcdh Oct 16, 2024

Choose a reason for hiding this comment

codescene-delta-analysis bot left a comment

Choose a reason for hiding this comment

codescene-delta-analysis bot left a comment

Choose a reason for hiding this comment

codescene-delta-analysis bot left a comment

Choose a reason for hiding this comment

codescene-delta-analysis bot left a comment

Choose a reason for hiding this comment

codescene-delta-analysis bot left a comment

Choose a reason for hiding this comment

codescene-delta-analysis bot left a comment

Choose a reason for hiding this comment