REST API documentation consistency improvements

[Alex Vukadinov]

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

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

  • GET /user/devices/{serial}
  • GET /user/accessTokens

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!

[csdaa]

666

[Alex Vukadinov]

I am not sure what that is supposed to mean, could you please explain?