User story #10299
closedAPI Doc missing possibilities of New Group's query syntax
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)
Updated by François ARMAND over 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
Updated by Alexis Mousset over 7 years ago
- Is duplicate of Bug #6221: Format of the query to update groups via API is not documented added
Updated by Benoît PECCATTE over 7 years ago
- Tracker changed from Bug to User story
Updated by Benoît PECCATTE almost 7 years ago
- Target version set to Ideas (not version specific)
Updated by Alexis Mousset over 4 years ago
- Status changed from New to Resolved
This is now documented in the new API doc, closing.