Update documentation to be CWS REST API and mention swagger

NASA-AMMOS · Apr 9, 2024 · b5225e2 · b5225e2
1 parent 2546f4f
commit b5225e2
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 20 deletions.
diff --git a/cws-service/src/main/java/jpl/cws/controller/SwaggerConfig.java b/cws-service/src/main/java/jpl/cws/controller/SwaggerConfig.java
@@ -30,7 +30,7 @@ public Docket api() {
     private ApiInfo apiInfo() {
         return new ApiInfoBuilder()
                 .title("CWS API")
-                .description("Documentation of the endpoints used by CWS. Once authenticated, requests can be made to these endpoints (submit the cwsToken cookie).")
+                .description("Documentation of the endpoints used by CWS. Once authenticated, requests can be made to these endpoints.\nTo authenticate, right click on this page --> Inspect --> Click the 'Application' tab --> Select the URL under the Cookies tab on the left --> Copy the value of the cwsToken cookie.")
                 .version("2.6.0")
                 .license("Apache 2.0")
                 .licenseUrl("https://github.com/NASA-AMMOS/common-workflow-service?tab=Apache-2.0-1-ov-file")

diff --git a/install/cws-ui/documentation.ftl b/install/cws-ui/documentation.ftl
@@ -10,25 +10,25 @@
 	<link href="/${base}/css/dashboard.css" rel="stylesheet">
 	<link href="/${base}/css/bootstrap-datepicker.min.css" rel="stylesheet">
 	<script>
-	var params = {};
-	var rows;
+		var params = {};
+		var rows;
 
-	$( document ).ready(function() {
-		// 
-		if ($("#statusMessageDiv:contains('ERROR:')").length >= 1) {
-			$("#statusMessageDiv").css( "color", "red" );
-		}
-		else {
-			$("#statusMessageDiv").css( "color", "green" );
-			if ($('#statusMessageDiv').html().length > 9) {
-				$('#statusMessageDiv').fadeOut(5000, "linear");
+		$( document ).ready(function() {
+			//
+			if ($("#statusMessageDiv:contains('ERROR:')").length >= 1) {
+				$("#statusMessageDiv").css( "color", "red" );
 			}
-		}
-	});
+			else {
+				$("#statusMessageDiv").css( "color", "green" );
+				if ($('#statusMessageDiv').html().length > 9) {
+					$('#statusMessageDiv').fadeOut(5000, "linear");
+				}
+			}
+		});
+
 
-	
 	</script>
-	
+
 	<!-- Just for debugging purposes. Don't actually copy this line! -->
 	<!--[if lt IE 9]><script src="../../assets/js/ie8-responsive-file-warning.js"></script><![endif]-->
 
@@ -58,13 +58,13 @@
 	<div class="row">
 		<#include "sidebar.ftl">
 		<div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main">
-	
+
 			<span id="statusMessageDiv">
 				<h2>${msg}</h2>
 			</span>
-	
+
 			<h2 class="sub-header">Documentation</h2>
-			
+
 			<div id="config-div">
 				<table id="configData" class="table table-striped table-bordered sortable">
 					<tr>
@@ -80,7 +80,10 @@
 						<td><a href="http://www.bpmnquickguide.com/quickguide/index.html" target="_blank">BP Incubator BPMN Quick Guide</a></td>
 					</tr>
 					<tr>
-						<td><a href="/cws-ui/api-docs" target="_blank">API Documentation</a></td>
+						<td>
+							<a href="/cws-ui/api-docs" target="_blank">CWS REST API Documentation</a>
+							<i style="margin-left: 8px; font-size: small">Created with SwaggerUI</i>
+						</td>
 					</tr>
 					<tr>
 						<td><a href="https://docs.camunda.org/rest/camunda-bpm-platform/7.20/" target="_blank">Camunda API Documentation</a></td>