Project

General

Profile

Actions
Copy link

Bug #17814

closed

Rudder (6.1) API missing documentation

Bug #17814: Rudder (6.1) API missing documentation

Added by Bas B over 5 years ago. Updated over 5 years ago.

Status:
Resolved
Priority:
N/A
Assignee:
-
Category:
API
Target version:
6.1.2
Pull Request:
Severity:
UX impact:
User visibility:
Effort required:
Priority:
0
Name check:
To do
Fix check:
To do
Regression:

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.

Related issues 3 (0 open — 3 closed)

Related to Rudder - Bug #17815: Group API compatibility broken as it now always expects "properties"ReleasedVincent MEMBRÉActions
Related to Rudder - Bug #17817: 'policyMode' vs. 'policy' in node settings APIReleasedFrançois ARMANDActions
Related to Rudder - Bug #17818: Missing doc for group properties and json global parametersReleasedAlexis MoussetActions

Updated by Alexis Mousset over 5 years ago Actions
Copy link
 #1

  • Category changed from Documentation to API
  • Target version set to 6.1.1

Updated by Alexis Mousset over 5 years ago Actions
Copy link
 #2

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.

Updated by Alexis Mousset over 5 years ago Actions
Copy link
 #3

Opened #17817 for policyMode parameter.

Updated by Alexis Mousset over 5 years ago Actions
Copy link
 #4

Opened #17818 for group properties documentation

Updated by François ARMAND over 5 years ago Actions
Copy link
 #5

  • Related to Bug #17815: Group API compatibility broken as it now always expects "properties" added

Updated by François ARMAND over 5 years ago Actions
Copy link
 #6

  • Related to Bug #17817: 'policyMode' vs. 'policy' in node settings API added

Updated by François ARMAND over 5 years ago Actions
Copy link
 #7

  • Related to Bug #17818: Missing doc for group properties and json global parameters added

Updated by Bas B over 5 years ago Actions
Copy link
 #8

Alexis MOUSSET wrote in #note-4:

Opened #17818 for group properties documentation

Thanks!

Updated by Vincent MEMBRÉ over 5 years ago Actions
Copy link
 #9

  • Target version changed from 6.1.1 to 6.1.2

Updated by François ARMAND over 5 years ago Actions
Copy link
 #10

  • 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

Updated by Bas B over 5 years ago Actions
Copy link
 #11

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!

Actions
Copy link

Also available in: PDF Atom