[CONTROLLER-255] Restconf documentation incomplete and unusable Created: 01/Apr/14 Updated: 25/Jul/23 Resolved: 12/May/14 |
|
| Status: | Resolved |
| Project: | controller |
| Component/s: | restconf |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Improvement | ||
| Reporter: | Moiz Raja | Assignee: | Abhishek Kumar |
| Resolution: | Done | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Environment: |
Operating System: All |
||
| Description |
|
For example how does one figure out how to add a group to configuration? 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. |
| Comments |
| Comment by Tony Tkacik [ 03/Apr/14 ] |
|
Moiz you are asking for documentation for specific model e.g. group model, We need to figure out how to do that properly, Which is autogenerated documentation. It needs improvements, so any feedback is welcomed. Changed to enhancement |
| Comment by Moiz Raja [ 03/Apr/14 ] |
|
Tony, 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. 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. I think this is more about aesthetics and ease of use. |
| Comment by Abhishek Kumar [ 29/Apr/14 ] |
|
Wiki: |