From b9004c6a5bf447b136de37fa850ade2acf1f4e40 Mon Sep 17 00:00:00 2001 From: Pasha Zayko Date: Fri, 21 Feb 2025 09:33:06 -0500 Subject: [PATCH] Adjusting the return value String is notoriously tricky to handle on the receiving end as the content gets confused with possible JSON object. Updating the API return to be an object to avoid confusion. --- SHIELD.json | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/SHIELD.json b/SHIELD.json index 36be23b..1ddc605 100644 --- a/SHIELD.json +++ b/SHIELD.json @@ -1026,8 +1026,14 @@ "content": { "application/json": { "schema": { - "type": "string", - "example": "1.2.3" + "properties": { + "appVersion": { + "description": "Follows symantec versioning as laid out here: https://semver.org/. This number is the version of the application package.", + "example": "1.2.3", + "type": "string" + } + }, + "type": "object" } } }, @@ -1054,8 +1060,14 @@ "content": { "application/json": { "schema": { - "type": "string", - "example": "1.2.3" + "properties": { + "appVersion": { + "description": "Follows symantec versioning as laid out here: https://semver.org/. This number is the version of the application package.", + "example": "1.2.3", + "type": "string" + } + }, + "type": "object" } } },