Skip to content

Commit 7a9d333

Browse files
authored
Merge pull request #1783 from rundeck/RUN-4231-endpoint-changes
RUN-4231: Document API v58 `metaExclude` for jobs browse and job meta
2 parents a5be66d + 8f75103 commit 7a9d333

2 files changed

Lines changed: 14 additions & 0 deletions

File tree

docs/api/index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3500,6 +3500,10 @@ Request parameters:
35003500

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

3503+
**Additional Parameters (API v58+):**
3504+
3505+
* `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.
3506+
35033507
**Response:**
35043508

35053509
```json
@@ -5555,6 +5559,10 @@ breakpoint are available, no metadata will be loaded
55555559

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

5562+
**Additional Parameters (API v58+):**
5563+
5564+
* `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.
5565+
55585566
**Response**
55595567

55605568
```json

docs/api/rundeck-api-versions.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,12 @@ Changes introduced by API Version number:
3535
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.
3636
:::
3737

38+
### Version 58
39+
40+
* Updated Endpoints:
41+
* [`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.
42+
* [`GET /api/V/job/[ID]/meta`][/api/V/job/\[ID\]/meta] - Same optional `metaExclude` query parameter and resolution rules (API version 58+ only).
43+
3844
### Version 57
3945

4046
* Updated Endpoints:

0 commit comments

Comments
 (0)