Fine tuning for std reporter + doc extension

redskap · Oct 1, 2023 · 47b2a16 · 47b2a16
1 parent 0b845d1
commit 47b2a16
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 20 deletions.
diff --git a/src-docs/src/configuration/README.md b/src-docs/src/configuration/README.md
@@ -20,11 +20,18 @@ Gradle configuration [here](../gradle/README.md#customizing-reporting).
 An example JSON report looks the following:
 ```json
 {
-  "pathDeletedBreakingChange" : [ {
-    "path" : "/pet",
-    "method" : "POST",
-    "message" : "Path /pet POST has been deleted"
-  } ]
+  "info": {
+    "title": "Example API title",
+    "description": "API description",
+    "version": "1.0.0"
+  },
+  "breakingChanges": {
+    "pathDeletedBreakingChange" : [ {
+      "path" : "/pet",
+      "method" : "POST",
+      "message" : "Path /pet POST has been deleted"
+    } ]  
+  }
 }
 ```
 In case of no breaking changes, the JSON report will be an empty JSON.

diff --git a/swagger-brake/src/main/java/io/redskap/swagger/brake/report/StdOutReporter.java b/swagger-brake/src/main/java/io/redskap/swagger/brake/report/StdOutReporter.java
@@ -13,7 +13,6 @@
 class StdOutReporter implements Reporter, CheckableReporter {
     @Override
     public void report(Collection<BreakingChange> breakingChanges, Options options, ApiInfo apiInfo) {
-        printApiInfo(apiInfo);
         printBreakingChangesIfAny(breakingChanges);
     }
 
@@ -26,20 +25,6 @@ private void printBreakingChangesIfAny(Collection<BreakingChange> breakingChange
         }
     }
 
-    private void printApiInfo(ApiInfo apiInfo) {
-        if (apiInfo != null) {
-            printIfNotNull(apiInfo.getTitle());
-            printIfNotNull(apiInfo.getDescription());
-            printIfNotNull(apiInfo.getVersion());
-        }
-    }
-
-    private void printIfNotNull(String str) {
-        if (str != null) {
-            System.out.println(str);
-        }
-    }
-
     @Override
     public boolean canReport(OutputFormat format) {
         return true;