OpenAPI: Update module revision docs 69/111869/2
authorlubos-cicut <lubos.cicut@pantheon.tech>
Tue, 28 May 2024 07:18:33 +0000 (09:18 +0200)
committerIvan Hrasko <ivan.hrasko@pantheon.tech>
Tue, 11 Jun 2024 07:50:25 +0000 (07:50 +0000)
Updated documentation according changes made in NETCONF-1303. Revision
was changed to @QueryParam, so now we have to use
/mounts/1/toaster?revision=2009-11-20 for module with revision and
/mounts/1/definition-test for module without revision.

JIRA: NETCONF-1315
Change-Id: If3244d2e6f3b9a12154082eb9c499df8e3091072
Signed-off-by: lubos-cicut <lubos.cicut@pantheon.tech>
docs/user-guide.rst

index 5c52f1f7820981d70cb64813f4e86c31651af2a4..db4425ea75336bb8311a0ec800541a9dcf19e70e 100644 (file)
@@ -2278,7 +2278,9 @@ OpenAPI URLs in that case would look like this:
 
 -  http://localhost:8181/openapi/api/v3/mounts/1 for JSON data
 
--  `http://localhost:8181/openapi/api/v3/mounts/1/toaster(2009-11-20) <http://localhost:8181/openapi/api/v3/mounts/1/toaster(2009-11-20)>`__ JSON data for given model
+-  `http://localhost:8181/openapi/api/v3/mounts/1/toaster?revision=2009-11-20 <http://localhost:8181/openapi/api/v3/mounts/1/toaster?revision=2009-11-20>`__ JSON data for given model
+
+-  `http://localhost:8181/openapi/api/v3/mounts/1/definition-test <http://localhost:8181/openapi/api/v3/mounts/1/definition-test>`__ JSON data for given model without revision
 
 .. note::