ADM-791:[backend]docs: update docs about generate report api design

au-heartbeat · Feb 4, 2024 · bce94e3 · bce94e3
1 parent f8995d2
commit bce94e3
Showing 1 changed file with 5 additions and 4 deletions.
diff --git a/docs/src/content/docs/en/designs/refinement-on-generate-report.mdx b/docs/src/content/docs/en/designs/refinement-on-generate-report.mdx
@@ -212,6 +212,7 @@ group async process board related metrics
     Backend -> Backend: generate board report csv
     deactivate Backend
     note left
+        response.boardMetricsCompleted is true
         board metrics are ready for display
         board csv is ready for download
     end note
@@ -244,6 +245,7 @@ group async process pipeline and sourcecontrol related metrics
     end
     Backend -> Backend: generate pipeline report csv with github data if required
     note left
+        response.doraMetricsCompleted is true
         pipeline report is ready for download
     end note
     deactivate Backend
@@ -493,10 +495,9 @@ Response:
         "errorMessage": "string"
       },
     } <could be null if not required>,
-    "boardMetricsCompleted": Boolean <default is null>, 
-    "pipelineMetricsCompleted": Boolean <default is null>, 
-    "sourceControlMetricsCompleted": Boolean <default is null>,
-    "allMetricsCompleted": Boolean <default is null>,
+    "boardMetricsCompleted": boolean <default is false>, 
+    "doraMetricsCompleted": boolean <default is false>, 
+    "allMetricsCompleted": boolean <default is false>,
     "exportValidityTime": 0
 }
 ```