summaryrefslogtreecommitdiffstats
path: root/docs/sections/apis/config_binding.rst
blob: 51074455f33f9754628dbd916e5646db9a9dc4b5 (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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
Config Binding Service 1.0.0
============================

.. toctree::
    :maxdepth: 3





DEFAULT
~~~~~~~




GET ``/service_component/{service_component_name}``
---------------------------------------------------



Description
+++++++++++

.. raw:: html

    Binds the configuration for service_component_name and returns the bound configuration as a JSON

Parameters
++++++++++

.. csv-table::
    :delim: |
    :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
    :widths: 20, 15, 10, 10, 10, 20, 30

        service_component_name | path | Yes | string |  |  | Service Component Name. service_component_name and  service_component_name:rels must be keys in consul.


Request
+++++++


Responses
+++++++++

**200**
^^^^^^^

OK; the bound config is returned as an object


.. _i_6cb44a56118e2966acccfb86f18d0570:

**Response Schema:**




**Example:**

.. code-block:: javascript

    {}

**404**
^^^^^^^

there is no configuration in Consul for this component






GET ``/healthcheck``
--------------------



Description
+++++++++++

.. raw:: html

    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


Request
+++++++


Responses
+++++++++

**200**
^^^^^^^

Successful response


**503**
^^^^^^^

the config binding service cannot reach Consul




  
Data Structures
~~~~~~~~~~~~~~~