Update swagger documentation 37/61337/1
authorTimoney, Dan (dt5972) <dt5972@att.com>
Mon, 20 Aug 2018 17:00:07 +0000 (13:00 -0400)
committerTimoney, Dan (dt5972) <dt5972@att.com>
Mon, 20 Aug 2018 17:00:07 +0000 (13:00 -0400)
Re-generated converted swagger doc.  Note: ideally, it would be good
to generate this on the fly based on Yang model.  However, ODL
yangtools generates swagger 1.2, and readthedocs needs version 2.
Currently we convert this using api-spec-converter tool and store
converted version.  Tried automating this conversion, which works
fine in local compiles but does not work on ONAP Jenkins (tool is
node.js based).

Change-Id: Ic607bcdcc218489a45d616bb1d280675511a760d
Issue-ID: CCSDK-476
Signed-off-by: Timoney, Dan (dt5972) <dt5972@att.com>
sliapi/model/src/main/resources/sli-api.20161110.json

index da966e1..1c6cdab 100644 (file)
         },
         "operationId": "healthcheck"
       }
+    },
+    "/operations/SLI-API:vlbcheck": {
+      "post": {
+        "produces": [
+          "application/json",
+          "application/xml"
+        ],
+        "responses": {
+          "200": {
+            "description": "No response was specified",
+            "schema": {
+              "$ref": "#/definitions/(vlbcheck)output-TOP"
+            }
+          }
+        },
+        "operationId": "vlbcheck"
+      }
     }
   },
   "definitions": {
     "(config)sli-parameterPOST": {
       "properties": {
         "boolean-value": {
-          "$ref": "#/definitions/true"
+          "$ref": "#/definitions/Optional.empty"
         },
         "int-value": {
-          "$ref": "#/definitions/-2147483648"
+          "$ref": "#/definitions/Optional.empty"
         },
         "parameter-name": {
-          "$ref": "#/definitions/Some parameter-name",
+          "$ref": "#/definitions/Optional.empty",
           "description": "Parameter name"
         },
         "string-value": {
-          "$ref": "#/definitions/Some string-value"
+          "$ref": "#/definitions/Optional.empty"
         }
       },
       "type": "object"
     "(config)test-resultPOST": {
       "properties": {
         "test-identifier": {
-          "$ref": "#/definitions/Some test-identifier"
+          "$ref": "#/definitions/Optional.empty"
         }
       },
       "type": "object"
     "(execute-graph)input": {
       "properties": {
         "SLI-API:mode": {
-          "$ref": "#/definitions/sync",
-          "enum": [
-            "sync",
-            "async"
-          ]
+          "$ref": "#/definitions/Optional.empty"
         },
         "SLI-API:module-name": {
-          "$ref": "#/definitions/Some module-name"
+          "$ref": "#/definitions/Optional.empty"
         },
         "SLI-API:rpc-name": {
-          "$ref": "#/definitions/Some rpc-name"
+          "$ref": "#/definitions/Optional.empty"
         },
         "SLI-API:sli-parameter": {
           "items": {
     "(execute-graph)output": {
       "properties": {
         "SLI-API:ack-final-indicator": {
-          "$ref": "#/definitions/Some ack-final-indicator"
+          "$ref": "#/definitions/Optional.empty"
         },
         "SLI-API:context-memory-json": {
-          "$ref": "#/definitions/Some context-memory-json"
+          "$ref": "#/definitions/Optional.empty"
         },
         "SLI-API:response-code": {
-          "$ref": "#/definitions/Some response-code"
+          "$ref": "#/definitions/Optional.empty"
         },
         "SLI-API:response-message": {
-          "$ref": "#/definitions/Some response-message"
+          "$ref": "#/definitions/Optional.empty"
         }
       },
       "type": "object"
     "(healthcheck)output": {
       "properties": {
         "SLI-API:ack-final-indicator": {
-          "$ref": "#/definitions/Some ack-final-indicator"
+          "$ref": "#/definitions/Optional.empty"
         },
         "SLI-API:context-memory-json": {
-          "$ref": "#/definitions/Some context-memory-json"
+          "$ref": "#/definitions/Optional.empty"
         },
         "SLI-API:response-code": {
-          "$ref": "#/definitions/Some response-code"
+          "$ref": "#/definitions/Optional.empty"
         },
         "SLI-API:response-message": {
-          "$ref": "#/definitions/Some response-message"
+          "$ref": "#/definitions/Optional.empty"
         }
       },
       "type": "object"
       },
       "type": "object"
     },
+    "(vlbcheck)output": {
+      "properties": {
+        "SLI-API:ack-final-indicator": {
+          "$ref": "#/definitions/Optional.empty"
+        },
+        "SLI-API:context-memory-json": {
+          "$ref": "#/definitions/Optional.empty"
+        },
+        "SLI-API:response-code": {
+          "$ref": "#/definitions/Optional.empty"
+        },
+        "SLI-API:response-message": {
+          "$ref": "#/definitions/Optional.empty"
+        }
+      },
+      "type": "object"
+    },
+    "(vlbcheck)output-TOP": {
+      "properties": {
+        "SLI-API:output": {
+          "items": {
+            "$ref": "#/definitions/(vlbcheck)output"
+          },
+          "type": "object"
+        }
+      },
+      "type": "object"
+    },
     "SLI-API(config)sli-parameter": {
       "properties": {
         "SLI-API:boolean-value": {
-          "$ref": "#/definitions/true"
+          "$ref": "#/definitions/Optional.empty"
         },
         "SLI-API:int-value": {
-          "$ref": "#/definitions/-2147483648"
+          "$ref": "#/definitions/Optional.empty"
         },
         "SLI-API:parameter-name": {
-          "$ref": "#/definitions/Some parameter-name",
+          "$ref": "#/definitions/Optional.empty",
           "description": "Parameter name"
         },
         "SLI-API:string-value": {
-          "$ref": "#/definitions/Some string-value"
+          "$ref": "#/definitions/Optional.empty"
         }
       },
       "type": "object"
       "properties": {
         "SLI-API:results": {
           "items": {
-            "$ref": "#/definitions/Some results"
+            "$ref": "#/definitions/Optional.empty"
           },
           "type": "array"
         },
         "SLI-API:test-identifier": {
-          "$ref": "#/definitions/Some test-identifier"
+          "$ref": "#/definitions/Optional.empty"
         }
       },
       "type": "object"