-
Notifications
You must be signed in to change notification settings - Fork 5.8k
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 #24829
Labels
area:catalog
Related to the Catalog Project Area
bug
Something isn't working
good first issue
Good for newcomers
help wanted
Help/Contributions wanted from community members
Comments
Rugvip
added
area:catalog
Related to the Catalog Project Area
help wanted
Help/Contributions wanted from community members
labels
May 20, 2024
Thank you! 👍 It would be useful to have links to the outdated documentation as well, since that might not be immediately clear |
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! |
alexvuka1
changed the title
Interactive API documentation consistency improvements
REST API documentation consistency improvements
May 25, 2024
5 tasks
@freben I think this can be closed |
Alright! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
area:catalog
Related to the Catalog Project Area
bug
Something isn't working
good first issue
Good for newcomers
help wanted
Help/Contributions wanted from community members
📜 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
DELETE /locations/{id}
DELETE /locations/<uid>
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?
🏢 Have you read the Code of Conduct?
Are you willing to submit PR?
Yes I am willing to submit a PR!
The text was updated successfully, but these errors were encountered: