add quick doc for group results

GreenDelta · Dec 11, 2024 · a3cb866 · a3cb866
1 parent c907f87
commit a3cb866
Show file tree

Hide file tree

Showing 6 changed files with 58 additions and 1 deletion.
diff --git a/spec/mdtables.dart b/spec/mdtables.dart
@@ -49,6 +49,6 @@ String typeLinkOf(SchemaType? type) {
 }
 
 main() {
-  var spec = Spec.readFrom(File("ipc/spec/results.json"));
+  var spec = Spec.readFrom(File("spec/results.json"));
   writeTables(spec);
 }
diff --git a/spec/results.json b/spec/results.json
@@ -127,6 +127,13 @@
           "List[TechFlow]"
         ],
         "result": "List[UpstreamNode]"
+      },
+      {
+        "method": "grouped-flow-results-of",
+        "params": [
+          "EnviFlow"
+        ],
+        "result": "List[GroupValue]"
       }
     ]
   },
@@ -241,6 +248,13 @@
           "List[TechFlow]"
         ],
         "result": "List[UpstreamNode]"
+      },
+      {
+        "method": "grouped-impact-results-of",
+        "params": [
+          "Ref[ImpactCategory]"
+        ],
+        "result": "List[GroupValue]"
       }
     ]
   },
@@ -275,6 +289,11 @@
           "TechFlow"
         ],
         "result": "CostValue"
+      },
+      {
+        "method": "grouped-cost-results",
+        "params": [],
+        "result": "List[GroupValue]"
       }
     ]
   }

diff --git a/src/SUMMARY.md b/src/SUMMARY.md
@@ -39,6 +39,7 @@
     - [Unscaled flows](results/envi-flows/unscaled.md)
     - [Upstream results](results/envi-flows/upstream.md)
     - [Upstream trees](results/envi-flows/upstream_trees.md)
+    - [Grouped results](results/envi-flows/grouped_results.md)
   - [Impact categories](results/elements/impact-categories.md)
     - [Impact assessment result](results/impacts/impact-result.md)
     - [Normalized results](results/impacts/normalized.md)
@@ -49,6 +50,7 @@
     - [Intensities](results/impacts/intensities.md)
     - [Upstream results](results/impacts/upstream.md)
     - [Upstream trees](results/impacts/upstream_trees.md)
+    - [Grouped results](results/impacts/grouped_results.md)
   - [Costs](results/elements/costs.md)
     - [Life cycle costing result](results/costs/cost-result.md)
     - [Direct contributions](results/costs/direct-contributions.md)
@@ -57,4 +59,5 @@
     - [Unscaled costs](results/costs/unscaled.md)
     - [Upstream results](results/costs/upstream.md)
     - [Upstream trees](results/costs/upstream_trees.md)
+    - [Grouped results](results/costs/grouped_results.md)
   - [Sankey graphs](results/sankey.md)
diff --git a/src/results/costs/grouped_results.md b/src/results/costs/grouped_results.md
@@ -0,0 +1,11 @@
+# Grouped results
+
+Returns the analysis group results for the calculated LCC results.
+
+|             |                             |
+| ----------- | --------------------------- |
+| Rest API    | `GET result/{result-id}/grouped-cost-results` |
+| JSON-RPC    | `result/grouped-cost-results` |
+| Snake case  | `result.get_grouped_cost_results` |
+| Camel case  | `result.getGroupedCostResults` |
+| Return type | [`List[GroupValue]`](http://greendelta.github.io/olca-schema/classes/GroupValue.html) |
diff --git a/src/results/envi-flows/grouped_results.md b/src/results/envi-flows/grouped_results.md
@@ -0,0 +1,12 @@
+# Grouped results
+
+Returns the analysis group results for a given flow.
+
+|             |                             |
+| ----------- | --------------------------- |
+| Rest API    | `GET result/{result-id}/grouped-flow-results-of/{envi-flow}` |
+| JSON-RPC    | `result/grouped-flow-results-of` |
+| Snake case  | `result.get_grouped_flow_results_of` |
+| Camel case  | `result.getGroupedFlowResultsOf` |
+| Return type | [`List[GroupValue]`](http://greendelta.github.io/olca-schema/classes/GroupValue.html) |
+| Parameter 1 | [`EnviFlow`](http://greendelta.github.io/olca-schema/classes/EnviFlow.html) |
diff --git a/src/results/impacts/grouped_results.md b/src/results/impacts/grouped_results.md
@@ -0,0 +1,12 @@
+# Grouped results
+
+Returns the analysis group results for a given impact category.
+
+|             |                             |
+| ----------- | --------------------------- |
+| Rest API    | `GET result/{result-id}/grouped-impact-results-of/{impact-category}` |
+| JSON-RPC    | `result/grouped-impact-results-of` |
+| Snake case  | `result.get_grouped_impact_results_of` |
+| Camel case  | `result.getGroupedImpactResultsOf` |
+| Return type | [`List[GroupValue]`](http://greendelta.github.io/olca-schema/classes/GroupValue.html) |
+| Parameter 1 | [`Ref[ImpactCategory]`](http://greendelta.github.io/olca-schema/classes/Ref.html) |