REST API documentation consistency improvements

[alexvuka1]

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

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

  • [ ] GET /
  • [ ] GET /v1/generation/job-queue

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

  • [ ] POST /v1/engines/refresh-models
  • [ ] GET /v1/engines/job-queue

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!

[mrhan1993]

/v1/engines/refresh-models has removed，may useful for older versions

[alexvuka1]

Thank you for the response and for pointing out the false positive.

The tool currently flags any discrepancies between the documented endpoints and the Open API specification to ensure consistency. However, I realise this can include depricated/removed endpoints, such as in your case.

Other than that, it flagged 3 more inconsistencies, are those valid?

Thank you again for your cooperation and understanding!