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

Cannot generate API docs for Junos device

    XMLWordPrintable

Details

    • Bug
    • Status: In Review
    • Highest
    • Resolution: Unresolved
    • None
    • 7.0.0
    • restconf-openapi

    Description

      When we have device that contains Junos [common models|https://github.com/Juniper/yang/tree/master/22.3/22.3R1/common] and [junos family models|https://github.com/Juniper/yang/tree/master/22.3/22.3R1/junos] its not possible to access [its mount point documentation|http://localhost:8181/apidoc/explorer/index.html?urls.primaryName=17830-sim-device%20resources%20-%20RestConf%20RFC%208040].

      The docs are never loaded and we can see that Java VM is out of heap space. After some time the running ODL instance is killed.

      Attachments

        1. image-2023-03-15-09-23-20-869.png
          273 kB
          Peter Suna
        2. image-2023-03-15-09-47-49-518.png
          272 kB
          Peter Suna
        3. Image Pasted at 2023-1-9 10-08.png
          369 kB
          Robert Varga
        4. Image Pasted at 2023-1-9 10-09.png
          253 kB
          Robert Varga
        5. Image Pasted at 2023-1-9 10-10.png
          541 kB
          Robert Varga
        6. Image Pasted at 2023-1-9 10-11.png
          442 kB
          Robert Varga
        7. Screenshot_2023-01-04_11-03-36.png
          141 kB
          Ivan Hrasko

        Issue Links

          is blocked by

          Bug - A problem which impairs or prevents the functions of the product. NETCONF-1241 OpenAPI: Iterate over models in PathsStream

          • Highest - This problem will block progress.
          • Resolved

          Bug - A problem which impairs or prevents the functions of the product. NETCONF-1242 OpenAPI: Iterate over models in SchemasStream

          • Highest - This problem will block progress.
          • Resolved
          is duplicated by

          Improvement - An improvement or enhancement to an existing feature or task. NETCONF-480 GET on /apidoc/apis takes long time to respond

          • High - Serious problem that could block progress.
          • Resolved
          relates to

          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

          Task - A task that needs to be done. NETCONF-1056 OpenApi: Do not use ArrayNode to store parameters

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

          Task - A task that needs to be done. NETCONF-1057 OpenApi: Eliminate TOP schemas

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

          Task - A task that needs to be done. NETCONF-1234 Slow API docs generation for Junos device

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

          Sub-task - The sub-task of the issue NETCONF-982 Reduce the number of schema objects

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

          Improvement - An improvement or enhancement to an existing feature or task. NETCONF-997 OpenAPI: Use Java Path object instead of JsonNode

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

          Improvement - An improvement or enhancement to an existing feature or task. NETCONF-1023 OpenAPI: Limit usage of JsonUtil#copy method

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

          Improvement - An improvement or enhancement to an existing feature or task. NETCONF-1024 OpenAPI: Use Java Schema object instead of JsonNode

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

          Improvement - An improvement or enhancement to an existing feature or task. NETCONF-1025 OpenAPI: Eliminate JsonUtil#addFields method

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

          Improvement - An improvement or enhancement to an existing feature or task. NETCONF-1036 OpenApi: Reduce XML elements inside OpenApi JSON

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

          Task - A task that needs to be done. NETCONF-1041 OpenApi: Transform model to Java records

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

          Bug - A problem which impairs or prevents the functions of the product. NETCONF-1050 OpenApi: Introduce Operation object

          • Medium - Has the potential to affect progress.
          • Resolved
          # Subject Branch Project Status CR V
          103968,31 WIP: Add ApiDocServiceImpl getMountDoc benchmark test master netconf Status: NEW 0 -1
          110143,4 Remove unnecessary empty double lines. master netconf Status: NEW -1 +1
          110156,4 Upgrade FIXME inside OpenAPi master netconf Status: NEW -1 +1
          110158,4 Remove not needed todos master netconf Status: NEW -1 +1
          110175,1 Delete all always null returning methods master netconf Status: NEW -1 +1
          104475,4 Remove ResourceList class master netconf Status: MERGED +2 +1
          104478,5 Remove Resource class master netconf Status: MERGED +2 +1
          104615,5 Reuse ObjectMapper instance master netconf Status: MERGED +2 +1
          104660,1 Reuse ObjectMapper instance 4.0.x netconf Status: MERGED +2 +1
          104816,14 WIP: Create new DefinitionObject master netconf Status: ABANDONED 0 +1
          104854,13 WIP: Use JsonGenerator in DefinitionGenerator master netconf Status: ABANDONED 0 +1
          104878,17 WIP: Use Map to store schema in OpenApi master netconf Status: ABANDONED 0 +1
          105042,20 Remove _XML and _POST containers from OpenApi master netconf Status: MERGED +2 +1
          105043,39 Create only config data for OpenApi master netconf Status: MERGED +2 +1
          105089,24 Prepare tests for OpenApi generated Objects master netconf Status: MERGED +2 +1
          105091,14 WIP: Remove OpenApi objects with TOP extension master netconf Status: ABANDONED 0 0
          106895,11 Remove "config" prefix from OpenApi master netconf Status: MERGED +2 +1
          106920,6 OpenApi simplify processChildNode method master netconf Status: MERGED +2 +1
          107149,20 WIP: Add OpenApi{Entity,BodyWriter} master netconf Status: MERGED +2 +1
          107385,4 Add test for reduced number of schemas master netconf Status: MERGED +2 +1
          107484,8 WIP: Draft input and output streams master netconf Status: ABANDONED 0 -1
          107485,10 WIP: Draft Entity instantiation master netconf Status: ABANDONED 0 -1
          107495,14 Eliminate server from Path class master netconf Status: MERGED +2 +1
          107552,12 Eliminate ObjectNode(s) from Schema class master netconf Status: MERGED +2 +1
          107567,2 Remove _XML and _POST containers from OpenApi 5.0.x netconf Status: MERGED +2 +1
          107568,1 Remove _XML and _POST containers from OpenApi 4.0.x netconf Status: MERGED +2 +1
          107707,11 Eliminate ObjectNode(s) from Operation class master netconf Status: MERGED +2 +1
          107905,9 WIP: Use OpenApiInputStream to generate docs master netconf Status: ABANDONED 0 -1
          107928,10 WIP: Draft iteration over model context master netconf Status: ABANDONED 0 -1
          108002,4 Clean up boolean values in records master netconf Status: MERGED +2 +1
          108258,16 WIP: Draft reading YANG context into OpenApiInputStream master netconf Status: MERGED +2 +1
          108304,32 Adapt tests for OpenApi master netconf Status: MERGED +2 +1
          108305,35 Adapt API to OpenApiObject removal master netconf Status: MERGED +2 +1
          108686,7 OpenApi: Improve test coverage master netconf Status: MERGED +2 +1
          108707,5 OpenApi: Rework tests to parameterized master netconf Status: MERGED +2 +1
          108809,34 Re-implement logic for security and securitySchemes master netconf Status: MERGED +2 +1
          108865,23 Re-implement paths for RPCs master netconf Status: MERGED +2 +1
          108912,23 Re-implement components/schemas for RPCs master netconf Status: MERGED +2 +1
          109029,11 Re-implement components/schemas for actions master netconf Status: MERGED +2 +1
          109031,3 OpenApi: Do not introduce JUnit 4 master netconf Status: MERGED +2 +1
          109032,1 OpenApi: Organize *Document tests master netconf Status: ABANDONED 0 -1
          109036,24 Re-implement paths for ChildNodes master netconf Status: MERGED +2 +1
          109045,23 Re-implement components/schemas for nodes master netconf Status: MERGED +2 +1
          109074,21 Remove OpenApiObject master netconf Status: MERGED +2 +1
          109124,17 Re-implement components/schemas for RPC's childs master netconf Status: MERGED +2 +1
          109167,8 Revert models description change master netconf Status: MERGED +2 +1
          109315,5 Refactor SchemasStreams class master netconf Status: MERGED +2 +1
          109321,2 Junos device: Fix IllegalStateException master netconf Status: MERGED +2 +1
          109643,6 Use configurable basePath in PathsStream master netconf Status: MERGED +2 +1
          109690,3 Use BufferedReader to read OpenApi master netconf Status: MERGED +2 +1
          109796,3 Use PathsEntity class to simplify PathsStream master netconf Status: MERGED +2 +1
          109807,5 Use DefinitionNames#addUnlinkedName after rewrite master netconf Status: MERGED +2 +1
          109817,6 Use OpenApiServiceImpl#DEFAULT_PAGESIZE after rewrite master netconf Status: MERGED +2 +1
          109825,7 Fix wrong path reference - schema for actions master netconf Status: MERGED +2 +1
          109837,3 Remove unused lock field master netconf Status: MERGED +2 +1
          109908,7 Create SchemasEntity class to simplify SchemasStream master netconf Status: MERGED +2 +1
          109989,2 Fix nullability checks in InfoEntity class master netconf Status: MERGED +2 +1
          109990,2 Fix nullability checks in ServerEntity class master netconf Status: MERGED +2 +1
          109991,2 Fix nullability checks in ParameterEntity class master netconf Status: MERGED +2 +1
          110009,2 Fix nullability checks in ServersEntity class master netconf Status: MERGED +2 +1
          110010,2 Fix nullability checks in SecuritySchemesEntity class master netconf Status: MERGED +2 +1
          110011,2 Fix nullability checks in SecurityEntity class master netconf Status: MERGED +2 +1
          110012,2 Fix nullability checks in PathsEntity class master netconf Status: MERGED +2 +1
          110013,2 Fix nullability checks in ParameterSchemaEntity class master netconf Status: MERGED +2 +1
          110014,2 Fix nullability checks in PropertyEntity class master netconf Status: MERGED +2 +1
          110015,3 Fix nullability checks in operations entity classes master netconf Status: MERGED +2 +1
          110017,2 Fix wrong path reference - schema for actions master netconf Status: MERGED +2 +1

          Activity

            People

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

              Dates

                Created:
                Updated: