summaryrefslogtreecommitdiffstats
path: root/docs/sections/apis/config_binding.yaml
diff options
context:
space:
mode:
authorLusheng Ji <lji@research.att.com>2017-10-12 02:47:00 +0000
committerLusheng Ji <lji@research.att.com>2017-10-12 02:47:11 +0000
commit6553a13f948ffbf48c3bf5ec723372df137a085c (patch)
tree2370be2e104c36753716720dd0a310347471ce49 /docs/sections/apis/config_binding.yaml
parent72c4fbaceb680b3b34e177ccca11efe18de599f5 (diff)
Add more docs
Issue-Id: DCAEGEN2-128 Change-Id: Ieda6d44d0e98bf1a29922ef95e605e7a08104111 Signed-off-by: Lusheng Ji <lji@research.att.com>
Diffstat (limited to 'docs/sections/apis/config_binding.yaml')
-rw-r--r--docs/sections/apis/config_binding.yaml33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/sections/apis/config_binding.yaml b/docs/sections/apis/config_binding.yaml
new file mode 100644
index 00000000..208e4418
--- /dev/null
+++ b/docs/sections/apis/config_binding.yaml
@@ -0,0 +1,33 @@
+---
+swagger: "2.0"
+info:
+ version: "1.0.0"
+ title: "Config Binding Service"
+paths:
+ /service_component/{service_component_name}:
+ parameters:
+ - name: "service_component_name"
+ in: "path"
+ description: "Service Component Name. service_component_name and service_component_name:rels must be keys in consul."
+ required: true
+ type: "string"
+ get:
+ description: "Binds the configuration for service_component_name and returns the bound configuration as a JSON"
+ operationId: "config_binding_service.controller.bind_config_for_scn"
+ responses:
+ 200:
+ description: OK; the bound config is returned as an object
+ schema:
+ type: object
+ 404:
+ description: there is no configuration in Consul for this component
+ /healthcheck:
+ get:
+ description: "This is the health check endpoint. If this returns a 200, the server is alive and consul can be reached. If not a 200, either dead, or no connection to consul"
+ operationId: "config_binding_service.controller.healthcheck"
+ parameters: []
+ responses:
+ 200:
+ description: Successful response
+ 503:
+ description: the config binding service cannot reach Consul