Skip to content

Don't serialize json in API responses #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LswaN58 merged 4 commits into from
Nov 26, 2025
Merged

Don't serialize json in API responses #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a455233
Add a bit at start of remote testbed workflow to announce which endpo…
LswaN58 Nov 24, 2025
01e119d
Remove one level of 'json.dumps' in generating flask response.
LswaN58 Nov 26, 2025
1b9e0a3
Update HelloAPI tests to look for non-stringified dicts/nulls.
LswaN58 Nov 26, 2025
9bde69f
Make similar changes to remote testbed calls.
LswaN58 Nov 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/workflows/TEST_HelloAPI_remote.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ jobs:
cancel-in-progress: true

steps:

- name: Announce testing
run: echo "Testing HelloAPI endpoint at ${{ env.DEPLOY_URL }}"

# 1. Local checkout
- name: Checkout repository
uses: actions/checkout@v4
Expand Down
2 changes: 1 addition & 1 deletion src/ogd/apis/utils/APIResponse.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ def Status(self) -> ResponseStatus:
def AsDict(self):
return {
"type" : str(self._type),
"val" : json.dumps(self._val),
"val" : self._val,
"msg" : self._msg,
"status" : str(self._status)
}
Expand Down
6 changes: 3 additions & 3 deletions tests/cases/apis/HelloAPI/local/t_Hello.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ def test_get(self):
self.assertNotEqual(result, None)
self.assertEqual(result.status, "200 OK")
self.assertEqual(body.get("type"), "GET")
self.assertEqual(body.get("val"), "null")
self.assertEqual(body.get("val"), None)
self.assertEqual(body.get("msg"), "Hello! You GETted successfully!")
self.assertEqual(body.get("status"), "SUCCESS")

Expand All @@ -62,7 +62,7 @@ def test_post(self):
self.assertNotEqual(result, None)
self.assertEqual(result.status, "200 OK")
self.assertEqual(body.get("type"), "POST")
self.assertEqual(body.get("val"), "null")
self.assertEqual(body.get("val"), None)
self.assertEqual(body.get("msg"), "Hello! You POSTed successfully!")
self.assertEqual(body.get("status"), "SUCCESS")

Expand All @@ -77,6 +77,6 @@ def test_put(self):
self.assertNotEqual(result, None)
self.assertEqual(result.status, "200 OK")
self.assertEqual(body.get("type"), "PUT")
self.assertEqual(body.get("val"), "null")
self.assertEqual(body.get("val"), None)
self.assertEqual(body.get("msg"), "Hello! You PUTted successfully!")
self.assertEqual(body.get("status"), "SUCCESS")
6 changes: 3 additions & 3 deletions tests/cases/apis/HelloAPI/local/t_ParamHello.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ def test_get(self):
self.assertNotEqual(result, None)
self.assertEqual(result.status, "200 OK")
self.assertEqual(body.get("type"), "GET")
self.assertEqual(body.get("val"), "null")
self.assertEqual(body.get("val"), None)
self.assertEqual(body.get("msg"), f"Hello {param}! You GETted successfully!")
self.assertEqual(body.get("status"), "SUCCESS")

Expand All @@ -64,7 +64,7 @@ def test_post(self):
self.assertNotEqual(result, None)
self.assertEqual(result.status, "200 OK")
self.assertEqual(body.get("type"), "POST")
self.assertEqual(body.get("val"), "null")
self.assertEqual(body.get("val"), None)
self.assertEqual(body.get("msg"), f"Hello {param}! You POSTed successfully!")
self.assertEqual(body.get("status"), "SUCCESS")

