Bug #17814
closed
Rudder (6.1) API missing documentation
Added by Bas B over 4 years ago.
Updated over 4 years ago.
Description
Hi,
The API documentation is not up to date (Rudder 6.1);
- properties[] is now a required parameter when creating groups, but this is not documented. When this parameter is not added to the request, it will crash with the following error: "errorDetails": "Could extract values from request <- Cannot create a group with an empty query" which is not correct.
- The Python API-Client doesn't support the properties[] parameter.
- Updating the policy mode for an accepted Node expects 'policyMode' instead of 'policy' as documented.
Keep the (API)-docs up to date please! These issues take a lot of time to troubleshoot and can be avoided easily with updated documentation.
- Category changed from Documentation to API
- Target version set to 6.1.1
Opened #17815 for group API failing due to missing properties, this looks like a bug in the server. Keeping this ticket for missing information in docs.
Opened #17817 for policyMode parameter.
Opened #17818 for group properties documentation
- Related to Bug #17815: Group API compatibility broken as it now always expects "properties" added
- Related to Bug #17817: 'policyMode' vs. 'policy' in node settings API added
- Related to Bug #17818: Missing doc for group properties and json global parameters added
Alexis MOUSSET wrote in #note-4:
Opened #17818 for group properties documentation
Thanks!
- Target version changed from 6.1.1 to 6.1.2
- Status changed from New to Resolved
I think everything related to that ticket was corrected, so I'm closing it. Please reopen if I'm mistaken
François ARMAND wrote in #note-10:
I think everything related to that ticket was corrected, so I'm closing it. Please reopen if I'm mistaken
Thanks!
Also available in: Atom
PDF