summaryrefslogtreecommitdiffstats
path: root/config_binding_service/swagger
diff options
context:
space:
mode:
authorTommy Carpenter <tommy@research.att.com>2017-08-11 15:02:32 -0400
committerTommy Carpenter <tommy@research.att.com>2017-08-11 19:12:47 +0000
commit0581c1ed0320acd612dc38757744e8cc1212014b (patch)
tree7a9f4dbb689f56307c4ad1ca03d942c77d30b6b5 /config_binding_service/swagger
parent816ac43c7c53508ca3ec174f38bd49d1583f1d12 (diff)
Intial commit of CBS to ONAP
Change-Id: I2082544efc59476ac8de0dc39c899f968c3847bd Signed-off-by: Tommy Carpenter <tommy@research.att.com> Issue-Id: DCAEGEN2-47
Diffstat (limited to 'config_binding_service/swagger')
-rw-r--r--config_binding_service/swagger/swagger.yaml33
1 files changed, 33 insertions, 0 deletions
diff --git a/config_binding_service/swagger/swagger.yaml b/config_binding_service/swagger/swagger.yaml
new file mode 100644
index 0000000..208e441
--- /dev/null
+++ b/config_binding_service/swagger/swagger.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