aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEdyta Krukowska <edyta.krukowska@nokia.com>2021-04-09 12:53:03 +0200
committerEdyta Krukowska <edyta.krukowska@nokia.com>2021-04-09 12:53:03 +0200
commit8daf1dc7fdd75390aab484bedb20627121156f63 (patch)
tree994944b6f63689971ba5d812c234b018d641fc73
parentc0d47aca4a13b239e51772fa366fa780ec7812da (diff)
Update endpoints in Readme.md
Issue-ID: INT-1869 Signed-off-by: Edyta Krukowska <edyta.krukowska@nokia.com> Change-Id: Ia132d405f5ed55fb7725fc4e7f968b0f81c854ed
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
index 33703dd..cd45156 100644
--- a/README.md
+++ b/README.md
@@ -82,6 +82,11 @@ Example of that custom config change subscription can be found in `example` dire
### REST API
Netconf server provides REST interface, with enpoints:
- *GET* `/healthcheck` returns 200 "UP" if server is up and running
+- *POST* `/readiness` return 200 "Ready" if server is ready, if not, returns 503 "Not Ready"
+- *POST* `/change_config/<path:module_name>` changes configuration ad returns 202 "Accepted"
+- *GET* `/change_history` returns 200 and change history as json
+- *GET* `/get_config/<path:module_name>` returns 200 and current configuration
+
### logging
Netconf server print all logs on to the console.