Project

General

Profile

Actions

Bug #8192

closed

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

Added by Janos Mattyasovszky about 5 years ago. Updated about 4 years ago.

Status:
Released
Priority:
N/A
Category:
API
Target version:
Severity:
User visibility:
Effort required:
Priority:

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

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

Updated by François ARMAND about 5 years ago

Thanks fo rthe report, clearly the documentation must be updated with your use case, and it must be clearly stated that you always get at least minimal fields.

Actions #2

Updated by François ARMAND about 5 years ago

  • Related to User story #8193: Add an option to be able to be more selective about node API returned content added
Actions #3

Updated by François ARMAND about 5 years ago

  • Subject changed from Api include detail always returns "default" to Better document Node Api: include detail always returns "default"

Changing the title to make it clear that that ticket is for documentation, and #8193 will be for code.

Actions #4

Updated by François ARMAND about 5 years ago

  • Assignee changed from François ARMAND to Vincent MEMBRÉ

:)

Actions #5

Updated by François ARMAND about 5 years ago

  • Target version set to 3.0.16
Actions #6

Updated by François ARMAND about 5 years ago

  • Tags set to Quick and important, Sponsored, Next minor release
Actions #7

Updated by Vincent MEMBRÉ almost 5 years ago

  • Status changed from New to In progress
Actions #8

Updated by Vincent MEMBRÉ almost 5 years ago

  • Status changed from In progress to Pending technical review
  • Assignee changed from Vincent MEMBRÉ to François ARMAND
  • Pull Request set to https://github.com/Normation/rudder-api-doc/pull/29
Actions #9

Updated by Vincent MEMBRÉ almost 5 years ago

  • Status changed from Pending technical review to Pending release
  • % Done changed from 0 to 100
Actions #10

Updated by Vincent MEMBRÉ almost 5 years ago

  • Status changed from Pending release to Released

This bug has been fixed in Rudder 3.0.16, 3.1.10 and 3.2.3 which were released on 2016-06-01, but not announced.

Actions #11

Updated by Benoît PECCATTE about 4 years ago

  • Found in version (s) 3.1.8 added
Actions #12

Updated by Benoît PECCATTE about 4 years ago

  • Found in version(s) old deleted (3.1.8)
Actions

Also available in: Atom PDF