Docs: Add documentation for undocumented admin API endpoints#40
Open
Vivek1106-04 wants to merge 1 commit intoapache:masterfrom
Open
Docs: Add documentation for undocumented admin API endpoints#40Vivek1106-04 wants to merge 1 commit intoapache:masterfrom
Vivek1106-04 wants to merge 1 commit intoapache:masterfrom
Conversation
- Add documentation for /admin/cluster and /admin/cluster/node endpoints - Add documentation for /admin/requests/running endpoint (list and cancel) - Add documentation for /admin/diagnostics endpoint - Add documentation for /admin/version endpoint - Add documentation for /admin/shutdown endpoint - Add documentation for /admin/rebalance endpoint - Add documentation for /admin/storage endpoint (NC-level) - Add documentation for /admin/udf endpoint Change-Id: Id75c86758d7b6a32506acd4108b7608e50c2d920
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.
Summary
This PR adds comprehensive documentation for several admin API endpoints that were previously undocumented in
api.md.Changes
Added documentation for the following endpoints:
/admin/cluster- Cluster state and configuration/admin/cluster/node/{node-id}- Node-specific information and configuration/admin/requests/running- List and cancel running requests/admin/diagnostics- System diagnostics information/admin/version- AsterixDB version information/admin/shutdown- Cluster shutdown (all nodes or specific node)/admin/rebalance- Data rebalancing operations/admin/storage- Storage information (NC-level endpoint)/admin/udf- User-defined function management (NC-level endpoint)Testing
Documentation-only change. Verified endpoint behavior by reviewing servlet implementations in:
ClusterApiServlet.javaNodeControllerDetailsApiServlet.javaActiveRequestsServlet.javaDiagnosticsApiServlet.javaVersionApiServlet.javaShutdownApiServlet.javaRebalanceApiServlet.javaStorageApiServlet.javaNCUdfApiServlet.javaRelated