aboutsummaryrefslogtreecommitdiffstats
path: root/mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/index.html
diff options
context:
space:
mode:
Diffstat (limited to 'mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/index.html')
-rw-r--r--mso-api-handlers/mso-api-handler-infra/src/main/resources/static/readme/index.html53
1 files changed, 53 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>