https://jira.opendaylight.org This file is an XML representation of an issue en-us 8.20.10 820010 22-06-2022 https://jira.opendaylight.org/browse/NETCONF-1083 netconf <p>Prepared PUT request in OpenApi for "yang-ext:mount/toaster2:toaster" return 400 with error message "Error parsing input: Choose suitable module name for element toaster:\ntoaster\ntoaster2"</p> <p><span class="image-wrap" style=""><img src="https://jira.opendaylight.org/secure/attachment/19003/19003_image-2023-07-12-12-47-36-248.png" height="626" width="907" style="border: 0px solid black" /></span></p> NETCONF-1083

OpenApi returns 400 error after PUT request on toaster data

Bug Medium Resolved Done Oleksandr Zharov Peter Suna pt Wed, 12 Jul 2023 10:48:34 +0000 Mon, 14 Aug 2023 14:36:21 +0000 Mon, 14 Aug 2023 14:36:21 +0000 7.0.0 4.0.9 5.0.8 6.0.2 restconf-openapi 0 2 <p>The issue is that Json require name of the model in top container.</p> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-java"> {   <span class="code-quote">"toaster2:toaster"</span>: {     <span class="code-quote">"toasterSlot"</span>: [       {         <span class="code-quote">"slotId"</span>: <span class="code-quote">"Some slotId"</span>,         <span class="code-quote">"slotInfo"</span>: {           <span class="code-quote">"numberOfToastPrepared"</span>: 0         }       }     ],     <span class="code-quote">"darknessFactor"</span>: 0   } } </pre> </div></div> <p>To resolve this issue, it is necessary to add the module name to the top elements: `"toaster: {"` -&gt; `"toaster2:toaster: {"`</p> <p>Interestingly <b>PUT /rests/data/network-topology:network-topology/topology=topology-netconf/node=17830-sim-device/yang-ext:mount/car:cars</b></p> <p>with payload:</p> <div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent"> <pre>{   "cars": {     "car-entry": [       {         "id": "Some id",         "model": "Some model",         "manufacturer": "Some manufacturer",         "year": 0,         "category": "Some category"       }     ]   } }</pre> </div></div> <p>works well. The problem lies somewhere else.</p> <p>with/rests/data/network-topology:network-topology/topology=topology-netconf/node=17830-sim-device/yang-ext:mount/car:cars</p> <p>It appears that this issue occurs only when there are two models with the same name of the root element within the schema context.</p> <p>This means that if we have two models structured like this:</p> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-java"> module test {   yang-version 1;   namespace <span class="code-quote">"http:<span class="code-comment">//netconfcentral.org/ns/test"</span>; </span>  prefix tst;   list list {     key leaf;     leaf leaf {       type string;     }   } } module test2 {   yang-version 1;   namespace <span class="code-quote">"http:<span class="code-comment">//netconfcentral.org/ns/test2"</span>; </span>  prefix tst2;   list list {     key leaf2;     leaf leaf2 {       type string;     }   } } </pre> </div></div> <p>We must include the module name in the request body. Otherwise, requests like this will fail.</p> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-java"> curl --request PUT <span class="code-quote">'http:<span class="code-comment">//localhost:8181/rests/data/network-topology:network-topology/topology=topology-netconf/node=36001-sim-device/yang-ext:mount/test:list=string'</span> \ </span>--header <span class="code-quote">'accept: */*'</span> \ --header <span class="code-quote">'Content-Type: application/json'</span> \ --header <span class="code-quote">'Authorization: Basic YWRtaW46YWRtaW4='</span> \ --data '{     <span class="code-quote">"list"</span>: [         {             <span class="code-quote">"leaf"</span>: <span class="code-quote">"string"</span>         }     ] }' </pre> </div></div> <p>Response:</p> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-java"> {     <span class="code-quote">"errors"</span>: {         <span class="code-quote">"error"</span>: [             {                 <span class="code-quote">"error-tag"</span>: <span class="code-quote">"malformed-message"</span>,                 <span class="code-quote">"error-info"</span>: <span class="code-quote">"Choose suitable module name <span class="code-keyword">for</span> element list:\ntest2\ntest"</span>,                 <span class="code-quote">"error-message"</span>: <span class="code-quote">"Error parsing input: Choose suitable module name <span class="code-keyword">for</span> element list:\ntest2\ntest"</span>,                 <span class="code-quote">"error-type"</span>: <span class="code-quote">"protocol"</span>             }         ]     } } </pre> </div></div> Development Rank 0|i045pj: