Uploaded image for project: 'netconf'
  1. netconf
  2. NETCONF-999

OpenAPI: Use "example" instead of "default"

    XMLWordPrintable

Details

    • Improvement
    • Status: Resolved
    • Medium
    • Resolution: Done
    • None
    • 7.0.0, 6.0.5
    • restconf-openapi

    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.

      Attachments

        Issue Links

          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

              tobias.pobocik Tobias Pobocik
              ivanhrasko Ivan Hrasko
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: