api/swagger.json

   1 {
   2   "swagger" : "2.0",
   3   "info" : {
   4     "description" : "This page shows all the APIs available in the Holmes engine management module.",
   5     "version" : "v1",
   6     "title" : "API Descriptions for Holmes Engine Management",
   7     "termsOfService" : "http://www.github.com/kongchen/swagger-maven-plugin",
   8     "contact" : {
   9       "name" : "Guangrong Fu",
  10       "email" : "fu.guangrong@zte.com.cn"
  11     },
  12     "license" : {
  13       "name" : "Apache 2.0",
  14       "url" : "http://www.apache.org/licenses/LICENSE-2.0.html"
  15     }
  16   },
  17   "basePath" : "/api/holmes-engine-mgmt/v1/",
  18   "tags" : [ {
  19     "name" : "Health Check"
  20   }, {
  21     "name" : "Holmes Engine Management"
  22   } ],
  23   "paths" : {
  24     "/healthcheck" : {
  25       "get" : {
  26         "tags" : [ "Health Check" ],
  27         "summary" : "Interface for the health check of the engine management module for Holmes",
  28         "description" : "",
  29         "operationId" : "healthCheck",
  30         "produces" : [ "text/plain" ],
  31         "responses" : {
  32           "200" : {
  33             "description" : "successful operation",
  34             "schema" : {
  35               "type" : "boolean"
  36             }
  37           }
  38         }
  39       }
  40     },
  41     "/rule" : {
  42       "post" : {
  43         "tags" : [ "Holmes Engine Management" ],
  44         "summary" : "Check the validity of a rule.",
  45         "description" : "",
  46         "operationId" : "compileRule",
  47         "produces" : [ "application/json" ],
  48         "responses" : {
  49           "200" : {
  50             "description" : "successful operation",
  51             "schema" : {
  52               "type" : "boolean"
  53             }
  54           }
  55         }
  56       }
  57     }
  58   }
  59 }