| Lusheng Ji | 6553a13 | 2017-10-12 02:47:00 +0000 | [diff] [blame] | 1 | --- |
| 2 | swagger: "2.0" |
| 3 | info: |
| 4 | version: "1.0.0" |
| 5 | title: "Config Binding Service" |
| 6 | paths: |
| 7 | /service_component/{service_component_name}: |
| 8 | parameters: |
| 9 | - name: "service_component_name" |
| 10 | in: "path" |
| 11 | description: "Service Component Name. service_component_name and service_component_name:rels must be keys in consul." |
| 12 | required: true |
| 13 | type: "string" |
| 14 | get: |
| 15 | description: "Binds the configuration for service_component_name and returns the bound configuration as a JSON" |
| 16 | operationId: "config_binding_service.controller.bind_config_for_scn" |
| 17 | responses: |
| 18 | 200: |
| 19 | description: OK; the bound config is returned as an object |
| 20 | schema: |
| 21 | type: object |
| 22 | 404: |
| 23 | description: there is no configuration in Consul for this component |
| 24 | /healthcheck: |
| 25 | get: |
| 26 | 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" |
| 27 | operationId: "config_binding_service.controller.healthcheck" |
| 28 | parameters: [] |
| 29 | responses: |
| 30 | 200: |
| 31 | description: Successful response |
| 32 | 503: |
| 33 | description: the config binding service cannot reach Consul |