API documentation guide
[doc.git] / docs / guides / onap-developer / how-to-use-docs / myAPI1.json
1 {
2   "swagger" : "2.0",
3   "info" : {
4     "description" : "my API 1",
5     "version" : "1.0.0",
6     "title" : "API example",
7     "contact" : {
8       "email" : "onap@orange.com"
9     },
10     "license" : {
11       "name" : "Apache 2.0",
12       "url" : "http://www.apache.org/licenses/LICENSE-2.0.html"
13     }
14   },
15   "host" : "serverRoot",
16   "basePath" : "/healthCheck",
17   "schemes" : [ "https" ],
18   "produces": [
19     "application/json;charset=utf-8"
20   ],
21   "paths" : {
22     "/healthCheck" : {
23       "get" : {
24         "summary" : "Displays healhcheck for my favorite component",
25         "description" : "Displays healthcheck for my favorite component",
26         "responses": {
27           "200": {
28             "description": "Service OK"
29           },
30           "503" : {
31             "description" : "Service Unavailable"
32           }
33         }
34       }
35     }
36   }
37 }