| Lusheng Ji | fcf5829 | 2018-02-12 11:02:44 -0500 | [diff] [blame] | 1 | # ================================================================================ |
| 2 | # Copyright (c) 2017-2018 AT&T Intellectual Property. All rights reserved. |
| 3 | # ================================================================================ |
| 4 | # Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | # you may not use this file except in compliance with the License. |
| 6 | # You may obtain a copy of the License at |
| 7 | # |
| 8 | # http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | # |
| 10 | # Unless required by applicable law or agreed to in writing, software |
| 11 | # distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | # See the License for the specific language governing permissions and |
| 14 | # limitations under the License. |
| 15 | # ============LICENSE_END========================================================= |
| 16 | # |
| 17 | # ECOMP is a trademark and service mark of AT&T Intellectual Property. |
| Lusheng Ji | 6553a13 | 2017-10-12 02:47:00 +0000 | [diff] [blame] | 18 | --- |
| 19 | swagger: "2.0" |
| 20 | info: |
| 21 | version: "1.0.0" |
| 22 | title: "Config Binding Service" |
| 23 | paths: |
| 24 | /service_component/{service_component_name}: |
| 25 | parameters: |
| 26 | - name: "service_component_name" |
| 27 | in: "path" |
| 28 | description: "Service Component Name. service_component_name and service_component_name:rels must be keys in consul." |
| 29 | required: true |
| 30 | type: "string" |
| 31 | get: |
| 32 | description: "Binds the configuration for service_component_name and returns the bound configuration as a JSON" |
| 33 | operationId: "config_binding_service.controller.bind_config_for_scn" |
| 34 | responses: |
| 35 | 200: |
| 36 | description: OK; the bound config is returned as an object |
| 37 | schema: |
| 38 | type: object |
| 39 | 404: |
| 40 | description: there is no configuration in Consul for this component |
| 41 | /healthcheck: |
| 42 | get: |
| 43 | 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" |
| 44 | operationId: "config_binding_service.controller.healthcheck" |
| 45 | parameters: [] |
| 46 | responses: |
| 47 | 200: |
| 48 | description: Successful response |
| 49 | 503: |
| 50 | description: the config binding service cannot reach Consul |