diff options
author | Lusheng Ji <lji@research.att.com> | 2018-03-27 23:24:33 -0400 |
---|---|---|
committer | Lusheng Ji <lji@research.att.com> | 2018-03-27 23:25:41 -0400 |
commit | b2a561b84b926ef109809539b9e283e95032c083 (patch) | |
tree | cf15dc96d20ba09b5a80419cd5f29201230499fb /docs/sections/apis/config_binding.yaml | |
parent | 13de8870c542c1cd87d24f1bdde5878c82276c8b (diff) |
Add documentation
Issue-ID: DCAEGEN2-206
Change-Id: I73de95e98e4cd545dcc29b0fcecf84530c23e2aa
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.yaml | 50 |
1 files changed, 0 insertions, 50 deletions
diff --git a/docs/sections/apis/config_binding.yaml b/docs/sections/apis/config_binding.yaml deleted file mode 100644 index 169f98c4..00000000 --- a/docs/sections/apis/config_binding.yaml +++ /dev/null @@ -1,50 +0,0 @@ -# ================================================================================ -# Copyright (c) 2017-2018 AT&T Intellectual Property. All rights reserved. -# ================================================================================ -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# ============LICENSE_END========================================================= -# -# ECOMP is a trademark and service mark of AT&T Intellectual Property. ---- -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 |