Update endpoints in Readme.md 59/120359/1
authorEdyta Krukowska <edyta.krukowska@nokia.com>
Fri, 9 Apr 2021 10:53:03 +0000 (12:53 +0200)
committerEdyta Krukowska <edyta.krukowska@nokia.com>
Fri, 9 Apr 2021 10:53:03 +0000 (12:53 +0200)
Issue-ID: INT-1869
Signed-off-by: Edyta Krukowska <edyta.krukowska@nokia.com>
Change-Id: Ia132d405f5ed55fb7725fc4e7f968b0f81c854ed

README.md

index 33703dd..cd45156 100644 (file)
--- 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.