summaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-developer/how-to-use-docs/myAPI1.json
diff options
context:
space:
mode:
authorEric Debeau <eric.debeau@orange.com>2019-04-10 13:48:42 +0000
committerEric Debeau <eric.debeau@orange.com>2019-04-10 18:29:08 +0000
commitd6541d87f97175993b76efb0289981b3a12b0590 (patch)
tree942bfa0802eebe5d3a137f934cd0d394e6e96b59 /docs/guides/onap-developer/how-to-use-docs/myAPI1.json
parentb370f01dd1046563b7773f47d977373a12d7d721 (diff)
API documentation guide
Guide how to use Swagger and swaggerv2dcc directive Add 2 JSON Swagger files Add code block Change-Id: If3af3f20509db2cc47bdb2cf3db9b44d8a1bcdc7 Issue-ID: DOC-426 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
Diffstat (limited to 'docs/guides/onap-developer/how-to-use-docs/myAPI1.json')
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/myAPI1.json37
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/guides/onap-developer/how-to-use-docs/myAPI1.json b/docs/guides/onap-developer/how-to-use-docs/myAPI1.json
new file mode 100644
index 000000000..b611ad81c
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-docs/myAPI1.json
@@ -0,0 +1,37 @@
+{
+ "swagger" : "2.0",
+ "info" : {
+ "description" : "my API 1",
+ "version" : "1.0.0",
+ "title" : "API example",
+ "contact" : {
+ "email" : "onap@orange.com"
+ },
+ "license" : {
+ "name" : "Apache 2.0",
+ "url" : "http://www.apache.org/licenses/LICENSE-2.0.html"
+ }
+ },
+ "host" : "serverRoot",
+ "basePath" : "/healthCheck",
+ "schemes" : [ "https" ],
+ "produces": [
+ "application/json;charset=utf-8"
+ ],
+ "paths" : {
+ "/healthCheck" : {
+ "get" : {
+ "summary" : "Displays healhcheck for my favorite component",
+ "description" : "Displays healthcheck for my favorite component",
+ "responses": {
+ "200": {
+ "description": "Service OK"
+ },
+ "503" : {
+ "description" : "Service Unavailable"
+ }
+ }
+ }
+ }
+ }
+}