Introduced /message_protocols endpoint (#196)

Co-authored-by: Vishnu <vishnu.alapati@ericsson.com>

Author: vishnu-alapati

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 2.1.5
+- Introduced new (/message_protocols) Endpoint which returns the available message protocols list and their respective edition names. 
+
 ## 2.1.4
 - Fixed issue related to ER lookup strategy in REMReM-generate.
 

pom.xml

@@ -10,7 +10,7 @@
     </parent>
 
     <properties>
-        <eiffel-remrem-generate.version>2.1.4</eiffel-remrem-generate.version>
+        <eiffel-remrem-generate.version>2.1.5</eiffel-remrem-generate.version>
         <eiffel-remrem-shared.version>2.0.5</eiffel-remrem-shared.version>
         <eiffel-remrem-semantics.version>2.2.1</eiffel-remrem-semantics.version>
     </properties>

service/src/main/java/com/ericsson/eiffel/remrem/generate/controller/RemremGenerateController.java

@@ -251,6 +251,24 @@ public JsonElement getVersions() {
         return parser.parse(versions.toString());
     }
 
+    /**
+	 * Used to display the available message protocol list and their edition names.
+	 *
+	 * @return json with service names and respective edition details.
+	 */
+	@ApiOperation(value = "To get the available message protocol list and edition names", response = String.class)
+	@RequestMapping(value = "/message_protocols", method = RequestMethod.GET)
+	public JsonElement getMessageProtocols() {
+		JsonArray array = new JsonArray();
+		for (MsgService service : msgServices) {
+			JsonObject protocolObject = new JsonObject();
+			protocolObject.addProperty("name", service.getServiceName());
+			protocolObject.addProperty("edition", service.getProtocolEdition());
+			array.add(protocolObject);
+		}
+		return array;
+	}
+	
     /**
      * Returns available Eiffel event types as listed in EiffelEventType enum.
      *

wiki/markdown/usage/service.md

@@ -33,7 +33,7 @@ Available REST resources for REMReM Generate Service are described below:
 | /event_types/{mp}     | GET    | mp - message protocol, required                                                                                                             |                                                                                                                                                        | This endpoint is used to obtain Eiffel event types implemented in  [Eiffel REMReM Semantics](https://github.com/eiffel-community/eiffel-remrem-semantics).                             |
 | /template/{type}/{mp} | GET    | type - Eiffel event type mp - message protocol, required                                                                                    |                                                                                                                                                        | This endpoint is used to obtain Eiffel event templates implemented in  [Eiffel REMReM Semantics](https://github.com/eiffel-community/eiffel-remrem-semantics).                         |
 | /versions             | GET    |                                                                                                                                             |                                                                                                                                                        | This endpoint is used to get versions of generate service and all loaded protocols versions  in JSON format.                                                                           |
-
+| /message_protocols    | GET   |                                                                                                                                                        |This endpoint is used to obtain the message protocols list and  edition names in JSON format.                                                                                                                                                              |
 
 ## Examples
 
@@ -109,6 +109,18 @@ Result:
 {"serviceVersion":{"version":"x.x.x"},"endpointVersions":{"semanticsVersion":"x.x.x"}}
 ```
 
+### Examples for `/message_protocols` endpoint
+
+```
+curl -H "Content-Type: application/json" -X GET http://localhost:8080/generate/message_protocols
+```
+
+Result:
+
+```
+{{"name":"eiffelsemantics", "edition":"xxxx"}, {"name":"eiffel3", "edition":"xxxx"}}
+```
+
 ## Status Codes
 
 The response generated will have internal status codes for each and every event based on the input JSON provided.