Add documentation

[dcaegen2.git] / docs / sections / apis / config_binding.yaml

diff --git a/docs/sections/apis/config_binding.yaml b/docs/sections/apis/config_binding.yaml
deleted file mode 100644 (file)
index 169f98c..0000000
--- 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