Expand All @@ -80,6 +80,6 @@ def test_put(self):
self.assertNotEqual(result, None)
self.assertEqual(result.status, "200 OK")
self.assertEqual(body.get("type"), "PUT")
self.assertEqual(body.get("val"), "null")
self.assertEqual(body.get("val"), None)
self.assertEqual(body.get("msg"), f"Hello {param}! You PUTted successfully!")
self.assertEqual(body.get("status"), "SUCCESS")
2 changes: 1 addition & 1 deletion tests/cases/apis/HelloAPI/local/t_Version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,6 @@ def test_get(self):
self.assertNotEqual(result, None)
self.assertEqual(result.status, "200 OK")
self.assertEqual(body.get("type"), "GET")
self.assertEqual(body.get("val"), '{"version": "0.0.0-Testing"}')
self.assertEqual(body.get("val"), {"version": "0.0.0-Testing"})
self.assertEqual(body.get("msg"), "Successfully retrieved API version.")
self.assertEqual(body.get("status"), "SUCCESS")
6 changes: 3 additions & 3 deletions tests/cases/apis/HelloAPI/remote/t_Hello.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ def test_get(self):
Logger.Log(f"Could not parse json from {result.text}", logging.ERROR)
body = {}
self.assertEqual(body.get("type"), "GET", f"Bad type from {_url}")
self.assertEqual(body.get("val"), "null", f"Bad val from {_url}")
self.assertEqual(body.get("val"), None, f"Bad val from {_url}")
self.assertEqual(body.get("msg"), "Hello! You GETted successfully!", f"Bad msg from {_url}")
self.assertEqual(body.get("status"), "SUCCESS", f"Bad status from {_url}")

Expand All @@ -55,7 +55,7 @@ def test_post(self):
Logger.Log(f"Could not parse json from {result.text}", logging.ERROR)
body = {}
self.assertEqual(body.get("type"), "POST", f"Bad type from {_url}")
self.assertEqual(body.get("val"), "null", f"Bad val from {_url}")
self.assertEqual(body.get("val"), None, f"Bad val from {_url}")
self.assertEqual(body.get("msg"), "Hello! You POSTed successfully!", f"Bad msg from {_url}")
self.assertEqual(body.get("status"), "SUCCESS", f"Bad status from {_url}")

Expand All @@ -75,6 +75,6 @@ def test_put(self):
Logger.Log(f"Could not parse json from {result.text}", logging.ERROR)
body = {}
self.assertEqual(body.get("type"), "PUT", f"Bad type from {_url}")
self.assertEqual(body.get("val"), "null", f"Bad val from {_url}")
self.assertEqual(body.get("val"), None, f"Bad val from {_url}")
self.assertEqual(body.get("msg"), "Hello! You PUTted successfully!", f"Bad msg from {_url}")
self.assertEqual(body.get("status"), "SUCCESS", f"Bad status from {_url}")
6 changes: 3 additions & 3 deletions tests/cases/apis/HelloAPI/remote/t_ParamHello.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ def test_get(self):
Logger.Log(f"Could not parse json result '{result.text}' from {_url}", logging.ERROR)
body = {}
self.assertEqual(body.get("type"), "GET", f"Bad type from {_url}")
self.assertEqual(body.get("val"), "null", f"Bad val from {_url}")
self.assertEqual(body.get("val"), None, f"Bad val from {_url}")
self.assertEqual(body.get("msg"), f"Hello {self.param}! You GETted successfully!", f"Bad msg from {_url}")
self.assertEqual(body.get("status"), "SUCCESS", f"Bad status from {_url}")

Expand All @@ -56,7 +56,7 @@ def test_post(self):
Logger.Log(f"Could not parse json result '{result.text}' from {_url}", logging.ERROR)
body = {}
self.assertEqual(body.get("type"), "POST", f"Bad type from {_url}")
self.assertEqual(body.get("val"), "null", f"Bad val from {_url}")
self.assertEqual(body.get("val"), None, f"Bad val from {_url}")
self.assertEqual(body.get("msg"), f"Hello {self.param}! You POSTed successfully!", f"Bad msg from {_url}")
self.assertEqual(body.get("status"), "SUCCESS", f"Bad status from {_url}")

Expand All @@ -76,6 +76,6 @@ def test_put(self):
Logger.Log(f"Could not parse json result '{result.text}' from {_url}", logging.ERROR)
body = {}
self.assertEqual(body.get("type"), "PUT", f"Bad type from {_url}")
self.assertEqual(body.get("val"), "null", f"Bad val from {_url}")
self.assertEqual(body.get("val"), None, f"Bad val from {_url}")
self.assertEqual(body.get("msg"), f"Hello {self.param}! You PUTted successfully!", f"Bad msg from {_url}")
self.assertEqual(body.get("status"), "SUCCESS", f"Bad status from {_url}")
Loading