#605 Review outcomes

scenarioo · Jun 21, 2018 · ea9b81d · ea9b81d
1 parent 0d5989a
commit ea9b81d
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 54 deletions.
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -45,7 +45,6 @@ as explained in the [Migration Guide](Migration-Guide.md). This can not be confi
 
 * **Some undocumented REST endpoints for the frontend have slightly changed:** in case you used these services you have to adjust the usage:
     * `/builds/reimportBuild/{branchName}/{buildName}` is now `/builds/:branchName/:buildName/import`
-    * `/importBuild/{branchName}/{buildName}/{comparisonBranchName}/{comparisonBuildName}/{comparisonName}` is now `/builds/{branchName}/{buildName}/comparisons/{comparisonName}/importAndCompare`
 
 Apart from that there are no breaking changes.
 

diff --git a/docs/features/diff-viewer/diff-viewer-rest-api.md b/docs/features/diff-viewer/diff-viewer-rest-api.md
@@ -4,9 +4,9 @@ The Diff Viewer REST API is intended for people who want to include visual regre
 
 Parameters:
 
-* `branchName` / `buildName` in URL: build to compare with the comparison build
+* `branchName` / `buildName` in URL: build to compare with the comparison build. This is the build where the comparison will show up in the selection dropdown.
 * `comparisonName`: name under which the comparison will be available for selection
-* `banchName` / `buildName` in payload: comparison build
+* `banchName` / `buildName` in payload: the build the above build is compared with
 
 ## Calculate Configured Comparisons
 
@@ -22,9 +22,6 @@ Payload:
 
 `{ "branchName": "{comparisonBranchName}", "buildName": "{comparisonBuildName}" }`
 
-The response looks the same as the one returned by the [Get Calculation](#get-calculation) endpoint.
-
-In Scenarioo 3.0.0 the URL was different: `importBuild/{branchName}/{buildName}/{comparisonBranchName}/{comparisonBuildName}/{comparisonName}`.
 
 ## Request Comparison Calculation
 
@@ -57,42 +54,3 @@ The return value is one of these:
 Returns the calculation object. This can be used to read the overall change rate (field `changeRate`).
 
 `GET /rest/builds/{branchName}/{buildName}/comparisons/{comparisonName}`
-
-Example response:
-
-```
-{
-    "changeRate": 73.33333333333334,
-    "name": "To last Sprint",
-    "added": 1,
-    "changed": 2,
-    "removed": 1,
-    "addedElements": [
-        "SwitchLanguageUserInterfaceTest"
-    ],
-    "removedElements": [
-        {
-            "name": "Switch Language",
-            "description": "Search in a different language and switch language of current article.",
-            "status": null,
-            "details": {
-                "Webtest Class": "org.scenarioo.uitest.example.testcases.SwitchLanguageUITest"
-            },
-            "labels": {
-                "label": []
-            }
-        }
-    ],
-    "baseBuild": {
-        "branchName": "wikipedia-docu-example-dev",
-        "buildName": "2014-05-19"
-    },
-    "compareBuild": {
-        "branchName": "wikipedia-docu-example-dev",
-        "buildName": "2014-04-19"
-    },
-    "status": "SUCCESS",
-    "calculationDate": 1529565030511,
-    "baseBuildDate": null
-}
-```
diff --git a/docs/features/diff-viewer/diff-viewer.md b/docs/features/diff-viewer/diff-viewer.md
@@ -13,8 +13,8 @@ The following sections describe how you can create, browse, configure, manage an
 3. [Browse Comparison Differences](#browse-comparison-differences)
 4. [Hide Comparisons](#hide-comparisons)
 5. [Configuration of Automatic Comparisons](#configuration-of-automatic-comparisons)
-6. [Manage Comparisons](#manage-comparisons)
-7. [Integrate Comparisons in CI Pipeline](#integrate-comparisons-in-ci-pipeline)
+6. [Integrate Comparisons in CI Pipeline](#integrate-comparisons-in-ci-pipeline)
+7. [Manage Comparisons](#manage-comparisons)
 8. [Delete Comparisons](#delete-comparisons)
 
 ## Create Comparison Manually
@@ -158,15 +158,20 @@ Once you configured automatic comparisons to be calculated you can trigger autom
    * NOTE: The "Import & Update Builds" Button will only start a comparison if a build gets imported for the first time.
 * Create a new build and upload it to Scenarioo in the usual way (see [Publish Scenarioo Documentation Data](../../tutorial/Publish-Documentation-Data.md)).
 
+
+## Integrate Comparisons in CI Pipeline
+
+You can trigger comparisons from your CI pipeline to do visual regression testing.
+
+See: [Diff Viewer REST API](diff-viewer-rest-api.md).
+
+
 ## Manage Comparisons
 
 In the `Manage`-view there is a `Comparisons` tab that lists all calculated comparisons with further information. 
 
 There you can also see error logs in case a calculation of a comparison failed in the `Details & Logs` dialog.
 
-## Integrate Comparisons in CI Pipeline
-
-See: [Diff Viewer REST API](diff-viewer-rest-api.md).
 
 ## Delete Comparisons
 

diff --git a/scenarioo-server/src/main/java/org/scenarioo/rest/diffViewer/ComparisonsResource.java b/scenarioo-server/src/main/java/org/scenarioo/rest/diffViewer/ComparisonsResource.java
@@ -1,7 +1,6 @@
 package org.scenarioo.rest.diffViewer;
 
 import org.apache.log4j.Logger;
-import org.jboss.resteasy.annotations.Body;
 import org.scenarioo.business.builds.BranchAliasResolver;
 import org.scenarioo.business.builds.ScenarioDocuBuildsManager;
 import org.scenarioo.dao.basic.FileSystemOperationsDao;
@@ -143,9 +142,6 @@ public Response getCalculation(
 	 * Imports the build (if not imported yet) and then calculates the comparison synchronously. Be aware that this
 	 * call can be very slow when comparing large builds.
 	 * <p>
-	 * Previously this endpoint was:
-	 * /rest/builds/importBuild/{branchName}/{buildName}/{comparisonBranchName}/{comparisonBuildName}/{comparisonName}
-	 * <p>
 	 * Set branchName and buildName for the build that should be imported and compared with the comparison build.
 	 * branchName can be an alias, but buildName can't.
 	 * <p>