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-740 netconf <p><a href="https://tools.ietf.org/html/rfc8040#section-3.3" class="external-link" target="_blank" rel="nofollow noopener">https://tools.ietf.org/html/rfc8040#section-3.3</a></p> <div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent"> <pre> The \{+restconf} root resource name used in responses representing the root of the "ietf-restconf" module MUST identify the "ietf-restconf" YANG module. For example, a request to GET the root resource "/restconf" in JSON format will return a representation of the API resource named "ietf-restconf:restconf". </pre> </div></div> <p>&gt; curl -u admin:admin <a href="http://localhost:8181/rests" class="external-link" target="_blank" rel="nofollow noopener">http://localhost:8181/rests</a></p> <p>&lt; 404 Not Found</p> <ul> <li>ODL aluminum</li> <li>feature:install odl-restconf-nb-rfc8040</li> <li>feature:install odl-toaster</li> </ul> NETCONF-740

RFC8040 compliance: API Resource

Bug Medium Confirmed Unresolved Ivan Hrasko Valentin Mayamsin pick-next pt Mon, 2 Nov 2020 22:04:54 +0000 Thu, 22 Jun 2023 12:17:54 +0000 Aluminium 7.0.0 restconf-nb 0 2 <p>This requires updating JAX-RS structure so that we also service the root element and return the combination of individual API resources.</p> <div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent"> <pre> +---- {+restconf} +---- data | ... +---- operations? | ... +--ro yang-library-version string</pre> </div></div> <p>i.e. we are servicing /data, /yang-library-version and /operations, but do not service /.</p> <p>We need to find out some way how to return a combination of /data, /yang-library-version and /operations.</p> <p>The problem of <a href="https://git.opendaylight.org/gerrit/c/netconf/+/102819/9" class="external-link" target="_blank" rel="nofollow noopener">patchset 9</a> is that we are not able to read other data except of YANG library version.</p> <p>There are at least these possibilities:<br/> 1. Rewrite <b>RestconfImpl</b> class to implement all needed services (<b>RestconfDataService</b>, <b>RestconfOperationsService</b>) via delegation.</p> <p>It requires the constructor as following:</p> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-java">     <span class="code-keyword">public</span> RestconfImpl(<span class="code-keyword">final</span> DatabindProvider databindProvider, <span class="code-keyword">final</span> RestconfDataService dataService,             <span class="code-keyword">final</span> RestconfOperationsService operationsService) {         <span class="code-keyword">this</span>.databindProvider = requireNonNull(databindProvider);         <span class="code-keyword">this</span>.dataService = requireNonNull(dataService);         <span class="code-keyword">this</span>.operationsService = requireNonNull(operationsService);     }</pre> </div></div> <p>and additional changes in <b>RestconfApplication</b> and  maybe also in <b>restconf-bp.xml</b>.</p> <p>2. Refactor <b>RestconfDataServiceImpl</b> and <b>RestconfOperationsServiceImpl</b> logic into utility methods which allows us to read data and operations from <b>RestconfImpl</b> class.</p> <p>3. Copy and paste code which we need...</p> <p>Following solution will not work for similar reasons like in <a href="https://jira.opendaylight.org/browse/NETCONF-822" title="Discover RPC operation through RESTCONF is failing with response 500" class="issue-link" data-issue-key="NETCONF-822"><del>NETCONF-822</del></a>. We cannot create full data like this:</p> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-java"><span class="code-keyword">final</span> <span class="code-keyword">var</span> libVersion = getLibraryVersion().getData(); <span class="code-keyword">final</span> <span class="code-keyword">var</span> data = ((NormalizedNodePayload) readData(uriInfo).getEntity()).getData(); <span class="code-keyword">final</span> <span class="code-keyword">var</span> result = Builders.containerBuilder() .withNodeIdentifier(NodeIdentifier.create(Restconf.QNAME)) .withChild((LeafNode) libVersion) .withChild((ContainerNode) data) .build(); </pre> </div></div> <p>because then we get a failure from writers:</p> <div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent"> <pre>Caused by: java.lang.IllegalArgumentException: Data tree child (urn:ietf:params:xml:ns:yang:ietf-restconf-monitoring?revision=2017-01-26)restconf-state not present in schema parent (urn:ietf:params:xml:ns:yang:ietf-restconf?revision=2017-01-26)restconf     at org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack.notPresent(SchemaInferenceStack.java:1046) ~[?:?]     at org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack.lambda$pushData$6(SchemaInferenceStack.java:853) ~[?:?]     at java.util.Optional.orElseThrow(Optional.java:403) ~[?:?]     at org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack.pushData(SchemaInferenceStack.java:853) ~[?:?]     at org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack.pushData(SchemaInferenceStack.java:847) ~[?:?]     at org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack.pushData(SchemaInferenceStack.java:841) ~[?:?]     at org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack.enterDataTree(SchemaInferenceStack.java:531) ~[?:?]     at org.opendaylight.yangtools.yang.data.util.NormalizedNodeStreamWriterStack.enterDataTree(NormalizedNodeStreamWriterStack.java:204) ~[?:?]     at org.opendaylight.yangtools.yang.data.util.NormalizedNodeStreamWriterStack.startContainerNode(NormalizedNodeStreamWriterStack.java:276) ~[?:?]     at org.opendaylight.yangtools.yang.data.codec.gson.JSONNormalizedNodeStreamWriter.startContainerNode(JSONNormalizedNodeStreamWriter.java:406) ~[?:?]     at org.opendaylight.restconf.nb.rfc8040.jersey.providers.ParameterAwareNormalizedNodeWriter.wasProcessedAsCompositeNode(ParameterAwareNormalizedNodeWriter.java:273) ~[?:?] </pre> </div></div> <p>what's true because Restconf YANG model defines <b>data</b> as just empty container <img class="emoticon" src="https://jira.opendaylight.org/images/icons/emoticons/sad.png" height="16" width="16" align="absmiddle" alt="" border="0"/>.</p> <p>OK.. we can maybe try to adjust little bit - but I expect it will not work anyway..</p> Relates NETCONF-855 Development Rank 0|i03vuv: