Uploaded image for project: 'ERM Platform'
  1. ERM Platform
  2. ERM-254 Document ERM JSON Schema
  3. ERM-256

Write explainer documentation to support schema

    XMLWordPrintable

    Details

    • Type: Sub-task
    • Status: Closed (View Workflow)
    • Priority: P3
    • Resolution: Won't Do
    • Component/s: None
    • Labels:
    • Template:
    • Development Team:
      Bienenvolk

      Description

      From Slack via Mark Deutsch

      when i was getting started with the frontend it was pretty tough to figure out how the backend model actually functioned. mostly i went off of the actual implementation in the groovy/gson files but that doesn’t solve the issue of unused params.

      it also doesn’t really tell you what the fields are used for. eg, trying to reason through all the various ways that items/packages/entitlements and all their constituent classes relate to one another was hard af to figure out…and i’m still not sure i really get it.

      And

      yeah i think the schema by itself, while helpful, doesn’t really explain how things are related to each other and how they’re used.

      i think it would be helpful to people entering the code to have some sort of additional text/docs explaining the why to go with the what of the schema

        TestRail: Results

          Attachments

            Activity

              People

              Assignee:
              ostephens Owen Stephens
              Reporter:
              jag.goraya Jag Goraya
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  TestRail: Runs

                    TestRail: Cases