utat-ss / tree-visualizer

An interactive requirements engineering tool
1 stars 0 forks source link

Implement new spec for frontend <~> backend API #6

Closed jdtech3 closed 1 year ago

jdtech3 commented 1 year ago

Rationale: currently, the API only returns requirement ID and title in nodes/edges format, but (1) more metadata is needed (such as qualifer) and (2) nodes/edges format is not very visualization library agnostic.

Therefore, the new spec should be as follows, with the data represented as an Object with Notion IDs as fields and metadata as contents:

{
  "ff5892a7-b5c9-4a25-97bd-663b2cff5bd7": {
    "created-by": "khang nguyen",
    "parent-id": "b7985ca8-94f4-4a30-ae61-8af2126019bd",
    "last-edited": "2023-02-20T17:51:00.000Z",
    "qualifier": "SHALL",
    "collection": "Tree visualizer",
    "type": "Functional",
    "verification-plan": "", // unsure how to represent this
    "verification-method": "", // unsure how to represent this
    "system": "Tree Visualizer",
    "rationale": "To allow UTAT Space Systems members to graphically view the relationships between entries",
    "trades": "", // unsure how to represent this
    "last-edited-by": "David",
    "stakeholder": "Systems",
    "mission": "FINCH",
    "description": "ADCS shall consistently know FINCH’s location relative to the SUN and Earth Position",
    "title": "FINCH-ADCS-AttitudeDetermination",
    "url": "https://www.notion.so/FINCH-Power-Batteries-74331bc1129c417c850a0a5ca0deb759"
  },

[...]

}