DiamondLightSource / DiamondLightSource/heliotrapi
Have client fully serialise result
- Dominant language
- Python
- Stars
- 1
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
The results field in the `AnalysisResult` we get from the client is a string:
`'{"centre":-10.0,"peaks":[{"amplitude":1.0,"centre":-10.0,"fwhm":0.5,"normalised":true}],"scores":[1.0]}'`
This means we have to `json.loads` the result, it would be nice if the client fully serialised the result so it's already a dict.
## Acceptance Criteria
- The client returns results that don't need to be serialised
Contributor guide
Research direction
Start by locating the client code that constructs or returns AnalysisResult and inspect where the results field remains a JSON string. Check the existing client tests, if present, and verify that the returned results value is a dictionary without requiring json.loads; the acceptance criterion is that client results need no further serialization.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100