2.2

RWS · Jul 19, 2019 · dc47e92 · dc47e92
2 parents 4add3ce + cc25839
commit dc47e92
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 3 deletions.
diff --git a/...dynamic-documentation/src/main/java/com/sdl/dxa/modules/ish/controller/IshController.java b/...dynamic-documentation/src/main/java/com/sdl/dxa/modules/ish/controller/IshController.java
@@ -102,6 +102,7 @@ public IshController() {
      *
      * @param publicationId Publication id
      * @param pageId        Page id
+     * @param conditions    String representing conditions
      * @param request       Http request
      * @param response      Http response
      * @return Page model using the json format.
@@ -129,9 +130,9 @@ public ModelAndView getPage(@PathVariable Integer publicationId,
     /**
      * Get binary data.
      *
+     * @param response HTTP Response object
      * @param publicationId Publication id
      * @param binaryId      Binary id
-     * @return Binary data using a stream.
      * @throws ContentProviderException if page model cannot be fetched
      * @throws IOException if something wrong with tomcat response channel
      */

diff --git a/...ynamic-documentation/src/main/java/com/sdl/dxa/modules/ish/controller/MainController.java b/...ynamic-documentation/src/main/java/com/sdl/dxa/modules/ish/controller/MainController.java
@@ -60,6 +60,7 @@ public class MainController {
      *
      * @param request   Http request
      * @return          Home page for Docs (all the publications)
+     * @throws          ContentProviderException in case if data retrieving fails
      */
     @RequestMapping(
             value = {"/home", "/publications/**"},
@@ -75,7 +76,8 @@ public String home(HttpServletRequest request) throws ContentProviderException {
      *
      * @param publicationId Publication id
      * @param request       Http request
-     * @return  Publication home page content
+     * @return Publication home page content
+     * @throws ContentProviderException in case if data retrieving fails
      */
     @RequestMapping(
             value = "/{publicationId:[\\d]+}",
@@ -94,6 +96,7 @@ public String home(@PathVariable("publicationId") String publicationId,
      * @param pageId        Page id
      * @param request       Http request
      * @return content of the page
+     * @throws ContentProviderException in case if data retrieving fails
      */
     @RequestMapping(
             value = "/{publicationId:[\\d]+}/{pageId}/**",

diff --git a/...umentation/src/main/java/com/sdl/dxa/modules/ish/providers/TridionDocsContentService.java b/...umentation/src/main/java/com/sdl/dxa/modules/ish/providers/TridionDocsContentService.java
@@ -16,12 +16,13 @@ public class TridionDocsContentService {
 
     /**
      * Returns page Id in given publication, which ishLogicalRef equals to given reference value.
+     *
      * @param publicationId target publication Id where to look for ishlogicalref
      * @param isLogicalReferenceValue value of meta field 'ishlogicalref.object.id'. It is supposed
      *                                that that field is common for topic which is used in different
      *                                publications
      * @return page Id of topic in given publication
-     * @throws ContentProviderException
+     * @throws          ContentProviderException in case if data retrieving fails
      */
     public Item getPageIdByIshLogicalReference(Integer publicationId, String isLogicalReferenceValue)
             throws ContentProviderException {