Undocumented Web API response change in Result.case_counts length

[Aldaviva]

Hello,

The length of the case_counts array in the Result response object recently increased from 4 to 5. This change was deployed some time between 2022-10-09 and 2022-10-16. One effect of this change is that Shields.io badges for Testspace all return "invalid response data" now, as they have a validator for max length 4 on this property value, which hasn't changed recently.

The current official List results API method documentation still describes the case_counts property of the Result response object as

Field	Type	Notes
case_counts	array	The contained cases [passed, failed, na, errored] counters

However, an actual API request and response now looks like

GET /api/projects/testspace-com%3Ademo/spaces/main/results HTTP/1.1
Host: demo.testspace.com

[
  {
    "case_counts": [64, 9, 2, 0, 0],
    // ...
  },
  // ...
]

I checked the official Changelog and did not see any changes that were recent or that referred to the Response object.

---

• What is the new meaning of the case_counts array?
  I'm guessing some new value was appended to the end of the array, but all of the spaces I found, including some of my own, always have 0 in the last two positions, so I'm not sure where the new value was inserted, or what it means.
• Can the official documentation be updated to reflect these API changes?

Thanks!

[ivailop]

Hi @Aldaviva,

Thanks for reporting the issue. As the Testspace badges at Shilds.io are not officially supported by us we were not aware of the problem.

Yes, there was a new Testspace release deployed last week that added a 5th number to the case_counts array. It is meant to capture "untested" count, which is meaningful only for Manual testing.

We are sorry we are behind with updating our documentation about that change.

Would you like to submit a fix to https://github.com/badges/shields or you prefer us to follow up with that? Notice, some of the comments in there may have to be also adjusted as they point to non-existing help-urls.

[Aldaviva]

Thanks! I can make a first attempt at a pull request and let you know if there are any questions we need help with. I'll update the help URLs too.

[Aldaviva]

Filed badges/shields#8544.

[Aldaviva]

PR approved and merged.

[ivailop]

Thank you @Aldaviva!
We also updated our help - https://help.testspace.com/reference/web-api#results

[Aldaviva]

Looking good. Shields.io have pushed a release to production and it seems to be fully resolved now.

Thanks for all your help with this, @ivailop!