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-255 controller <p>For example how does one figure out how to add a group to configuration? </p> <p>Without the documentation it's not clear how one should use RestConf. We should not require app developers to have to read a yang to understand what comprises a resource. This should be in some clean documentation that end users can consume.</p> <p>Operating System: All<br/> Platform: All</p> CONTROLLER-255

Restconf documentation incomplete and unusable

Improvement Resolved Done Abhishek Kumar Moiz Raja Tue, 1 Apr 2014 00:34:58 +0000 Tue, 25 Jul 2023 08:23:20 +0000 Mon, 12 May 2014 16:34:30 +0000 restconf 0 3 <p>Moiz you are asking for documentation for specific model e.g. group model,<br/> this should not be responsibility of RESTConf per se, but for the maintainer<br/> of the model owner probably (group model is not part of restconf).</p> <p>We need to figure out how to do that properly,<br/> also please look into <a href="https://jenkins.opendaylight.org/controller/job/controller-merge/lastSuccessfulBuild/artifact/opendaylight/md-sal/model/model-flow-service/target/site/models/flow-node-inventory.html#group/buckets" class="external-link" target="_blank" rel="nofollow noopener">https://jenkins.opendaylight.org/controller/job/controller-merge/lastSuccessfulBuild/artifact/opendaylight/md-sal/model/model-flow-service/target/site/models/flow-node-inventory.html#group/buckets</a></p> <p>Which is autogenerated documentation. It needs improvements, so any feedback is welcomed.</p> <p>Changed to enhancement</p> <p>Tony,</p> <p>I was thinking of generating swagger like documentation from runtime models - this is so that augmentations are also shown correctly as part of a resource. I am hoping that at runtime we can do this based on the schema information that we do have.</p> <p>The documentation should be free of yangism's to appeal more to programmers who care only about the REST interface. There is a lot of stuff in the current generated documentation that I cannot see as useful from a REST perspective. </p> <p>I think this is more about aesthetics and ease of use.</p> <p>Wiki:<br/> <a href="https://wiki.opendaylight.org/view/OpenDaylight_Controller:MD-SAL:Restconf_API_Explorer" class="external-link" target="_blank" rel="nofollow noopener">https://wiki.opendaylight.org/view/OpenDaylight_Controller:MD-SAL:Restconf_API_Explorer</a></p> <p>Gerrit:<br/> <a href="https://git.opendaylight.org/gerrit/6574" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/6574</a></p> Development External issue ID 627 External issue URL Priority Rank 0|i02j9r: