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-1057 netconf <p>Currently, we generate for each container element (container, list) schema and, additionally, schema with _TOP prefix. _TOP prefix is used for PUT (JSON), PATCH (JSON) and GET operations.</p> <p>Assuming that all operations are under <b>path</b>.</p> <p>We can change our logic in the following way:</p> <ol> <li>For each container create its path.</li> <li>For each container create its schema - only one.</li> <li>Link container's path with schema for PUT (JSON), PATCH (JSON) and GET operations.</li> <li>Link container's <b>parent</b> path with schema for POST, PUT (XML) and PATCH (XML) operations.</li> <li>Continue.</li> </ol> NETCONF-1057

OpenApi: Eliminate TOP schemas

Task Medium Resolved Done Ivan Hrasko Ivan Hrasko pt Wed, 14 Jun 2023 14:43:38 +0000 Thu, 17 Aug 2023 14:38:27 +0000 Thu, 17 Aug 2023 14:38:27 +0000 7.0.0 restconf-openapi 0 1 <p>In <a href="https://jira.opendaylight.org/browse/NETCONF-1059" title="OpenApi: Wrong XML GET example" class="issue-link" data-issue-key="NETCONF-1059"><del>NETCONF-1059</del></a> we can see that using _TOP schema for GET in XML is not correct.</p> <p>We cannot implement logic as proposed above because of the following reasons:</p> <ol> <li>ODL requires JSON payload be be enclosed by {} and element name as required by <a href="https://datatracker.ietf.org/doc/html/rfc8040#section-4.5." class="external-link" target="_blank" rel="nofollow noopener">https://datatracker.ietf.org/doc/html/rfc8040#section-4.5.</a> That is the reason why we have created TOP schemas.</li> <li>In fact, the schema created for container will never be show as required in #1 without creating additional schema which is level up.</li> <li>We cannot use parent's schema for this purpose because it contains data for other children as well.</li> </ol> <p>But we can remove TOP schemas for lists and container and apply their logic directly in responses. This way we will get more cleaner and user friendly schemas listing at the bottom of generated OpenApi documentation.</p> <p> </p> <p>Please see proposed OpenApi docs after modifications: <span class="nobr"><a href="https://jira.opendaylight.org/secure/attachment/19006/19006_expected-TOP-removal-for-containers.json" title="expected-TOP-removal-for-containers.json attached to NETCONF-1057">expected-TOP-removal-for-containers.json^{<img class="rendericon" src="https://jira.opendaylight.org/images/icons/link_attachment_7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/>}</a></span> and <span class="nobr"><a href="https://jira.opendaylight.org/secure/attachment/19007/19007_expected-TOP-removal-for-lists.json" title="expected-TOP-removal-for-lists.json attached to NETCONF-1057">expected-TOP-removal-for-lists.json^{<img class="rendericon" src="https://jira.opendaylight.org/images/icons/link_attachment_7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/>}</a></span>. You can see the diffs against <span class="nobr"><a href="https://jira.opendaylight.org/secure/attachment/19008/19008_original.json" title="original.json attached to NETCONF-1057">original.json^{<img class="rendericon" src="https://jira.opendaylight.org/images/icons/link_attachment_7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/>}</a></span>to get idea what is going on.</p> Blocks NETCONF-1077 NETCONF-1054 NETCONF-1059 Relates NETCONF-938 Development Rank 0|i045h3: