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/CONTROLLER-428 controller <p>There are a lot of yang modules (current count is 84) in controller. Rendering APIs for all those is extremely slow in API Explorer. Pagination and search support would limit the number of modules that needs to be rendered in UI. As a result, it would speed up the load time.</p> <p>Operating System: Mac OS<br/> Platform: PC</p> CONTROLLER-428

RESTConf API Explorer: Add pagination and searching

Improvement Resolved Cannot Reproduce Unassigned Abhishek Kumar Tue, 29 Apr 2014 20:42:43 +0000 Tue, 14 Nov 2017 15:17:58 +0000 Thu, 2 Oct 2014 20:29:46 +0000 Helium restconf 0 6 <p>Is it possible to use pagination? Can you give me some hint?</p> <p>Here is how I would approach this.</p> <p>1) Split searching into another bug <img class="emoticon" src="https://jira.opendaylight.org/images/icons/emoticons/smile.png" height="16" width="16" align="absmiddle" alt="" border="0"/><br/> 2) For pagination... see below.</p> <p>To add pagination the first thing you would need to do is modify the rest APIs to take a page number as a query parameter, and possible a page size.</p> <ul> <li>I would make these arguments optional</li> <li>If pageSize is provided, but not pageNumber, default pageNumber = 1</li> <li>If pageNumber is provided, but not pageSize, default pageSize=20 (or some other number)</li> <li>If neither page # or page size is provided, then default pageNumber=1 and pageSize = to max size (i.e. all)</li> <li>Paging relies on having a sorted list so you can correctly index into the list each time. Since we already sort the modules by name / revision etc this shouldn't be difficult. So likely you can continue to get back the entire list of modules and then page as a second step if needed.</li> <li>You also need to modify the return information to somehow include either:<br/> 1) That there is a "next page" or<br/> 2) How many more elements there are, so the UI can figure out what the next page is.</li> </ul> <p>Once you have modified the APIs to support paging you need to modify the web page to provide the concept of paging. This will require modifying the HTML page to make the initial call with the correct page information and then showing what page you are on, providing next calls etc. You will see that we have already abstracted away the idea of loading the swagger UI to a method call, so that should hopefully be easy. So when someone loads the next page, you make the new rest call with the new page information.</p> <p>I should add though - the "slowness" that is referred to in this bug is really caused by the hundreds of possible rest calls under each module. Not the number of modules. We actually reduce the number of modules down to 18 by removing any module that didn't have a rest conf URL exposed.</p> <p>So paging modules actually isn't going to get us much...</p> <p>So what I said before is probably the wrong thing. We really want to page the URLs underneath a module...and that I am not sure how to do - it seems like it is something that would need to be added to the swagger functionality.</p> <p>Perhaps we should just settle with showing a loading indicator while the swagger UI is doing its thing...??</p> <p>It was reported that pagination and searching should be available to<br/> decrease amount of data which have to be transferred when REST API for all<br/> YANG modules is generated.</p> <p>Currently after GET on<br/> <a href="http://server:port/apidoc/apis/modules" class="external-link" target="_blank" rel="nofollow noopener">http://server:port/apidoc/apis/modules</a><br/> the list of yang modules will be returned. Every listed module contains at<br/> least one rpc or list|container as top level. It is also possible to<br/> search via searching area in top right corner. It is also possible to<br/> display pagination (currently it is switched off).<br/> This returning html isn't existing file and is generating. Probably it would be possible to create html file which would do this REST call bug it would require more investigation</p> <p>Every module name in table is hyperlink<br/> <a href="http://server:port/apidoc/explorer?moduleName=name&amp;revision=YYYY-DD-MM" class="external-link" target="_blank" rel="nofollow noopener">http://server:port/apidoc/explorer?moduleName=name&amp;revision=YYYY-DD-MM</a><br/> It will navigate swagger UI where only API links for this module are loaded.</p> <p>Original access to REST apis kept preserved. It means that is is still<br/> possible to list all REST apis via<br/> <a href="http://server:port/appidoc/explorer" class="external-link" target="_blank" rel="nofollow noopener">http://server:port/appidoc/explorer</a></p> <p>Patch set <br/> <a href="https://git.opendaylight.org/gerrit/#/c/11691/" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/#/c/11691/</a></p> <p>This enhancement is not needed anymore. The list of yang modules loaded in api explorer has been filtered down to about 20 and the UI rendering is not slow anymore.</p> Development External issue ID 906 External issue URL ODL SR Target Milestone Priority Rank 0|i02kc7: