Project

General

Profile

Actions
Copy link

Bug #26675

open

Error in documentation /api/changeRequests response data

Added by Véronique HAYAERT about 2 months ago. Updated 20 days ago.

Status:
Pending release
Priority:
N/A
Assignee:
Clark ANDRIANASOLO
Target version:
Rudder plugins - 8.2
Pull Request:
https://github.com/Normation/rudder/p...
Severity:
Minor - inconvenience | misleading | easy workaround
UX impact:
User visibility:
Operational - other Techniques | Rudder settings | Plugins
Effort required:
Very Small
Priority:
0
Name check:
To do
Fix check:
Checked
Regression:
No

Description

The data array of the response does not match the expected definition from the documentation (does not contain the "rules" field)

$ curl --header "X-API-Token: $(cat /var/rudder/run/api-token)" --request GET http://localhost:8080/rudder/api/latest/changeRequests --data "status=open" 
{"action":"listChangeRequests","result":"success","data":[]}
Actions
Copy link
 #1

Updated by Véronique HAYAERT about 2 months ago

  • Subject changed from Documentation /api/changeRequests to Error in documentation /api/changeRequests response data
Actions
Copy link
 #2

Updated by Véronique HAYAERT about 2 months ago

  • Status changed from New to In progress
Actions
Copy link
 #3

Updated by Véronique HAYAERT about 2 months ago

  • Status changed from In progress to Pending technical review
  • Assignee changed from Véronique HAYAERT to Clark ANDRIANASOLO
  • Pull Request set to https://github.com/Normation/rudder/pull/6302
Actions
Copy link
 #4

Updated by Véronique HAYAERT about 2 months ago

Documentation for other changeRequest operations is also wrong, they also need to be changed

Actions
Copy link
 #5

Updated by Véronique HAYAERT about 1 month ago

  • Status changed from Pending technical review to Pending release
Actions
Copy link
 #6

Updated by Clark ANDRIANASOLO 20 days ago

  • Fix check changed from To do to Checked

The doc is updated with the right data container changeRequests now : 

{
  "action": "changeRequestDetails",
  "id": "4",
  "result": "success",
  "data": {
    "changeRequests": [
      {
        "id": 4,
        "displayName": "update Directive plugin Openscap policies ABC",
        "status": "Pending validation",
        "created by": "No One",
        "acceptable": true,
        "description": "",
        "changes": {
          "directives": [],
          "rules": [],
          "groups": [],
          "parameters": []
        }
      }
    ]
  }
}

Actions
Copy link

Also available in: Atom PDF