diff options
| author |   Chengkai Yan <martin.c.yan@est.tech> | 2018-10-18 10:40:14 +0200 |
|---|---|---|
| committer | Chengkai Yan <martin.c.yan@est.tech> | 2018-10-18 22:28:53 +0200 |
| commit | 285e47c57564dbfa345cf52fffa17f67dc69e9bd (patch) | |
| tree | 3ff063d106d0d368fb034a60df4bb96c29825045 /docs/sections/apis/DFC.yaml | |
| parent | 2df4b8cac0edf477f4ae62ea3ea2ce8b4d3eaa20 (diff) | |
Update DFC documentation
Change-Id: Ifbe2df71a1bcce426b5e81c25ed39d34e439a943
Issue-ID: DCAEGEN2-642
Signed-off-by: elinuxhenrik <henrik.b.andersson@est.tech>
Signed-off-by: Chengkai Yan <martin.c.yan@est.tech>
Diffstat (limited to 'docs/sections/apis/DFC.yaml')
| -rw-r--r-- | docs/sections/apis/DFC.yaml | 76 |
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»» + |