docs: `sensortype` is actually optional for manually configured senseboxes but docs state it's not - Githubissues

sensebox / openSenseMap-API

API for opensensemap.org

https://docs.opensensemap.org/

MIT License

49 stars 41 forks source link

docs: `sensortype` is actually optional for manually configured senseboxes but docs state it's not #861

Open hf-kklein opened 9 months ago

hf-kklein commented 9 months ago

Expected Behavior

Docs should state the actual data to be expected from the API.

Current Behavior

Docs say, that sensortype is not optional: https://docs.opensensemap.org/#api-Boxes-getBox grafik

But users can create (manually configured) senseboxes with empty sensortype via the OpenSenseMap UI. grafik

When retrieving those sensors via the API, they wont not have the sensorType key

Possible Solution

Mark the sensortype as optional, even if there is only 1 sensor in the DB with empty sensortype
or set a default value like null or "undefined" or empty string

Steps to Reproduce (for bugs)

Manually configure a sensebox via the UI
Add a sensor to the box, leave its type empty
Query the area where the box is located

Context

Tried to download all senseboxes in an area. The unmarshalling failed because of this 1 broken sensor.