aboutsummaryrefslogtreecommitdiffstats
path: root/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme
diff options
context:
space:
mode:
Diffstat (limited to 'mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme')
-rw-r--r--mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/index.html53
-rw-r--r--mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/install.html34
-rw-r--r--mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/jars.html34
-rw-r--r--mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/layout.html34
-rw-r--r--mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/logging.html34
-rw-r--r--mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/onaplogo.pngbin0 -> 21360 bytes
-rw-r--r--mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/packaging.html34
-rw-r--r--mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/page.html70
-rw-r--r--mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/readme.css114
-rw-r--r--mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/spring.html34
-rw-r--r--mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/testing.html42
-rw-r--r--mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/tools.html34
12 files changed, 517 insertions, 0 deletions
diff --git a/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/index.html b/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/index.html
new file mode 100644
index 0000000000..b6ff8f3991
--- /dev/null
+++ b/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/index.html
@@ -0,0 +1,53 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <link rel="stylesheet" type="text/css" href="./readme.css" >
+ <title>Read Me</title>
+ <script src="//code.jquery.com/jquery.min.js"></script>
+</head>
+<body>
+ <div id="page-wrapper">
+ <div id="page-setup"></div>
+ <div id="right-col">
+ <ul>
+ <li class="title">
+ <p>Introduction</p>
+ </li>
+ <li class="info-title">
+ <p>SO API Handler</p>
+ </li>
+ <li class="info">
+ <p>SO API Handler utilizes RESTful interfaces to interact with consumer applications. The SO interface
+ is used to orchestrate VNFs, allow for manual task completion, and send vnf replace requests.
+ It contains both the SOServiceInstantiation API and SOManualTasks API. </p>
+ </li>
+ <li class="info-title">
+ <p>SOServiceInstantiation API</p>
+ </li>
+ <li class="info">
+ <p>The SOServiceInstantiation API handles service instance requests, and supports both macro and aLaCarte
+ orchestrations. Change management operations, activation and deactivation of service instances, and new
+ requests for configuration resources are handled by this API. This API is currently
+ set for version 6 ("v6") while also supporting versions 4 and 5 ("v4", "v5") minus additional "v6" features.</p>
+ </li>
+ <li class="info-title">
+ <p>SOManualTasks API</p>
+ </li>
+ <li class="info">
+ <p>The SOManualTasks API handles queries about open manual tasks. This API also accepts POST requests
+ containing information about how SO should proceed with handling the open tasks, and resolving the
+ errors. SOManualTasks API currently supports version 1 ("v1"). </p>
+ </li>
+ </ul>
+ </div>
+ </div>
+ <script>
+ $.get("page.html", function(data){
+ $("#page-setup").replaceWith(data);
+ });
+ $(window).load(function() {
+ $("body").fadeIn(.5);
+ });
+ </script>
+</body>
+</html>
diff --git a/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/install.html b/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/install.html
new file mode 100644
index 0000000000..297a32074f
--- /dev/null
+++ b/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/install.html
@@ -0,0 +1,34 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <link rel="stylesheet" type="text/css" href="./readme.css" >
+ <title>Read Me</title>
+ <script src="//code.jquery.com/jquery.min.js"></script>
+</head>
+<body>
+ <div id="page-wrapper">
+ <div id="page-setup"></div>
+ <div id="right-col">
+ <ul>
+ <li class="title">
+ <p>Install</p>
+ </li>
+ <li class="info-title">
+ <p>Information Title</p>
+ </li>
+ <li class="info">
+ <p>Information</p>
+ </li>
+ </ul>
+ </div>
+ </div>
+ <script>
+ $.get("page.html", function(data){
+ $("#page-setup").replaceWith(data);
+ });
+ $(window).load(function() {
+ $("body").fadeIn(.5);
+ });
+ </script>
+</body>
+</html>
diff --git a/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/jars.html b/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/jars.html
new file mode 100644
index 0000000000..8d5c12bda7
--- /dev/null
+++ b/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/jars.html
@@ -0,0 +1,34 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <link rel="stylesheet" type="text/css" href="./readme.css" >
+ <title>Read Me</title>
+ <script src="//code.jquery.com/jquery.min.js"></script>
+</head>
+<body>
+ <div id="page-wrapper">
+ <div id="page-setup"></div>
+ <div id="right-col">
+ <ul>
+ <li class="title">
+ <p>Jars</p>
+ </li>
+ <li class="info-title">
+ <p>Information Title</p>
+ </li>
+ <li class="info">
+ <p>Information</p>
+ </li>
+ </ul>
+ </div>
+ </div>
+ <script>
+ $.get("page.html", function(data){
+ $("#page-setup").replaceWith(data);
+ });
+ $(window).load(function() {
+ $("body").fadeIn(.5);
+ });
+ </script>
+</body>
+</html>
diff --git a/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/layout.html b/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/layout.html
new file mode 100644
index 0000000000..cf47ed6a52
--- /dev/null
+++ b/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/layout.html
@@ -0,0 +1,34 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <link rel="stylesheet" type="text/css" href="./readme.css" >
+ <title>Read Me</title>
+ <script src="//code.jquery.com/jquery.min.js"></script>
+</head>
+<body>
+ <div id="page-wrapper">
+ <div id="page-setup"></div>
+ <div id="right-col">
+ <ul>
+ <li class="title">
+ <p>Layout</p>
+ </li>
+ <li class="info-title">
+ <p>Information Title</p>
+ </li>
+ <li class="info">
+ <p>Information</p>
+ </li>
+ </ul>
+ </div>
+ </div>
+ <script>
+ $.get("page.html", function(data){
+ $("#page-setup").replaceWith(data);
+ });
+ $(window).load(function() {
+ $("body").fadeIn(.5);
+ });
+ </script>
+</body>
+</html>
diff --git a/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/logging.html b/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/logging.html
new file mode 100644
index 0000000000..af68c7c634
--- /dev/null
+++ b/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/logging.html
@@ -0,0 +1,34 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <link rel="stylesheet" type="text/css" href="./readme.css" >
+ <title>Read Me</title>
+ <script src="//code.jquery.com/jquery.min.js"></script>
+</head>
+<body>
+ <div id="page-wrapper">
+ <div id="page-setup"></div>
+ <div id="right-col">
+ <ul>
+ <li class="title">
+ <p>Logging</p>
+ </li>
+ <li class="info-title">
+ <p>Information Title</p>
+ </li>
+ <li class="info">
+ <p>Information</p>
+ </li>
+ </ul>
+ </div>
+ </div>
+ <script>
+ $.get("page.html", function(data){
+ $("#page-setup").replaceWith(data);
+ });
+ $(window).load(function() {
+ $("body").fadeIn(.5);
+ });
+ </script>
+</body>
+</html>
diff --git a/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/onaplogo.png b/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/onaplogo.png
new file mode 100644
index 0000000000..c6f6857a58
--- /dev/null
+++ b/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/onaplogo.png
Binary files differ
diff --git a/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/packaging.html b/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/packaging.html
new file mode 100644
index 0000000000..a72542c968
--- /dev/null
+++ b/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/packaging.html
@@ -0,0 +1,34 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <link rel="stylesheet" type="text/css" href="./readme.css" >
+ <title>Read Me</title>
+ <script src="//code.jquery.com/jquery.min.js"></script>
+</head>
+<body>
+ <div id="page-wrapper">
+ <div id="page-setup"></div>
+ <div id="right-col">
+ <ul>
+ <li class="title">
+ <p>Packaging</p>
+ </li>
+ <li class="info-title">
+ <p>Information Title</p>
+ </li>
+ <li class="info">
+ <p>Information</p>
+ </li>
+ </ul>
+ </div>
+ </div>
+ <script>
+ $.get("page.html", function(data){
+ $("#page-setup").replaceWith(data);
+ });
+ $(window).load(function() {
+ $("body").fadeIn(.5);
+ });
+ </script>
+</body>
+</html>
diff --git a/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/page.html b/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/page.html
new file mode 100644
index 0000000000..6302bc3509
--- /dev/null
+++ b/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/page.html
@@ -0,0 +1,70 @@
+<!DOCTYPE html>
+<html lang="en">
+<body>
+ <nav id="header">
+ <a href="./index.html" title="Introduction">
+ <img src="./onaplogo.png" style= "width:250px;">
+ </a>
+ <ul class="nav-bar">
+ <li class="current">
+ <a href="./index.html" title="Introduction">Introduction</a>
+ </li>
+ </ul>
+ </nav>
+ <nav id="left-col">
+ <ul class="nav-bar">
+ <li class="pages">
+ <p>Map</p>
+ </li>
+ <li>
+ <ul class="sub-bullet">
+ <li>
+ <a href="./layout.html" title="Layout">Layout</a>
+ </li>
+ <li>
+ <a href="./jars.html" title="Jars">Jars</a>
+ </ul>
+ </li>
+ <li class="pages">
+ <p>Develop</p>
+ </li>
+ <li>
+ <ul class="sub-bullet">
+ <li>
+ <a href="./tools.html" title="Tools">Tools</a>
+ </li>
+ <li>
+ <a href="./logging.html" title="Logging">Logging</a>
+ </li>
+ </ul>
+ </li>
+ <li class="pages">
+ <p>Deploy</p>
+ </li>
+ <li>
+ <ul class="sub-bullet">
+ <li>
+ <a href="./packaging.html" title="Packaging">Packaging</a>
+ </li>
+ <li>
+ <a href="./install.html" title="Install">Install</a>
+ </li>
+ </ul>
+ </li>
+ <li class="pages">
+ <p>Run</p>
+ </li>
+ <li>
+ <ul class="sub-bullet">
+ <li>
+ <a href="./spring.html" title="Spring">Spring</a>
+ </li>
+ <li>
+ <a href="./testing.html" title="Testing">Testing</a>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </nav>
+</body>
+</html> \ No newline at end of file
diff --git a/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/readme.css b/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/readme.css
new file mode 100644
index 0000000000..68963ba3ad
--- /dev/null
+++ b/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/readme.css
@@ -0,0 +1,114 @@
+html, body{
+ margin:0;
+ padding:0;
+ height:100%;
+}
+div#page-wrapper{
+ width: 991px;
+ min-height: 100%;
+ margin: auto;
+ border-style: solid;
+ border-width: thin;
+ border-color: #d0d6e0;
+ position: relative;
+}
+body{
+ display:none;
+}
+nav#header{
+ padding: 10px;
+ width: 972px;
+ height: 101.8px;
+ border-bottom: 1px solid #d0d6e0;
+ text-align: left;
+}
+nav#header ul{
+ padding-left: 0px;
+ list-style-type: none;
+}
+nav#header a{
+ color: #008080;
+ text-decoration: none;
+}
+nav#header a:hover{
+ text-decoration: underline;
+}
+nav#left-col{
+ position: absolute;
+ left: 0;
+ width: 248px;
+ padding-bottom: 35px;
+}
+nav#left-col ul{
+ padding-left: 10px;
+ list-style-type: none;
+}
+.pages {
+ color: #008080;
+ text-decoration: none;
+ text-align: left;
+ font-size: 18px;
+}
+.sub-bullet a{
+ text-decoration: none;
+ text-align: left;
+ font-size: 14px;
+ color: black;
+}
+.sub-bullet a:hover{
+ text-decoration: underline;
+}
+div#right-col{
+ padding-left: 150px;
+ padding-bottom: 35px;
+ padding-right: 50px;
+}
+.title{
+ color: #008080;
+ font-size: 24px;
+ list-style-type: none;
+}
+.info-title{
+ color: black;
+ font-size: 18px;
+ list-style-type: none;
+}
+.info{
+ color: grey;
+ font-size: 14px;
+ list-style-type: none;
+}
+.info-list{
+ list-style-position:inside;
+ font-size: 14px;
+ color: grey;
+ position: relative;
+ padding-bottom: 5px;
+}
+.info-sublist{
+ list-style-position:inside;
+ font-size: 14px;
+ color: grey;
+ position: relative;
+ padding-bottom: 5px;
+ padding-left: 45px;
+}
+div#footer-wrapper{
+ position: absolute;
+ bottom: 0;
+ width: 981px;
+ height: 35px;
+ background-color: #008080;
+ color: white;
+ font-size:15px;
+ text-align:right;
+ padding-right:10px;
+}
+div#footer-wrapper a{
+ color: white;
+ text-align:right;
+ text-decoration:none;
+}
+div#footer-wrapper a:hover{
+ text-decoration: underline;
+}
diff --git a/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/spring.html b/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/spring.html
new file mode 100644
index 0000000000..c6e2b46710
--- /dev/null
+++ b/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/spring.html
@@ -0,0 +1,34 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <link rel="stylesheet" type="text/css" href="./readme.css" >
+ <title>Read Me</title>
+ <script src="//code.jquery.com/jquery.min.js"></script>
+</head>
+<body>
+ <div id="page-wrapper">
+ <div id="page-setup"></div>
+ <div id="right-col">
+ <ul>
+ <li class="title">
+ <p>Spring</p>
+ </li>
+ <li class="info-title">
+ <p>Information Title</p>
+ </li>
+ <li class="info">
+ <p>Information</p>
+ </li>
+ </ul>
+ </div>
+ </div>
+ <script>
+ $.get("page.html", function(data){
+ $("#page-setup").replaceWith(data);
+ });
+ $(window).load(function() {
+ $("body").fadeIn(.5);
+ });
+ </script>
+</body>
+</html>
diff --git a/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/testing.html b/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/testing.html
new file mode 100644
index 0000000000..7b558d940f
--- /dev/null
+++ b/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/testing.html
@@ -0,0 +1,42 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <link rel="stylesheet" type="text/css" href="./readme.css" >
+ <title>Read Me</title>
+ <script src="//code.jquery.com/jquery.min.js"></script>
+</head>
+<body>
+ <div id="page-wrapper">
+ <div id="page-setup"></div>
+ <div id="right-col">
+ <ul>
+ <li class="title">
+ <p>Testing</p>
+ </li>
+ <li class="info-title">
+ <p>JUnitParams: JUnit Parameterized Tests</p>
+ </li>
+ <li class="info">
+ <p>Using JUnitParams allows for the inclusion of tests running with multiple sets of parameters. A class utilizing
+ JUnitParams will specify @RunWith(JUnitParamsRunner.class) above the class declaration. To indicate that a test will
+ be using sets of parameters, include the annotation: @Parameters(method = "nameOfMethodContainingParameters").</p>
+ </li>
+ <li class="info">
+ <p>The test method signature includes the order of the parameters that it will be receiving; it will run with
+ each set of parameters provided to it. The method containing the sets of parameters to be sent to the test method is
+ indicated using the annotation: @Parameters. This method will return a collection of objects that is passed to the
+ test method.</p>
+ </li>
+ </ul>
+ </div>
+ </div>
+ <script>
+ $.get("page.html", function(data){
+ $("#page-setup").replaceWith(data);
+ });
+ $(window).load(function() {
+ $("body").fadeIn(.5);
+ });
+ </script>
+</body>
+</html>
diff --git a/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/tools.html b/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/tools.html
new file mode 100644
index 0000000000..b1813db387
--- /dev/null
+++ b/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/tools.html
@@ -0,0 +1,34 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <link rel="stylesheet" type="text/css" href="./readme.css" >
+ <title>Read Me</title>
+ <script src="//code.jquery.com/jquery.min.js"></script>
+</head>
+<body>
+ <div id="page-wrapper">
+ <div id="page-setup"></div>
+ <div id="right-col">
+ <ul>
+ <li class="title">
+ <p>Tools</p>
+ </li>
+ <li class="info-title">
+ <p>Information Title</p>
+ </li>
+ <li class="info">
+ <p>Information</p>
+ </li>
+ </ul>
+ </div>
+ </div>
+ <script>
+ $.get("page.html", function(data){
+ $("#page-setup").replaceWith(data);
+ });
+ $(window).load(function() {
+ $("body").fadeIn(.5);
+ });
+ </script>
+</body>
+</html>