fix: update the PARTIAL case description that `match_rate` is set in the response

camaraproject / DeviceLocation

Repository to describe, develop, document and test the DeviceLocation API family

Apache License 2.0

20 stars 33 forks source link

fix: update the PARTIAL case description that `match_rate` is set in the response #159

Closed maxl2287 closed 4 months ago

maxl2287 commented 4 months ago

What type of PR is this?

Add one of the following kinds:

correction

What this PR does / why we need it:

Correct the definition for "match_rate" in the PARTIAL-response. Confusion came up if the "match_rate" is optional for PARTIAL responses for wording "may be included".

Which issue(s) this PR fixes:

Fixes #158

jlurien commented 4 months ago

Hi, I don't fully remember how intentional was this when we introduced matchRate, as we hadn't fully discussed the implementation details. But I agree that makes more sense to return it when PARTIAL is returned. Regarding versioning it should be for 0.3.0-wip, as 0.2.0 is approved and about to be released.

maxl2287 commented 4 months ago

Version is updated to 0.3.0-wip