RUN-3768: Update API docs with changes for job metrics plugin #1747
Conversation
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
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds documentation for API Version 57, which introduces new parameters to the execution metrics endpoints for job metrics plugin functionality. The changes enable snapshot-based metrics querying with support for batch processing across multiple jobs.
Key changes:
- Added Version 57 section documenting enhancements to execution metrics endpoints
- Introduced
useStats,groupByJob,begin, andendparameters for more flexible metrics querying - Added documentation for the new batch response format when querying metrics for multiple jobs
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/api/rundeck-api-versions.md | Added Version 57 entry documenting the new parameters for both execution metrics endpoints |
| docs/api/index.md | Detailed parameter descriptions and response format examples for the new API v57+ features |
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adds documentation for API Version 57, covering new parameters added to the execution metrics endpoints implemented in the rundeckpro folder.
Changes
Added Version 57 section to docs/docs/api/rundeck-api-versions.md
Documented updates to two existing execution metrics endpoints: