Project

General

Profile

Actions

Bug #8192

closed

Better document Node Api: include detail always returns "default"

Added by Janos Mattyasovszky almost 8 years ago. Updated almost 2 years ago.

Status:
Released
Priority:
N/A
Category:
API
Target version:
Severity:
UX impact:
User visibility:
Effort required:
Priority:
0
Name check:
Fix check:
Regression:

Description

As documented here:

https://www.rudder-project.org/rudder-api-doc/#api-Nodes-acceptedNodeDetails

include
Level of information to include from the node inventory. Some base levels are defined (minimal, default, full). you can add fields you want by adding them to the list, possible values are keys from json answer.
Default value: default

Using this description and the goal to only retrieve one specific "key" of the node info (like ipAddresses or properties) I tried to use "?indclude=os", but I got the "default" set regardless.

It only worked if I used "?include=minimal,os", so only the minimal information was returned in addition to the key I wanted to fetch, but the documentation does not show any clue of that this behavior can be achieved this way, nor does is state how to fetch only one key.

Please either adjust the documentation to reflect this behavior or implement something like "?includeOnly=<keylist>", so one can fine-tune which keys have to be returned, and that only those are actually returned.


Related issues 1 (1 open0 closed)

Related to Rudder - User story #8193: Add an option to be able to be more selective about node API returned contentNew2016-04-19Actions
Actions

Also available in: Atom PDF