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

OpenApi: Eliminate TOP schemas

    XMLWordPrintable

Details

    • Task
    • Status: Resolved
    • Medium
    • Resolution: Done
    • None
    • 7.0.0
    • restconf-openapi

    Description

      Currently, we generate for each container element (container, list) schema and, additionally, schema with _TOP prefix. _TOP prefix is used for PUT (JSON), PATCH (JSON) and GET operations.

      Assuming that all operations are under path.

      We can change our logic in the following way:

      1. For each container create its path.
      2. For each container create its schema - only one.
      3. Link container's path with schema for PUT (JSON), PATCH (JSON) and GET operations.
      4. Link container's parent path with schema for POST, PUT (XML) and PATCH (XML) operations.
      5. Continue.

      Attachments

        1. expected-TOP-removal-for-containers.json
          27 kB
          Ivan Hrasko
        2. expected-TOP-removal-for-lists.json
          27 kB
          Ivan Hrasko
        3. original.json
          27 kB
          Ivan Hrasko

        Issue Links

          blocks

          Task - A task that needs to be done. NETCONF-1077 OpenApi: Missing "data" path for POST requests

          • Medium - Has the potential to affect progress.
          • Open
          is blocked by

          Bug - A problem which impairs or prevents the functions of the product. NETCONF-1054 OpenApi: POST examples are incorrect

          • Highest - This problem will block progress.
          • Resolved

          Bug - A problem which impairs or prevents the functions of the product. NETCONF-1059 OpenApi: Wrong XML GET example

          • Medium - Has the potential to affect progress.
          • Resolved
          relates to

          Bug - A problem which impairs or prevents the functions of the product. NETCONF-938 Cannot generate API docs for Junos device

          • Highest - This problem will block progress.
          • In Review
          # Subject Branch Project Status CR V
          107223,16 Do not use TOP schemas in PUT requests master netconf Status: MERGED +2 +1
          107238,15 Do not use TOP schemas in PATCH requests master netconf Status: MERGED +2 +1
          107263,12 Do not use TOP schemas in GET requests master netconf Status: MERGED +2 +1
          107359,14 Do not use TOP schemas in RPC requests master netconf Status: MERGED +2 +1
          107364,13 Eliminate TOP schemas master netconf Status: MERGED +2 +1

          Activity

            People

              ivanhrasko Ivan Hrasko
              ivanhrasko Ivan Hrasko
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: