From 06278030f1a10ee4177d979f32c7549ab22c385c Mon Sep 17 00:00:00 2001 From: Idan Amit Date: Mon, 23 Oct 2017 12:36:06 +0300 Subject: Added Offered APIs Page for sdc docs Changed instance of ecomp to ONAP Change-Id: I5cb4655edcf9276f4a19245218a9d11b8d82144c Issue-ID: SDC-419 Signed-off-by: Idan Amit --- .../openecomp/sdc/be/servlets/ConsumerServlet.java | 2 +- .../org/openecomp/sdc/be/servlets/ElementServlet.java | 4 ++-- docs/offeredapis.rst | 19 ++++++++++--------- 3 files changed, 13 insertions(+), 12 deletions(-) diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ConsumerServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ConsumerServlet.java index ecbd667623..c207497a22 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ConsumerServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ConsumerServlet.java @@ -70,7 +70,7 @@ public class ConsumerServlet extends BeGenericServlet { @POST @Consumes(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON) - @ApiOperation(value = "Consumer credentials", httpMethod = "POST", notes = "Returns created ECOMP consumer credentials", response = Response.class) + @ApiOperation(value = "Consumer credentials", httpMethod = "POST", notes = "Returns created ONAP consumer credentials", response = Response.class) @ApiResponses(value = { @ApiResponse(code = 201, message = "Consumer credentials created"), @ApiResponse(code = 403, message = "Restricted operation"), @ApiResponse(code = 400, message = "Invalid content / Missing content") }) public Response createConsumer(@ApiParam(value = "Consumer Object to be created", required = true) String data, @Context final HttpServletRequest request, @HeaderParam(value = Constants.USER_ID_HEADER) String userId) { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ElementServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ElementServlet.java index 4b2ff89ef8..da9b867041 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ElementServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ElementServlet.java @@ -613,8 +613,8 @@ public class ElementServlet extends BeGenericServlet { @Path("/ecompPortalMenu") @Consumes(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON) - @ApiOperation(value = "Retrieve ecomp portal menu - MOC", httpMethod = "GET", notes = "Retrieve ecomp portal menu", response = User.class) - @ApiResponses(value = { @ApiResponse(code = 200, message = "Retrieve ecomp portal menu") }) + @ApiOperation(value = "Retrieve ONAP portal menu - MOC", httpMethod = "GET", notes = "Retrieve ONAP portal menu", response = User.class) + @ApiResponses(value = { @ApiResponse(code = 200, message = "Retrieve ONAP portal menu") }) public Response getListOfCsars(@Context final HttpServletRequest request) { return buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.OK), "[{\"menuId\":1,\"column\":2,\"text\":\"Design\",\"parentMenuId\":null,\"url\":\"\",\"appid\":null,\"roles\":null,\"children\":[{\"menuId\":11,\"column\":1,\"text\":\"ProductDesign\",\"parentMenuId\":1,\"url\":\"\",\"appid\":null,\"roles\":null},{\"menuId\":12,\"column\":2,\"text\":\"Service\",\"parentMenuId\":1,\"url\":\"\",\"appid\":null,\"roles\":null,\"children\":[{\"menuId\":21,\"column\":1,\"text\":\"ViewPolicies\",\"parentMenuId\":12,\"url\":\"\",\"appid\":null,\"roles\":null,\"children\":[{\"menuId\":90,\"column\":1,\"text\":\"4thLevelApp1aR16\",\"parentMenuId\":21,\"url\":\"http://google.com\",\"appid\":null,\"roles\":null}]},{\"menuId\":22,\"column\":2,\"text\":\"UpdatePolicies\",\"parentMenuId\":12,\"url\":\"\",\"appid\":null,\"roles\":null,\"children\":[{\"menuId\":91,\"column\":1,\"text\":\"4thLevelApp1bR16\",\"parentMenuId\":22,\"url\":\"http://jsonlint.com/\",\"appid\":null,\"roles\":null}]},{\"menuId\":23,\"column\":3,\"text\":\"UpdateRules\",\"parentMenuId\":12,\"url\":\"\",\"appid\":null,\"roles\":null},{\"menuId\":24,\"column\":4,\"text\":\"CreateSignatures?\",\"parentMenuId\":12,\"url\":\"\",\"appid\":null,\"roles\":null},{\"menuId\":25,\"column\":5,\"text\":\"Definedata\",\"parentMenuId\":12,\"url\":\"\",\"appid\":null,\"roles\":null}]}]}]"); diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst index bdc5034eb0..349e7bad4f 100644 --- a/docs/offeredapis.rst +++ b/docs/offeredapis.rst @@ -1,13 +1,14 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -Offered APIs -============ +============= +Offered API’s +============= -:Date: 2017-10-18 +:Date: 2017-10-23 .. contents:: - :depth: 3 + :depth: 4 .. Overview @@ -7519,7 +7520,7 @@ Consumer credentials Description ~~~~~~~~~~~ -Returns created ECOMP consumer credentials +Returns created ONAP consumer credentials Parameters ~~~~~~~~~~ @@ -7675,8 +7676,8 @@ Tags - Consumer Servlet -Retrieve ecomp portal menu - MOC --------------------------------- +Retrieve ONAP portal menu - MOC +------------------------------- :: @@ -7685,7 +7686,7 @@ Retrieve ecomp portal menu - MOC Description ~~~~~~~~~~~ -Retrieve ecomp portal menu +Retrieve ONAP portal menu Responses ~~~~~~~~~ @@ -7694,7 +7695,7 @@ Responses | HTTP | Description | Schema | | Code | | | +=========+====================================================+================+ -| **200** | Retrieve ecomp portal menu | No Content | +| **200** | Retrieve ONAP portal menu | No Content | +---------+----------------------------------------------------+----------------+ Consumes -- cgit 1.2.3-korg