[NETCONF-999] OpenAPI: Use "example" instead of "default" Created: 25/Apr/23 Updated: 24/Oct/23 Resolved: 24/Oct/23 |
|
| Status: | Resolved |
| Project: | netconf |
| Component/s: | restconf-openapi |
| Affects Version/s: | None |
| Fix Version/s: | 7.0.0, 6.0.5 |
| Type: | Improvement | Priority: | Medium |
| Reporter: | Ivan Hrasko | Assignee: | Tobias Pobocik |
| Resolution: | Done | Votes: | 0 |
| Labels: | pt | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||||||
| Description |
|
In many cases (even when there is not YANG defined default value) we misuse default swagger property to set an example value. Instead use example property as specified in https://swagger.io/docs/specification/adding-examples/ to show example values in swagger UI and set default property only when defined type has “default“ value. |