Define OpenAPI 3.0 REST specification to be used in the SDN Controller
In order to build the goSDN Ui project, we need to establish a common Http REST API interface in order to interact with the controller from the web.
Who will benefit?
Internal documentation, third party applications (such as the goSDN UI)
Benefits and risks
What benefits does this bring? - automate documentation of API calls - possibly automate validation of API routes - possibly auto generate API routes What risks might this introduce? - adds effort to the project - automatic route validation may not be possible as there are currently very few supported OpenAPI 3.0 validators for go - adds technical debt for a third party validator - adds http server in controller, amongst other security risks
Add the spec, otherwise a web based UI is very hard to implement
Yes, examples can be provided upon request