Project

General

Profile

Actions

Bug #7131

closed

The select parameter in the nodes API is not correctly documented

Added by Alexis MOUSSET almost 6 years ago. Updated almost 5 years ago.

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

Description

The api doc for nodes says for the select parameter: "What kid of data we wnat to include. Here we can get policy servers/relay by setting 'nodeAndPolicyServer' Default value: node"

But the default seems to include policy servers anyway:

curl -k -X GET -H "Content-Type: application/json;charset=utf-8" --header "X-API-Token: xedZNGsc6rxWXnHMKDPD13OTuoYPBXUZ" --header "X-API-Version: latest" "https://127.0.0.1:8381/rudder/api/nodes" 
{
    "nodes": [
        {
            "architectureDescription": "x86_64-linux-thread-multi", 
            "hostname": "agent1.rudder.local", 
            "id": "7d74d611-8421-4b7d-9924-3dfeef01f915", 
            "ipAddresses": [
                "10.0.2.15", 
                "127.0.0.1", 
                "192.168.43.3" 
            ], 
            "lastInventoryDate": "2015-08-25 16:04", 
            "machine": {
                "id": "2aa672d7-7d11-e034-aa4b-efe22f1d4e18", 
                "manufacturer": "innotek GmbH", 
                "provider": "vbox", 
                "serialNumber": "0", 
                "type": "Virtual" 
            }, 
            "managementTechnology": [
                {
                    "name": "CFEngine Community" 
                }
            ], 
            "os": {
                "fullName": "CentOS Linux release 7.0.1406 (Core)", 
                "kernelVersion": "3.10.0-123.el7.x86_64", 
                "name": "Centos", 
                "type": "Linux", 
                "version": "7.0.1406" 
            }, 
            "policyServerId": "root", 
            "properties": [], 
            "ram": 238, 
            "status": "accepted" 
        }, 
        {
            "architectureDescription": "x86_64-linux-thread-multi", 
            "hostname": "server.rudder.local", 
            "id": "root", 
            "ipAddresses": [
                "10.0.2.15", 
                "127.0.0.1", 
                "192.168.43.2" 
            ], 
            "lastInventoryDate": "2015-08-19 12:55", 
            "machine": {
                "id": "63a9f0ea-7bb9-8050-796b-649e85481845", 
                "manufacturer": "innotek GmbH", 
                "provider": "vbox", 
                "serialNumber": "0", 
                "type": "Virtual" 
            }, 
            "managementTechnology": [
                {
                    "name": "CFEngine Community" 
                }
            ], 
            "os": {
                "fullName": "CentOS Linux release 7.0.1406 (Core)", 
                "kernelVersion": "3.10.0-123.el7.x86_64", 
                "name": "Centos", 
                "type": "Linux", 
                "version": "7.0.1406" 
            }, 
            "policyServerId": "root", 
            "properties": [
                {
                    "name": "env_type", 
                    "value": "deprovisioned" 
                }, 
                {
                    "name": "utf-8 poetry", 
                    "value": "testéÀ" 
                }
            ], 
            "ram": 1498, 
            "status": "accepted" 
        }
    ]
}
Actions #1

Updated by Alexis MOUSSET almost 6 years ago

  • Category set to API
  • Target version set to 3.1.2
Actions #2

Updated by Vincent MEMBRÉ over 5 years ago

  • Target version changed from 3.1.2 to 3.1.3
Actions #3

Updated by Vincent MEMBRÉ over 5 years ago

  • Target version changed from 3.1.3 to 3.1.4
Actions #4

Updated by Vincent MEMBRÉ over 5 years ago

  • Target version changed from 3.1.4 to 3.1.5
Actions #5

Updated by Vincent MEMBRÉ over 5 years ago

  • Target version changed from 3.1.5 to 3.1.6
Actions #6

Updated by Jonathan CLARKE over 5 years ago

  • Tags set to Quick and important
  • Assignee set to Vincent MEMBRÉ
Actions #7

Updated by Vincent MEMBRÉ over 5 years ago

  • Target version changed from 3.1.6 to 3.1.7
Actions #8

Updated by François ARMAND over 5 years ago

  • Status changed from New to In progress
  • Assignee changed from Vincent MEMBRÉ to François ARMAND
Actions #9

Updated by Vincent MEMBRÉ over 5 years ago

  • Target version changed from 3.1.7 to 3.1.8
Actions #10

Updated by Vincent MEMBRÉ over 5 years ago

  • Target version changed from 3.1.8 to 3.1.9
Actions #11

Updated by Vincent MEMBRÉ about 5 years ago

  • Target version changed from 3.1.9 to 3.1.10
Actions #12

Updated by François ARMAND about 5 years ago

  • Status changed from In progress to New
Actions #13

Updated by Vincent MEMBRÉ about 5 years ago

  • Target version changed from 3.1.10 to 3.1.11
Actions #14

Updated by Vincent MEMBRÉ about 5 years ago

  • Target version changed from 3.1.11 to 3.1.12
Actions #15

Updated by Vincent MEMBRÉ almost 5 years ago

Select parameter is used, only if query is used, guss it should be updated in the doc. Or should we should we change the beahvior ?

Actions #16

Updated by Vincent MEMBRÉ almost 5 years ago

  • Status changed from New to In progress
  • Assignee changed from François ARMAND to Vincent MEMBRÉ
Actions #17

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/32
Actions #18

Updated by François ARMAND almost 5 years ago

  • Subject changed from The select parameter in the nodes API has no effect to The select parameter in the nodes API is not correctly documented
Actions #19

Updated by Vincent MEMBRÉ almost 5 years ago

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

Updated by Alexis MOUSSET almost 5 years ago

  • Status changed from Pending release to Released

This bug has been fixed in Rudder 3.1.12 and 3.2.5 which were released today.

Actions

Also available in: Atom PDF