Bug #26675
open
Error in documentation /api/changeRequests response data
Added by Véronique HAYAERT 2 months ago.
Updated about 1 month ago.
Severity:
Minor - inconvenience | misleading | easy workaround
User visibility:
Operational - other Techniques | Rudder settings | Plugins
Effort required:
Very Small
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":[]}
- Subject changed from Documentation /api/changeRequests to Error in documentation /api/changeRequests response data
- Status changed from New to In progress
- 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
Documentation for other changeRequest operations is also wrong, they also need to be changed
- Status changed from Pending technical review to Pending release
- 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": []
}
}
]
}
}
Also available in: Atom
PDF
Updated by 
Updated by