Merge "update swagger based on spectral scans"

2 files changed, 19 insertions, 12 deletions

diff --git a/docs/offeredapis/api_serviceOrder/swagger.json b/docs/offeredapis/api_serviceOrder/swagger.json
index 6c01155..f20e970 100644
--- a/docs/offeredapis/api_serviceOrder/swagger.json
+++ b/docs/offeredapis/api_serviceOrder/swagger.json
@@ -2,7 +2,7 @@
   "swagger": "2.0",
   "info": {
     "description": "Request the instantiation, deletion or modification of a service\n\nA Service Order is a type of order which can be used to describe a group of operations on service – one service order item per service. An action at the level of the service order item describes the operation to be completed on a service (add, delete for example). The service order is triggered from external system such as the BSS system in charge of the product order management to ONAP that will manage the service fulfillment.\n\nList of available subscription for serviceOrdering notifications, see /hub resources for more information:\n\n- ServiceOrderCreationNotification\n- ServiceOrderStateChangeNotification\n- ServiceOrderItemStateChangeNotification\n\n",
-    "version": "4.0.1",
+    "version": "4.1.0",
     "title": "ServiceOrder API",
     "contact": {
       "name": "ONAP",
@@ -39,6 +39,10 @@
     }
   ],
   "paths": {
+    "x-interface": {
+    "api-version": "4.1.0",
+    "last-mod-release": "Frankfurt"
+    },
     "/serviceOrder": {
       "post": {
         "tags": [
@@ -300,7 +304,7 @@
       ]
     },
     "EventType": {
-      "description": "",
+      "description": "The Event Type",
       "type": "string",
       "enum": [
         "ServiceOrderCreationNotification",
@@ -309,7 +313,7 @@
       ]
     },
     "SeverityMessage": {
-      "description": "",
+      "description": "Message Severity, either information or error",
       "type": "string",
       "enum": [
         "information",
@@ -317,7 +321,7 @@
       ]
     },
     "Error": {
-      "description": "",
+      "description": "Error code and reason",
       "required": [
         "code",
         "reason"
diff --git a/docs/offeredapis/api_serviceOrder/swagger.yaml b/docs/offeredapis/api_serviceOrder/swagger.yaml
index 0ab06bc..fa8dfeb 100644
--- a/docs/offeredapis/api_serviceOrder/swagger.yaml
+++ b/docs/offeredapis/api_serviceOrder/swagger.yaml
@@ -22,7 +22,7 @@ info:
     \ available subscription for serviceOrdering notifications, see /hub resources\
     \ for more information:\n\n- ServiceOrderCreationNotification\n- ServiceOrderStateChangeNotification\n\
     - ServiceOrderItemStateChangeNotification\n\n"
-  version: "4.0.1"
+  version: "4.1.0"
   title: "ServiceOrder API"
   contact:
     name: "ONAP"
@@ -48,6 +48,9 @@ tags:
 - name: "Notification"
   description: "provided by subscribers, which MUST registered by creating a hub resource"
 paths:
+  x-interface:
+    api-version: "4.1.0"
+    last-mod-release: "Frankfurt"
   /serviceOrder:
     post:
       tags:
@@ -87,7 +90,7 @@ paths:
         description: ""
         type: "string"
       responses:
-        201:
+        "201":
           description: "Created"
           schema:
             $ref: "#/definitions/ServiceOrder"
@@ -149,7 +152,7 @@ paths:
         type: "integer"
         format: "int32"
       responses:
-        200:
+        "200":
           description: "Ok"
           schema:
             type: "array"
@@ -192,7 +195,7 @@ paths:
         description: ""
         type: "string"
       responses:
-        200:
+        "200":
           description: "Ok"
           schema:
             $ref: "#/definitions/ServiceOrder"
@@ -248,7 +251,7 @@ paths:
         description: ""
         type: "string"
       responses:
-        201:
+        "201":
           description: "Created"
           schema:
             $ref: "#/definitions/Notification"
@@ -281,20 +284,20 @@ definitions:
     enum:
     - "reliesOn"
   EventType:
-    description: ""
+    description: "The Type of Event"
     type: "string"
     enum:
     - "ServiceOrderCreationNotification"
     - "ServiceOrderStateChangeNotification"
     - "ServiceOrderItemStateChangeNotification"
   SeverityMessage:
-    description: ""
+    description: "Enum for Message, information or error"
     type: "string"
     enum:
     - "information"
     - "error"
   Error:
-    description: ""
+    description: "Error code and reason"
     required:
     - "code"
     - "reason"