Skip to content

RUN-4231: Document API v58 metaExclude for jobs browse and job meta #1783

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.

Sign up for GitHub

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

Open
smartinellibenedetti wants to merge 2 commits into
base: grails7-upgrade
Choose a base branch
from
+14 −0
Open

RUN-4231: Document API v58 metaExclude for jobs browse and job meta #1783

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f31b1a6
update endpoint info
smartinellibenedetti Mar 25, 2026
8f75103
handle copilot comments
smartinellibenedetti Mar 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/api/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3500,6 +3500,10 @@ Request parameters:

* `meta` - Comma-separated list of metadata item names to include, or "*" for all (default)

**Additional Parameters (API v58+):**

* `metaExclude` - Optional comma-separated list of metadata component names to omit after resolving `meta`. Requires API v58 or higher in the request URL; if the URL uses a lower API version, this parameter is ignored. If `meta` contains `*`, the server expands `*` to the union of all registered job metadata component names, then removes excluded names (the literal `*` is not treated as a component name). If `meta` is an explicit list, each name in `metaExclude` is removed from that list. Omit the parameter to keep the previous behavior.

**Response:**

```json
Expand Down Expand Up @@ -5555,6 +5559,10 @@ breakpoint are available, no metadata will be loaded

* Additional query parameters, see [Listing Jobs](#listing-jobs).

**Additional Parameters (API v58+):**

* `metaExclude` - Optional comma-separated list of metadata component names to omit after resolving `meta`. Requires API v58 or higher in the request URL; if the URL uses a lower API version, this parameter is ignored. If `meta` contains `*`, the server expands `*` to the union of all registered job metadata component names, then removes excluded names (the literal `*` is not treated as a component name). If `meta` is an explicit list, excluded names are removed from that list. Omit the parameter to keep the previous behavior.

**Response**

```json
Expand Down
6 changes: 6 additions & 0 deletions docs/api/rundeck-api-versions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,12 @@ Changes introduced by API Version number:
API versions below `{{$apiDepVersion}}` are *deprecated*. Clients using earlier versions should upgrade to use `{{$apiDepVersion}}` as the minimum version before release `{{ $apiDepRelease }}` to avoid errors.
:::

### Version 58

* Updated Endpoints:
* [`GET /api/V/project/[PROJECT]/jobs/browse`][/api/V/project/\[PROJECT\]/jobs/browse] - Optional query parameter `metaExclude`: comma-separated job metadata component names to omit after resolving `meta`. When `meta` includes `*`, the server expands `*` to the union of all registered job metadata component names, then removes excluded names (the literal `*` is not treated as a component name). For an explicit comma-separated `meta` list, excluded names are removed from that list. The parameter is ignored if the request URL uses an API version below 58.
* [`GET /api/V/job/[ID]/meta`][/api/V/job/\[ID\]/meta] - Same optional `metaExclude` query parameter and resolution rules (API version 58+ only).

### Version 57

* Updated Endpoints:
Expand Down
Loading