Project

General

Profile

Actions

User story #10299

closed

API Doc missing possibilities of New Group's query syntax

Added by Janos Mattyasovszky about 7 years ago. Updated almost 4 years ago.

Status:
Resolved
Priority:
N/A
Assignee:
-
Category:
Documentation
UX impact:
Suggestion strength:
User visibility:
Effort required:
Name check:
Fix check:
Regression:

Description

Hi,

At: https://www.rudder-project.org/rudder-api-doc/#api-Groups-createGroup

The formatting of the "query" option is missing:

query (optional) - JSON    - Query to get Nodes. Empty Query is possible, but this group will not have nodes anymore

But according to an existing group this has a format of:

'query' => {
             'composition' => 'And',
             'where' => [
                          {
                            'attribute' => 'name.value',
                            'objectType' => 'serializedNodeProperty',
                            'comparator' => 'eq',
                            'value' => 'Key=Value'
                          }
                        ],    
             'select' => 'node'
           },

The possible formats seems to be missing from the API Doc (a search for serializedNodeProperty does not show any hits in the API docs)


Related issues 1 (0 open1 closed)

Is duplicate of Rudder - Bug #6221: Format of the query to update groups via API is not documentedRejectedFrançois ARMANDActions
Actions #1

Updated by François ARMAND about 7 years ago

I, thanks for reporting.

The doc is effectivelly missing.

In the mean time and as a first insigh, you can get the name of all the attribute in that file: https://github.com/Normation/rudder/blob/master/rudder-core/src/main/scala/com/normation/rudder/domain/queries/DitQueryData.scala
And attribute names are defined here: https://github.com/Normation/rudder/blob/master/rudder-core/src/main/scala/com/normation/rudder/domain/RudderLDAPConstants.scala

Actions #2

Updated by Alexis Mousset about 7 years ago

  • Is duplicate of Bug #6221: Format of the query to update groups via API is not documented added
Actions #3

Updated by Alexis Mousset about 7 years ago

  • Status changed from New to Rejected

Duplicate of #10299.

Actions #4

Updated by Alexis Mousset about 7 years ago

  • Status changed from Rejected to New
Actions #5

Updated by Benoît PECCATTE about 7 years ago

  • Tracker changed from Bug to User story
Actions #6

Updated by Benoît PECCATTE about 6 years ago

  • Target version set to Ideas (not version specific)
Actions #7

Updated by Alexis Mousset almost 4 years ago

  • Status changed from New to Resolved

This is now documented in the new API doc, closing.

Actions

Also available in: Atom PDF