blob: ce6cf7d796c3d70150af3461b243fa109ebcaff9 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
# ============LICENSE_START=======================================================
# 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.3.1"
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
/dti/{service_component_name}:
parameters:
- name: "service_component_name"
in: "path"
description: "Service Component Name. service_component_name:dti must be a key in consul."
required: true
type: "string"
get:
description: "Returns as JSON the value for service_component_name:dti"
operationId: "config_binding_service.controller.dtievents"
responses:
200:
description: OK; the KV value is returned as an object
schema:
type: object
404:
description: there is no configuration in Consul for this component's DTI events
/policies/{service_component_name}:
parameters:
- name: "service_component_name"
in: "path"
description: "Service Component Name. service_component_name:policies must be a key in consul."
required: true
type: "string"
get:
description: "Returns as JSON the value for service_component_name:policies"
operationId: "config_binding_service.controller.policies"
responses:
200:
description: OK; the KV value is returned as an object
schema:
type: object
404:
description: there is no configuration in Consul for this component's policies
/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
|
