summaryrefslogtreecommitdiffstats
path: root/docs/sections/apis/DFC.yaml
diff options
context:
space:
mode:
authorVijay Venkatesh Kumar <vv770d@att.com>2018-10-19 19:20:28 +0000
committerGerrit Code Review <gerrit@onap.org>2018-10-19 19:20:28 +0000
commit2133aae7fd41c0d100dbc31ebb5ac2d5456fc15a (patch)
tree40bbd226e87ae82d45c809d724215c7ba030d31f /docs/sections/apis/DFC.yaml
parentbb896893a798b1ddf5abd9cd17af77455ddd7432 (diff)
parent285e47c57564dbfa345cf52fffa17f67dc69e9bd (diff)
Merge "Update DFC documentation"
Diffstat (limited to 'docs/sections/apis/DFC.yaml')
-rw-r--r--docs/sections/apis/DFC.yaml76
1 files changed, 76 insertions, 0 deletions
diff --git a/docs/sections/apis/DFC.yaml b/docs/sections/apis/DFC.yaml
new file mode 100644
index 00000000..7f56ca55
--- /dev/null
+++ b/docs/sections/apis/DFC.yaml
@@ -0,0 +1,76 @@
+---
+swagger: '2.0'
+info:
+ description: This page lists all the rest apis for DATAFILE app server.
+ version: '1.0'
+ title: DATAFILE app server
+host: localhost:8100
+basePath: "/"
+tags:
+- name: heartbeat-controller
+ description: Check liveness of DATAFILE service
+- name: schedule-controller
+ description: Schedule Controller
+paths:
+ "/heartbeat":
+ get:
+ tags:
+ - heartbeat-controller
+ summary: Returns liveness of DATAFILE service
+ operationId: heartbeatUsingGET
+ produces:
+ - "*/*"
+ responses:
+ '200':
+ description: DATAFILE service is living
+ schema:
+ "$ref": "#/definitions/Mono«ResponseEntity«string»»"
+ '401':
+ description: You are not authorized to view the resource
+ '403':
+ description: Accessing the resource you were trying to reach is forbidden
+ '404':
+ description: The resource you were trying to reach is not found
+ "/start":
+ get:
+ tags:
+ - schedule-controller
+ summary: Start scheduling worker request
+ operationId: startTasksUsingGET
+ produces:
+ - "*/*"
+ responses:
+ '200':
+ description: OK
+ schema:
+ "$ref": "#/definitions/Mono«ResponseEntity«string»»"
+ '401':
+ description: Unauthorized
+ '403':
+ description: Forbidden
+ '404':
+ description: Not Found
+ "/stopDatafile":
+ get:
+ tags:
+ - schedule-controller
+ summary: Stop scheduling worker request
+ operationId: stopTaskUsingGET
+ produces:
+ - "*/*"
+ responses:
+ '200':
+ description: OK
+ schema:
+ "$ref": "#/definitions/Mono«ResponseEntity«string»»"
+ '401':
+ description: Unauthorized
+ '403':
+ description: Forbidden
+ '404':
+ description: Not Found
+definitions:
+ Mono«ResponseEntity«string»»:
+ type: object
+ title: Mono«ResponseEntity«string»»
+