diff options
author | Vijay Venkatesh Kumar <vv770d@att.com> | 2019-05-16 15:39:37 +0000 |
---|---|---|
committer | Gerrit Code Review <gerrit@onap.org> | 2019-05-16 15:39:37 +0000 |
commit | 3b9a50e63c746502008e309dbf7f1b7f93b13455 (patch) | |
tree | 6add8aa7405ea724b64b71c04cb91e69ec9a562b /docs/sections/apis/PRH.json | |
parent | 4a72cd95b6759a13a2327ac65faaa9535d21620b (diff) | |
parent | 1af30536774a0872b180f6c74a3e4ed487218747 (diff) |
Merge "Integration with Swagger"
Diffstat (limited to 'docs/sections/apis/PRH.json')
-rw-r--r-- | docs/sections/apis/PRH.json | 115 |
1 files changed, 115 insertions, 0 deletions
diff --git a/docs/sections/apis/PRH.json b/docs/sections/apis/PRH.json new file mode 100644 index 00000000..7ac63a55 --- /dev/null +++ b/docs/sections/apis/PRH.json @@ -0,0 +1,115 @@ +{ + "swagger": "2.0", + "info": { + "description": "This page lists all the rest apis for PRH app server.", + "version": "1.0", + "title": "PRH app server" + }, + "host": "localhost:8100", + "basePath": "/", + "tags": [ + { + "name": "heartbeat-controller", + "description": "Check liveness of PRH service" + }, + { + "name": "schedule-controller", + "description": "Schedule Controller" + } + ], + "paths": { + "/heartbeat": { + "get": { + "tags": [ + "heartbeat-controller" + ], + "summary": "Returns liveness of PRH service", + "operationId": "heartbeatUsingGET", + "produces": [ + "*/*" + ], + "responses": { + "200": { + "description": "PRH sevice 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" + } + } + } + }, + "/stopPrh": { + "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»»" + } + } +} |