Integration with Swagger
Correct doc8 errors
Add licence in RST
Add API table
Add swaggerv2doc when OK
Issue-ID: DCAEGEN2-1049
Change-Id: I7478b1c34625ce03ee4f1278a04a408f6f73718e
Signed-off-by: Eric Debeau <eric.debeau@orange.com>
diff --git a/docs/sections/apis/PRH.json b/docs/sections/apis/PRH.json
new file mode 100644
index 0000000..7ac63a5
--- /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»»"
+ }
+ }
+}