RUN-4231: Document API v58 metaExclude for jobs browse and job meta#1783
Open
smartinellibenedetti wants to merge 2 commits intograils7-upgradefrom
Open
RUN-4231: Document API v58 metaExclude for jobs browse and job meta#1783smartinellibenedetti wants to merge 2 commits intograils7-upgradefrom
metaExclude for jobs browse and job meta#1783smartinellibenedetti wants to merge 2 commits intograils7-upgradefrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation for the new API v58 optional query parameter metaExclude, which allows callers to omit specific job metadata components after resolving the meta set.
Changes:
- Add an API Version 58 entry describing
metaExcludebehavior and how it interacts withmeta(including*expansion). - Document
metaExcludeonGET /api/V/job/[ID]/meta(Get Job UI Metadata). - Document
metaExcludeonGET /api/V/project/[PROJECT]/jobs/browse(Project Job Group browse).
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 | Adds the Version 58 changelog entry describing the new metaExclude parameter on two endpoints. |
| docs/api/index.md | Adds metaExclude parameter documentation to the two affected endpoint reference sections. |
fdevans
force-pushed
the
RUN-4231-endpoint-changes
branch
from
a4941e0 to
8f75103
Compare
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
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
Documents API version 58 optional query parameter
metaExcludefor:GET /api/V/project/[PROJECT]/jobs/browse— Project Job Group browseGET /api/V/job/[ID]/meta— Get Job UI MetadataBehavior (as documented)
metaExcludeis only applied when the request uses API v58+ in the URL; otherwise it is ignored.meta.metaincludes*, the server expands to all registered job metadata names, then removes excluded names (literal*is not passed through to loaders).metais an explicit list, names inmetaExcludeare removed from that list.metaExcludekeeps the previous behavior.Files
docs/api/rundeck-api-versions.md— new Version 58 section.docs/api/index.md— parameter descriptions on the two endpoints above.Related