Project

General

Profile

Actions
Copy link

Bug #25709

closed

OpenAPI documentation is invalid with duplicate /nodes/pending endpoints

Added by Clark ANDRIANASOLO about 1 month ago. Updated 14 days ago.

Status:
Released
Priority:
N/A
Assignee:
Alexis Mousset
Category:
Documentation
Target version:
8.1.8
Pull Request:
https://github.com/Normation/rudder/p...
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.

Actions
Copy link

Also available in: Atom PDF