From 6553a13f948ffbf48c3bf5ec723372df137a085c Mon Sep 17 00:00:00 2001 From: Lusheng Ji Date: Thu, 12 Oct 2017 02:47:00 +0000 Subject: Add more docs Issue-Id: DCAEGEN2-128 Change-Id: Ieda6d44d0e98bf1a29922ef95e605e7a08104111 Signed-off-by: Lusheng Ji --- docs/sections/apis/config_binding.yaml | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 docs/sections/apis/config_binding.yaml (limited to 'docs/sections/apis/config_binding.yaml') 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 -- cgit 1.2.3-korg