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

API Explorer Model Schema Data Type 'Click to set as parameter value' valid example values

    XMLWordPrintable

Details

    • Improvement
    • Status: Resolved
    • Resolution: Done
    • None
    • None
    • restconf-nb
    • None
    • Operating System: All
      Platform: All

    Description

      As discussed in NETCONF-215 if it's technically possibly (with Swagger) it would be "nice" if the Model Schema under Data Type 'Click to set as parameter value' would put in VALID example values; e.g. "toasterDoneness": "1" instead of "integer", etc.

      This would have to take into account various things such as data types, required/mandatory etc. I would imagine that the logic for chosing and example value could be kept trivial - something like if it's numeric, then 0 or 1 or the first possible value (if if's a range), if it's an enum then just the first value, if it's a non-empty list then (recursively) a value for 1 list element, etc.

      This is an Enhancement, not a bug. I don't know how feasible this is. NETCONF-215 and NETCONF-214 are clearly higher prioritities, and this one is a nice to have (which would be cool) as a future follow-up after those are settled.

      Attachments

        Issue Links

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

          Activity

            People

              miroslav.kovac@pantheon.tech Miroslav Kovac
              vorburger Michael Vorburger
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: