Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

REST API documentation consistency improvements #783

Open
2 tasks
alexvuka1 opened this issue May 27, 2024 · 2 comments
Open
2 tasks

REST API documentation consistency improvements #783

alexvuka1 opened this issue May 27, 2024 · 2 comments

Comments

@alexvuka1
Copy link

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

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
Copy link

csdaa commented Jun 4, 2024

666

@alexvuka1
Copy link
Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants