Merge branch 'master' into read-write-only

Author: quen2404

README.md

@@ -28,14 +28,18 @@ Available on [Maven Central](https://search.maven.org/#search%7Cgav%7C1%7Cg%3A%2
 
 # Docker
 
-Available on [Docker Hub](https://hub.docker.com/r/quen2404/openapi-diff/)
+Available on [Docker Hub](https://hub.docker.com/r/quen2404/openapi-diff/) as `quen2404/openapi-diff`.
 
-## Build image
+## Build the image
+
+This is only required if you want to try new changes in the Dockerfile of this project.
 
 ```bash
-docker build -t openapi-diff .
+docker build -t local-openapi-diff .
 ```
 
+You can replace the local image name `local-openapi-diff` by any name of your choice.
+
 ## Run an instance
 
 In this example the `$(pwd)/src/test/resources` directory is mounted in the `/specs` directory of the container
@@ -44,9 +48,11 @@ in readonly mode (`ro`).
 ```bash
 docker run -t \
   -v $(pwd)/src/test/resources:/specs:ro \
-  openapi-diff /specs/path_1.yaml /specs/path_2.yaml
+  quen2404/openapi-diff /specs/path_1.yaml /specs/path_2.yaml
 ```
 
+The remote name `quen2404/openapi-diff` can be replaced with `local-openapi-diff` or the name you gave to your local image.
+
 # Usage
 OpenDiff can read swagger api spec from json file or http.
 

src/main/java/com/qdesrame/openapi/diff/compare/RequestBodyDiff.java

@@ -25,7 +25,9 @@ public RequestBodyDiff(OpenApiDiff openApiDiff) {
     }
 
     public Optional<ChangedRequestBody> diff(RequestBody left, RequestBody right, DiffContext context) {
-        return cachedDiff(new HashSet<>(), left, right, left.get$ref(), right.get$ref(), context);
+        String leftRef = left != null ? left.get$ref() : null,
+                rightRef = right != null ? right.get$ref() : null;
+        return cachedDiff(new HashSet<>(), left, right, leftRef, rightRef, context);
     }
 
     @Override

src/main/java/com/qdesrame/openapi/diff/compare/schemadiffresult/ComposedSchemaDiffResult.java

@@ -31,7 +31,7 @@ public ComposedSchemaDiffResult(OpenApiDiff openApiDiff) {
 
     @Override
     public Optional<ChangedSchema> diff(HashSet<String> refSet, Components leftComponents, Components rightComponents, Schema left, Schema right, DiffContext context) {
-        if(left instanceof ComposedSchema) {
+        if (left instanceof ComposedSchema) {
             ComposedSchema leftComposedSchema = (ComposedSchema) left;
             ComposedSchema rightComposedSchema = (ComposedSchema) right;
             if (CollectionUtils.isNotEmpty(leftComposedSchema.getOneOf())
@@ -53,7 +53,8 @@ public Optional<ChangedSchema> diff(HashSet<String> refSet, Components leftCompo
                 Map<String, String> rightMapping = getMapping(rightComposedSchema);
 
                 ChangedOneOfSchema changedOneOfSchema = new ChangedOneOfSchema(leftMapping, rightMapping, context);
-                MapKeyDiff<String, String> mappingDiff = MapKeyDiff.diff(leftMapping, rightMapping);
+                MapKeyDiff<String, Schema> mappingDiff = MapKeyDiff.diff(getSchema(leftComponents, leftMapping),
+                        getSchema(rightComponents, rightMapping));
                 changedOneOfSchema.setIncreasedMapping(mappingDiff.getIncreased());
                 changedOneOfSchema.setMissingMapping(mappingDiff.getMissing());
 
@@ -76,6 +77,12 @@ public Optional<ChangedSchema> diff(HashSet<String> refSet, Components leftCompo
         }
     }
 
+    private Map<String, Schema> getSchema(Components components, Map<String, String> mapping) {
+        Map<String, Schema> result = new HashMap<>();
+        mapping.forEach((key, value) -> result.put(key, refPointer.resolveRef(components, new Schema(), value)));
+        return result;
+    }
+
     private Map<String, String> getMapping(ComposedSchema composedSchema) {
         Map<String, String> reverseMapping = new HashMap<>();
         for (Schema schema : composedSchema.getOneOf()) {

src/main/java/com/qdesrame/openapi/diff/model/ChangedOneOfSchema.java

@@ -1,5 +1,6 @@
 package com.qdesrame.openapi.diff.model;
 
+import io.swagger.v3.oas.models.media.Schema;
 import lombok.Getter;
 import lombok.Setter;
 
@@ -15,8 +16,8 @@ public class ChangedOneOfSchema implements Changed {
     private final Map<String, String> newMapping;
     private final DiffContext context;
 
-    private Map<String, String> increasedMapping;
-    private Map<String, String> missingMapping;
+    private Map<String, Schema> increasedMapping;
+    private Map<String, Schema> missingMapping;
     private Map<String, ChangedSchema> changedMapping;
 
     public ChangedOneOfSchema(Map<String, String> oldMapping, Map<String, String> newMapping, DiffContext context) {

src/main/java/com/qdesrame/openapi/diff/output/MarkdownRender.java

@@ -216,13 +216,28 @@ private String schema(ChangedSchema schema) {
         return schema(1, schema);
     }
 
+    private String oneOfSchema(int deepness, ChangedOneOfSchema schema, String discriminator) {
+        StringBuilder sb = new StringBuilder("");
+        sb.append(format("%sSwitch `%s`:\n", indent(deepness), discriminator));
+        schema.getMissingMapping().keySet()
+                .forEach(key -> sb.append(format("%s- Removed '%s'\n", indent(deepness), key)));
+        schema.getIncreasedMapping().forEach((key, sub) ->
+                sb.append(format("%s- Added '%s':\n", indent(deepness), key)).append(schema(deepness + 1, sub)));
+        schema.getChangedMapping().forEach((key, sub) ->
+                sb.append(format("%s- Updated `%s`:\n", indent(deepness), key))
+                        .append(schema(deepness + 1, sub)));
+        return sb.toString();
+    }
+
     private String schema(int deepness, ChangedSchema schema) {
         StringBuilder sb = new StringBuilder("");
         if (schema.isDiscriminatorPropertyChanged()) {
             LOGGER.debug("Discriminator property changed");
         }
         if (schema.getChangedOneOfSchema() != null) {
-            LOGGER.debug("One of schema changed");
+            String discriminator = schema.getNewSchema().getDiscriminator() != null ?
+                    schema.getNewSchema().getDiscriminator().getPropertyName() : "";
+            sb.append(oneOfSchema(deepness, schema.getChangedOneOfSchema(), discriminator));
         }
         sb.append(listDiff(deepness, "enum", schema.getChangeEnum()));
         sb.append(properties(deepness, "Added property", schema.getIncreasedProperties(), true));
@@ -239,6 +254,13 @@ private String schema(int deepness, ComposedSchema schema) {
                     .map(this::resolve)
                     .forEach(composedChild -> sb.append(schema(deepness, composedChild)));
         }
+        if (schema.getOneOf() != null && schema.getOneOf() != null) {
+            LOGGER.debug("One of schema");
+            sb.append(format("%sOne of:\n\n", indent(deepness)));
+            schema.getOneOf().stream()
+                    .map(this::resolve)
+                    .forEach(composedChild -> sb.append(schema(deepness + 1, composedChild)));
+        }
         return sb.toString();
     }