Uploaded image for project: 'OpenNMS'
  1. OpenNMS
  2. NMS-13455

Geo-map: work with Ben designing RESTful API for Geo-map page



    • Task
    • Status: Resolved (View Workflow)
    • Medium
    • Resolution: Fixed
    • None
    • 30.0.0
    • None
    • Security Level: Default (Default Security Scheme)
    • None
    • Horizon 2021 - Aug 18 - Sept 1
    • Backlog NG
    • Hide

      provide a doc for the design

      provide a doc for the design


      Work with Ben to design a RESTful API that will be more suitable for the Geo-map page. This design can be helpful for future work when we decide to rework or improve the existing RESTful API. 

      The redesign may solve the following problems:

      1. Reduce the number of REST calls for one page, this will improve the performance, and shortening the page's loading time. 
      2. Save bandwidth. Pagination is not suitable for the geo-map page because we need all nodes to show up on the map at one time. Hence slim the size of one record became essential. The current RESTful response for getting a node contains around 80 fields, while only 12 are used for the geo-map page. The RESTful call for alarms has more than 40 fields, include two text paragraphs of descriptions. The geo-map page only uses 7 fields. 
      3. UI data can be more consistent. Doing separate RESTful calls for Alarms and Nodes may cause inconsistent data for the alarm, node page, and map subpage. Because the alarm and node records for one node may arrive at a different time. 



        Issue Links



              jane.hou Jane Hou
              jane.hou Jane Hou
              0 Vote for this issue
              1 Start watching this issue