`GET /syscollector/{agent_id}/packages` Faulty Response Sample

[gKits]

📌 Request Details

Required Information

• Target version: 4.13 (current)
• Request type
  • Product update
  • Fixes or corrections
  • Improvement
  • Other:
• Affected Documentation
  • Documentation section(s): GET /syscollector/{agent_id}/packages
  • Specific page URLs: https://documentation.wazuh.com/current/user-manual/api/reference.html#tag/Syscollector/operation/api.controllers.syscollector_controller.get_packages_info

Description

The response sample of the GET /syscollector/{agent_id}/packages endpoint seems to be wrong and differs from the common scheme that is usually used.

Currently the response sample documented looks like this:

But after testing the endpoint on a running instance of Wazuh I was able to identify that the documentation is wrong.

{
  "data": {
    "affected_items": [<redacted>],
    "total_affected_items": 1,
    "total_failed_items": 0,
    "failed_items": []
  },
  "message": "All specified syscollector information was returned",
  "error": 0
}

[nico-stefani]

Hi @gKits

Could you please expand on what you think is wrong with the response that you got?

I'm only seeing a different value for total_affected_items, but in this case, the value 307 is just an example.

Or maybe you are referring to one of the objects within affected_items? If this is the case, please give more context about what the difference is.

[gKits]

According to the docs error and message are supposed to be inside the data object. But if you look at the actual response they are at the top level of the json response.

[gKits]

According to the docs:

{
  "data": {
     ...
    "error": "...",
    "message": "..."
  }
} 

Actual response:

{
  "data": {
   ... 
  }, 
  "error": "...",
  "message": "..."
} 

[nico-stefani]

Hi @gKits

Understood, thank you for reporting the error. I've opened a PR to fix it.