Add comprehensive API documentation - #154
Open
xenacode-art wants to merge 1 commit into
Open
Conversation
This commit adds complete REST API documentation covering all 17 endpoints in the PendingChangesBot application. The documentation includes: - Reviews API endpoints (pending pages, autoreview checks, configuration) - Statistics API endpoints (review statistics, chart data, flagged revisions) - Detailed request/response examples for all endpoints - Data model descriptions - Error handling guidelines - CSRF protection and caching information The README.md has also been updated to include a Documentation section with links to the API docs, authentication guide, and contributing guide.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This commit adds complete REST API documentation covering all 17 endpoints in the PendingChangesBot application. The documentation includes:
The README.md has also been updated to include a Documentation section with links to the API docs, authentication guide, and contributing guide.