summaryrefslogtreecommitdiffstats
path: root/sliapi
diff options
context:
space:
mode:
authorTimoney, Dan (dt5972) <dt5972@att.com>2018-08-20 13:00:07 -0400
committerTimoney, Dan (dt5972) <dt5972@att.com>2018-08-20 13:00:07 -0400
commit5a0f5957372e75b1bf5835738a23906f1bf4d8ba (patch)
tree92f29faef21214260069ed5cae09ced3e9a203ec /sliapi
parent93833b4e67713c094025648b2a7b7673a8b58de9 (diff)
Update swagger documentation
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>
Diffstat (limited to 'sliapi')
-rw-r--r--sliapi/model/src/main/resources/sli-api.20161110.json93
1 files changed, 67 insertions, 26 deletions
diff --git a/sliapi/model/src/main/resources/sli-api.20161110.json b/sliapi/model/src/main/resources/sli-api.20161110.json
index da966e1e7..1c6cdabfe 100644
--- a/sliapi/model/src/main/resources/sli-api.20161110.json
+++ b/sliapi/model/src/main/resources/sli-api.20161110.json
@@ -274,6 +274,23 @@
},
"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": {
@@ -291,17 +308,17 @@
"(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"
@@ -309,7 +326,7 @@
"(config)test-resultPOST": {
"properties": {
"test-identifier": {
- "$ref": "#/definitions/Some test-identifier"
+ "$ref": "#/definitions/Optional.empty"
}
},
"type": "object"
@@ -328,17 +345,13 @@
"(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": {
@@ -363,16 +376,16 @@
"(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"
@@ -391,16 +404,16 @@
"(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"
@@ -416,20 +429,48 @@
},
"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"
@@ -487,12 +528,12 @@
"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"