REST API documentation consistency improvements

[alexvuka1]

📜 Description

I have identified the following possible instances of inconsistencies between Open API specification and Documentation:

• 🟩Found in Open API specification, 🟥Not found in Documentation

  • POST /refresh
  • GET /entities/by-name/{kind}/{namespace}/{name}/ancestry
  • GET /entity-facets
  • POST /analyze-location
  • POST /validate-entity

• 🟩Found in Open API specification, 🟩Found in Documentation, 🟥Have Inconsistencies

  • Inconsistency type	Open API specification DELETE /locations/{id}	Documentation DELETE /locations/<uid>
    Path parameter name mismatch	id	uid

About

This is part of the evaluation of my Master's Project at Imperial College London. The section above is automatically generated and aims to expose API documentation inconsistencies in real-world GitHub repositories. The end goal is for the tool to be used as part of CI/CD, namely as a GitHub action.

Hopefully, this is a step towards easier maintenance of API documentation. If you find this helpful, please consider updating the documentation to keep it in sync with the source code. I am also happy to assist with it, if appropriate. If this has not been useful, consider updating this issue with an explanation, so I can improve my approach. Thank you!

👀 Have you spent some time to check if this bug has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

Are you willing to submit PR?

Yes I am willing to submit a PR!

[Rugvip]

Thank you! 👍

It would be useful to have links to the outdated documentation as well, since that might not be immediately clear

[alexvuka1]

I have updated the formatting of the description to make it more readable. The provided links should work properly, but if you would like them to be improved, please let me know. In case you have further feedback, it would be greatly appreciated. Thanks!

[ismailmmd]

@Rugvip I created #24999 to resolve this.