From 2fe27f7da06ceed7fcac6c5a1aa496f31da3b115 Mon Sep 17 00:00:00 2001
From: Michael Baudis <mbaudis@me.com>
Date: Mon, 24 Jul 2023 17:59:13 +0200
Subject: [PATCH] proposing "warnings" for response meta

Warnings seem like a much needed item to understand responses where the server wants to indicate information about potential problems with the response which are not outright failures. Especially useful for debugging aggregators.
---
 framework/json/responses/sections/beaconResponseMeta.json | 5 +++++
 framework/src/responses/sections/beaconResponseMeta.yaml  | 7 +++++++
 2 files changed, 12 insertions(+)

diff --git a/framework/json/responses/sections/beaconResponseMeta.json b/framework/json/responses/sections/beaconResponseMeta.json
index b2206fe2e..94be2b883 100644
--- a/framework/json/responses/sections/beaconResponseMeta.json
+++ b/framework/json/responses/sections/beaconResponseMeta.json
@@ -21,6 +21,11 @@
         },
         "testMode": {
             "$ref": "../../common/beaconCommonComponents.json#/definitions/TestMode"
+        },
+        "warnings": {
+            "description": "A list of \"warnings\", _i.e._ messages from the beacon about potential problems such as request parameters that could not be parsed or the reasons for a mismatch between request and response granularity.",
+            "items": "string",
+            "type": "array"
         }
     },
     "required": [
diff --git a/framework/src/responses/sections/beaconResponseMeta.yaml b/framework/src/responses/sections/beaconResponseMeta.yaml
index 84239c672..3816e059f 100644
--- a/framework/src/responses/sections/beaconResponseMeta.yaml
+++ b/framework/src/responses/sections/beaconResponseMeta.yaml
@@ -24,6 +24,13 @@ properties:
     $ref: ../../common/beaconCommonComponents.yaml#/definitions/TestMode
   receivedRequestSummary:
     $ref: ./beaconReceivedRequestSummary.yaml
+  warnings:
+    description: >-
+      A list of "warnings", _i.e._ messages from the beacon about potential
+      problems such as request parameters that could not be parsed or the reasons
+      for a mismatch between request and response granularity.
+    type: array
+    items: string
 required:
   - beaconId
   - apiVersion