Provide initial a1-pe-sim docs

Swagger tool integration
README.md
Configuration files example content

Issue-ID: INT-1887
Signed-off-by: Krystian Kedron <k.kedron@partner.samsung.com>
Change-Id: Idbdec7b3091dc78428ec5740283f82d1e2b9c19b

7 files changed, 431 insertions, 0 deletions

diff --git a/doc/resources/cells.json b/doc/resources/cells.json
new file mode 100644
index 0000000..42e94c2
--- /dev/null
+++ b/doc/resources/cells.json
@@ -0,0 +1,125 @@
+{
+  "cellList": [
+    {
+      "Cell": {
+        "networkId": "RAN001",
+        "nodeId": "Cell1",
+        "physicalCellId": 0,
+        "pnfName": "ncserver1",
+        "sectorNumber": 0,
+        "latitude": "50.11",
+        "longitude": "19.98"
+      },
+      "neighbor": [
+        {
+          "nodeId": "Cell3",
+          "blacklisted": "false"
+        },
+        {
+          "nodeId": "Cell4",
+          "blacklisted": "false"
+        },
+        {
+          "nodeId": "Cell2",
+          "blacklisted": "false"
+        }
+      ]
+    },
+    {
+      "Cell": {
+        "networkId": "RAN001",
+        "nodeId": "Cell2",
+        "physicalCellId": 1,
+        "pnfName": "ncserver1",
+        "sectorNumber": 0,
+        "latitude": "50.06",
+        "longitude": "20.03"
+      },
+      "neighbor": [
+        {
+          "nodeId": "Cell5",
+          "blacklisted": "false"
+        },
+        {
+          "nodeId": "Cell1",
+          "blacklisted": "false"
+        },
+        {
+          "nodeId": "Cell3",
+          "blacklisted": "false"
+        }
+      ]
+    },
+    {
+      "Cell": {
+        "networkId": "RAN001",
+        "nodeId": "Cell3",
+        "physicalCellId": 3,
+        "pnfName": "ncserver1",
+        "sectorNumber": 0,
+        "latitude": "50.06",
+        "longitude": "19.94"
+      },
+      "neighbor": [
+        {
+          "nodeId": "Cell5",
+          "blacklisted": "false"
+        },
+        {
+          "nodeId": "Cell1",
+          "blacklisted": "false"
+        },
+        {
+          "nodeId": "Cell4",
+          "blacklisted": "false"
+        },
+        {
+          "nodeId": "Cell2",
+          "blacklisted": "false"
+        }
+      ]
+    },
+    {
+      "Cell": {
+        "networkId": "RAN001",
+        "nodeId": "Cell4",
+        "physicalCellId": 4,
+        "pnfName": "ncserver1",
+        "sectorNumber": 0,
+        "latitude": "50.11",
+        "longitude": "19.88"
+      },
+      "neighbor": [
+        {
+          "nodeId": "Cell3",
+          "blacklisted": "false"
+        },
+        {
+          "nodeId": "Cell1",
+          "blacklisted": "false"
+        }
+      ]
+    },
+    {
+      "Cell": {
+        "networkId": "RAN001",
+        "nodeId": "Cell5",
+        "physicalCellId": 6,
+        "pnfName": "ncserver1",
+        "sectorNumber": 0,
+        "latitude": "50.01",
+        "longitude": "19.99"
+      },
+      "neighbor": [
+        {
+          "nodeId": "Cell3",
+          "blacklisted": "false"
+        },
+        {
+          "nodeId": "Cell2",
+          "blacklisted": "false"
+        }
+      ]
+    }
+  ]
+}
diff --git a/doc/resources/ue.json b/doc/resources/ue.json
new file mode 100644
index 0000000..2342723
--- /dev/null
+++ b/doc/resources/ue.json
@@ -0,0 +1,20 @@
+[
+  {
+    "id": "emergency_samsung_s10_01",
+    "latitude": "50.09",
+    "longitude": "19.94",
+    "cellId": "Cell1"
+  },
+  {
+    "id": "mobile_samsung_s20_02",
+    "latitude": "50.05",
+    "longitude": "19.95",
+    "cellId": "Cell3"
+  },
+  {
+    "id": "emergency_police_01",
+    "latitude": "50.035",
+    "longitude": "19.97",
+    "cellId": "Cell3"
+  }
+]
diff --git a/doc/resources/vnf.config b/doc/resources/vnf.config
new file mode 100644
index 0000000..695a222
--- /dev/null
+++ b/doc/resources/vnf.config
@@ -0,0 +1,7 @@
+vesHost=vesconsumer
+vesPort=30417
+vesUser=sample1
+vesPassword=sample1
+vnfId=de305d54-75b4-431b-adb2-eb6b9e546014
+vnfName=ibcx0001vm002ssc001
+vnfType=oran_sim_type
\ No newline at end of file
diff --git a/doc/swagger/templates/markdown.hbs b/doc/swagger/templates/markdown.hbs
new file mode 100644
index 0000000..546f673
--- /dev/null
+++ b/doc/swagger/templates/markdown.hbs
@@ -0,0 +1,108 @@
+#{{#info}}{{title}}
+
+
+## {{join schemes " | "}}://{{host}}{{basePath}}
+
+
+{{description}}
+
+{{#contact}}
+[**Contact the developer**](mailto:{{email}})
+{{/contact}}
+
+**Version** {{version}}
+
+[**Terms of Service**]({{termsOfService}})
+
+{{#license}}[**{{name}}**]({{url}}){{/license}}
+
+{{/info}}
+
+{{#if consumes}}**Consumes:** {{join consumes ", "}}{{/if}}
+
+{{#if produces}}**Produces:** {{join produces ", "}}{{/if}}
+
+{{#if securityDefinitions}}
+# Security Definitions
+{{/if}}
+{{> security}}
+
+# APIs
+
+{{#each paths}}
+## {{@key}}
+{{#this}}
+{{#get}}
+### GET
+{{> operation}}
+{{/get}}
+
+{{#put}}
+### PUT
+{{> operation}}
+{{/put}}
+
+{{#post}}
+### POST
+
+{{> operation}}
+
+{{/post}}
+
+{{#delete}}
+### DELETE
+{{> operation}}
+{{/delete}}
+
+{{#option}}
+### OPTION
+{{> operation}}
+{{/option}}
+
+{{#patch}}
+### PATCH
+{{> operation}}
+{{/patch}}
+
+{{#head}}
+### HEAD
+{{> operation}}
+{{/head}}
+
+{{/this}}
+{{/each}}
+
+# Definitions
+{{#each definitions}}
+## <a name="/definitions/{{key}}">{{@key}}</a>
+
+<table border="1">
+    <tr>
+        <th>name</th>
+        <th>type</th>
+        <th>required</th>
+        <th>description</th>
+        <th>example</th>
+    </tr>
+    {{#each this.properties}}
+        <tr>
+            <td>{{@key}}</td>
+            <td>
+                {{#ifeq type "array"}}
+                {{#items.$ref}}
+                    {{type}}[<a href="{{items.$ref}}">{{basename items.$ref}}</a>]
+                {{/items.$ref}}
+                {{^items.$ref}}{{type}}[{{items.type}}]{{/items.$ref}}
+                {{else}}
+                    {{#$ref}}<a href="{{$ref}}">{{basename $ref}}</a>{{/$ref}}
+                    {{^$ref}}{{type}}{{#format}} ({{format}}){{/format}}{{/$ref}}
+                {{/ifeq}}
+            </td>
+            <td>{{#required}}required{{/required}}{{^required}}optional{{/required}}</td>
+            <td>{{#description}}{{{description}}}{{/description}}{{^description}}-{{/description}}</td>
+            <td>{{example}}</td>
+        </tr>
+    {{/each}}
+</table>
+{{/each}}
+
diff --git a/doc/swagger/templates/operation.hbs b/doc/swagger/templates/operation.hbs
new file mode 100644
index 0000000..a581961
--- /dev/null
+++ b/doc/swagger/templates/operation.hbs
@@ -0,0 +1,73 @@
+{{#deprecated}}-deprecated-{{/deprecated}}
+<a id="{{operationId}}">{{summary}}</a>
+
+{{description}}
+
+{{#if externalDocs.url}}{{externalDocs.description}}. [See external documents for more details]({{externalDocs.url}})
+{{/if}}
+
+{{#if security}}
+#### Security
+{{/if}}
+
+{{#security}}
+{{#each this}}
+* {{@key}}
+{{#this}}   * {{this}}
+{{/this}}
+{{/each}}
+{{/security}}
+
+#### Request
+
+{{#if consumes}}
+**Content-Type: ** {{join consumes ", "}}{{/if}}
+
+##### Parameters
+{{#if parameters}}
+<table border="1">
+    <tr>
+        <th>Name</th>
+        <th>Located in</th>
+        <th>Required</th>
+        <th>Description</th>
+        <th>Default</th>
+        <th>Schema</th>
+    </tr>
+{{/if}}
+
+{{#parameters}}
+<tr>
+    <th>{{name}}</th>
+    <td>{{in}}</td>
+    <td>{{#if required}}yes{{else}}no{{/if}}</td>
+    <td>{{description}}{{#if pattern}} (**Pattern**: `{{pattern}}`){{/if}}</td>
+    <td> - </td>
+{{#ifeq in "body"}}
+    <td>
+    {{#ifeq schema.type "array"}}Array[<a href="{{schema.items.$ref}}">{{basename schema.items.$ref}}</a>]{{/ifeq}}
+    {{#schema.$ref}}<a href="{{schema.$ref}}">{{basename schema.$ref}}</a> {{/schema.$ref}}
+    </td>
+{{else}}
+    {{#ifeq type "array"}}
+            <td>Array[{{items.type}}] ({{collectionFormat}})</td>
+    {{else}}
+            <td>{{type}} {{#format}}({{format}}){{/format}}</td>
+    {{/ifeq}}
+{{/ifeq}}
+</tr>
+{{/parameters}}
+{{#if parameters}}
+</table>
+{{/if}}
+
+
+#### Response
+
+{{#if produces}}**Content-Type: ** {{join produces ", "}}{{/if}}
+
+
+| Status Code | Reason      | Response Model |
+|-------------|-------------|----------------|
+{{#each responses}}| {{@key}}    | {{description}} | {{#schema.$ref}}<a href="{{schema.$ref}}">{{basename schema.$ref}}</a>{{/schema.$ref}}{{#ifeq schema.type "array"}}Array[<a href="{{schema.items.$ref}}">{{basename schema.items.$ref}}</a>]{{/ifeq}}{{^schema}} - {{/schema}}|
+{{/each}}
diff --git a/doc/swagger/templates/security.hbs b/doc/swagger/templates/security.hbs
new file mode 100644
index 0000000..04f86e8
--- /dev/null
+++ b/doc/swagger/templates/security.hbs
@@ -0,0 +1,88 @@
+{{#each securityDefinitions}}
+### {{@key}}
+{{#this}}
+{{#ifeq type "oauth2"}}
+<table>
+    <tr>
+        <th>type</th>
+        <th colspan="2">{{type}}</th>
+    </tr>
+{{#if description}}
+        <tr>
+            <th>description</th>
+            <th colspan="2">{{description}}</th>
+        </tr>
+{{/if}}
+{{#if authorizationUrl}}
+        <tr>
+            <th>authorizationUrl</th>
+            <th colspan="2">{{authorizationUrl}}</th>
+        </tr>
+{{/if}}
+{{#if flow}}
+        <tr>
+            <th>flow</th>
+            <th colspan="2">{{flow}}</th>
+        </tr>
+{{/if}}
+{{#if tokenUrl}}
+        <tr>
+            <th>tokenUrl</th>
+            <th colspan="2">{{tokenUrl}}</th>
+        </tr>
+{{/if}}
+{{#if scopes}}
+    <tr>
+        <td rowspan="3">scopes</td>
+{{#each scopes}}
+            <td>{{@key}}</td>
+            <td>{{this}}</td>
+        </tr>
+        <tr>
+{{/each}}
+    </tr>
+{{/if}}
+</table>
+{{/ifeq}}
+{{#ifeq type "apiKey"}}
+<table>
+    <tr>
+        <th>type</th>
+        <th colspan="2">{{type}}</th>
+    </tr>
+{{#if description}}
+        <tr>
+            <th>description</th>
+            <th colspan="2">{{description}}</th>
+        </tr>
+{{/if}}
+{{#if name}}
+        <tr>
+            <th>name</th>
+            <th colspan="2">{{name}}</th>
+        </tr>
+{{/if}}
+{{#if in}}
+        <tr>
+            <th>in</th>
+            <th colspan="2">{{in}}</th>
+        </tr>
+{{/if}}
+</table>
+{{/ifeq}}
+{{#ifeq type "basic"}}
+<table>
+    <tr>
+        <th>type</th>
+        <th colspan="2">{{type}}</th>
+    </tr>
+{{#if description}}
+        <tr>
+            <th>description</th>
+            <th colspan="2">{{description}}</th>
+        </tr>
+{{/if}}
+</table>
+{{/ifeq}}
+{{/this}}
+{{/each}}
\ No newline at end of file
diff --git a/doc/swagger/templates/strapdown.html.hbs b/doc/swagger/templates/strapdown.html.hbs
new file mode 100644
index 0000000..ec02669
--- /dev/null
+++ b/doc/swagger/templates/strapdown.html.hbs
@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+<title>API Document</title>
+
+<xmp theme="united" style="display:none;">
+{{>markdown}}
+</xmp>
+
+<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
+</html>
\ No newline at end of file