diff options
author | Lusheng Ji <lji@research.att.com> | 2017-10-12 02:47:00 +0000 |
---|---|---|
committer | Lusheng Ji <lji@research.att.com> | 2017-10-12 02:47:11 +0000 |
commit | 6553a13f948ffbf48c3bf5ec723372df137a085c (patch) | |
tree | 2370be2e104c36753716720dd0a310347471ce49 /docs/sections/apis/config_binding.rst | |
parent | 72c4fbaceb680b3b34e177ccca11efe18de599f5 (diff) |
Add more docs
Issue-Id: DCAEGEN2-128
Change-Id: Ieda6d44d0e98bf1a29922ef95e605e7a08104111
Signed-off-by: Lusheng Ji <lji@research.att.com>
Diffstat (limited to 'docs/sections/apis/config_binding.rst')
-rw-r--r-- | docs/sections/apis/config_binding.rst | 113 |
1 files changed, 113 insertions, 0 deletions
diff --git a/docs/sections/apis/config_binding.rst b/docs/sections/apis/config_binding.rst new file mode 100644 index 00000000..51074455 --- /dev/null +++ b/docs/sections/apis/config_binding.rst @@ -0,0 +1,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 +~~~~~~~~~~~~~~~ + |