Gitiles
Code Review Sign In
gerrit.nordix.org / onap / dcaegen2 / de4209833da37685f6f05a6732366e38dfadbed6 / . / docs / sections / apis / config_binding.rst
blob: 51074455f33f9754628dbd916e5646db9a9dc4b5 [file] [log] [blame]
Lusheng Ji6553a132017-10-12 02:47:00 +0000[diff] [blame]1Config Binding Service 1.0.0
2============================
3
4.. toctree::
5 :maxdepth: 3
6
7
8
9
10
11DEFAULT
12~~~~~~~
13
14
15
16
17GET ``/service_component/{service_component_name}``
18---------------------------------------------------
19
20
21
22Description
23+++++++++++
24
25.. raw:: html
26
27 Binds the configuration for service_component_name and returns the bound configuration as a JSON
28
29Parameters
30++++++++++
31
32.. csv-table::
33 :delim: |
34 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
35 :widths: 20, 15, 10, 10, 10, 20, 30
36
37 service_component_name | path | Yes | string | | | Service Component Name. service_component_name and service_component_name:rels must be keys in consul.
38
39
40Request
41+++++++
42
43
44Responses
45+++++++++
46
47**200**
48^^^^^^^
49
50OK; the bound config is returned as an object
51
52
53.. _i_6cb44a56118e2966acccfb86f18d0570:
54
55**Response Schema:**
56
57
58
59
60**Example:**
61
62.. code-block:: javascript
63
64 {}
65
66**404**
67^^^^^^^
68
69there is no configuration in Consul for this component
70
71
72
73
74
75
76GET ``/healthcheck``
77--------------------
78
79
80
81Description
82+++++++++++
83
84.. raw:: html
85
86 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
87
88
89Request
90+++++++
91
92
93Responses
94+++++++++
95
96**200**
97^^^^^^^
98
99Successful response
100
101
102**503**
103^^^^^^^
104
105the config binding service cannot reach Consul
106
107
108
109
110
111Data Structures
112~~~~~~~~~~~~~~~
113