I get an error when using the API interface (/v1/devices/{device_id}) in the API documentation.
1.Execute the following URL command
curl -i http://192.168.34.2:6385/v1/devices/22f0497c-0a09-41c4-8514-cb5afcbf930d -X GET -H "Content-Type: application/json" -H "Accept: application/json" -H "X-Auth-Token: ${TOKEN}"
The following results are returned:
HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 85
Date: Mon, 07 Dec 2020 17:25:10 GMT
{"error_message": "{\"code\": 404, \"description\": \"\", \"title\": \"Not Found\"}"}
2.Error cause analysis
a.The API docs documentation is incorrect, the URL interface in the api documentation is
/v1/devices/{device_id}
https://docs.starlingx.io/api-ref/config/api-ref-sysinv-v1-config.html?expanded=shows-the-attributes-of-a-specific-pci-device-detail#profiles；
b.The url in the code interface in the code is /v1/pci_devices/{device_id}, which is inconsistent with the
api docs
https://github.com/starlingx/config/blob/master/sysinv/cgts-client/cgts-client/cgtsclient/v1/pci_device.py#L28
During the analysis, I found that the interface "Modifies a specific PCI device" also has corresponding problems, that is, the API document is /v1/devices/{device_id}, but the code is /v1/pci_devices/{device_id}
https://github.com/starlingx/config/blob/master/sysinv/cgts-client/cgts-client/cgtsclient/v1/pci_device.py#L35
Low severity - inaccurate API documentation