Merge pull request PGScatalog#378 from ens-lgil/feature/rest_api_example

Add examples for the different types of performance metrics
HDRUK · Jul 10, 2024 · c555279 · c555279
2 parents 472040b + 55ec038
commit c555279
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/rest_api/static/rest_api/openapi/openapi-schema.yml b/rest_api/static/rest_api/openapi/openapi-schema.yml
@@ -498,11 +498,31 @@ components:
             class_acc:
               type: array
               description: "List of Classification Metric data"
+              example: [
+                {
+                  "name_long": 'Area Under the Receiver-Operating Characteristic Curve',
+                  "name_short": 'AUROC',
+                  "estimate": 0.63,
+                  "ci_lower": null,
+                  "ci_upper": null,
+                  "se": null
+                }
+              ]
               items:
                 $ref: '#/components/schemas/Metric'
             othermetrics:
               type: array
               description: "Metrics that do not fit into the Effect Size or Classification Metric categories. e.g. R² (proportion of the variance explained), or reclassification metrics."
+              example: [
+                {
+                  "name_long": 'Proportion of the variance explained',
+                  "name_short": 'R2',
+                  "estimate": 0.0011,
+                  "ci_lower": null,
+                  "ci_upper": null,
+                  "se": null
+                }
+              ]
               items:
                 $ref: '#/components/schemas/Metric'
         covariates: