Actions
Bug #25709
closed
OpenAPI documentation is invalid with duplicate /nodes/pending endpoints
Pull Request:
Severity:
Minor - inconvenience | misleading | easy workaround
UX impact:
User visibility:
First impressions of Rudder
Effort required:
Very Small
Priority:
0
Name check:
To do
Fix check:
Checked
Regression:
No
Description
When I check the openapi.yml declaration using swagger-cli, it is invalid because there are duplicate values for the /nodes/pending path :
[nix-shell:~/IdeaProjects/rudder/webapp/sources/api-doc]$ swagger-cli validate openapi.src.yml
Error parsing /home/clarkenciel/IdeaProjects/rudder/webapp/sources/api-doc/openapi.src.yml: duplicated mapping key at line 259, column -58:
"/nodes/pending":
^
Rapidoc seems to ignore the error and still generates a doc, but with the first value missing, so there is no API documentation for the List all pending nodes endpoint !
We need the error to be corrected, we also do not want such errors to be ignored when generating the doc.
Updated by Clark ANDRIANASOLO 2 months ago
- Status changed from New to In progress
Updated by Clark ANDRIANASOLO 2 months ago
- Status changed from In progress to Pending technical review
- Assignee changed from Clark ANDRIANASOLO to Alexis Mousset
- Pull Request set to https://github.com/Normation/rudder/pull/5956
Updated by Clark ANDRIANASOLO 2 months ago
- Status changed from Pending technical review to Pending release
Applied in changeset rudder|bcd9593e513702cbe083db45c96d617c254ffa12.
Updated by Alexis Mousset about 2 months ago
- Fix check changed from To do to Checked
Updated by Vincent MEMBRÉ about 1 month ago
- Status changed from Pending release to Released
This bug has been fixed in Rudder 8.1.8 and 8.2.1 which were released today.
Actions