Skip to content

Commit 6b1bfda

Browse files
docs: added docs for new "Run Job" API (#726)
Co-authored-by: Nabeel Saabna <48175656+nabeelsaabna@users.noreply.github.com>
1 parent 397ede1 commit 6b1bfda

2 files changed

Lines changed: 13 additions & 3 deletions

File tree

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,6 @@ The following platforms are supported by Mend Renovate Community Edition and Ent
3131
5. Migration ([Renovate On-Premises to Renovate Community](./migrating-to-renovate-ce.md))
3232
6. API Documentation
3333
- [Admin APIs](./api.md)
34-
- [Job Logs APIs](./job-logs-apis.md)
34+
- [Job APIs](./job-apis.md)
3535
- [Reporting APIs](./reporting-apis.md)
3636
7. [Advanced topics](./advanced.md)
Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
1-
# Job Logs APIs
1+
# Job APIs
22

33
Job Logs APIs provide a summary of and content for the Job Logs generated by the Renovate CLI.
44

5-
## Available Job Logs APIs
5+
The Run Job API schedules a Renovate job to run against a given repository.
6+
7+
## Available Job APIs
68

79
The list below describes the available Job Logs APIs. Follow the links on the API names for full details.
810

911
- [List Jobs by Repo](#list-jobs-by-repo) ← Lists all jobs for a given repo
1012
- [Get Job Logs by Repo](#get-job-logs-by-repo) ← Fetch job logs for a given repo (latest, or by JobID)
1113
- [Get Job Logs by JobID](#get-job-logs-by-jobid) ← Fetch job logs by Job ID
14+
- [Run Job on a Repo](#run-job-on-a-repo) ← Run a Renovate job against a given repo
1215

1316
## Enable Job Logs APIs
1417

@@ -35,6 +38,7 @@ See the table below for a list of Job Logs API URL formats.
3538
| [List Jobs by Repo](#list-jobs-by-repo) | [GET] /api/repos/{org}/{repo}/-/jobs | limit (default=100, max=10,000) |
3639
| [Get Job Logs by Repo](#get-job-logs-by-repo) | [GET] /api/repos/{org}/{repo}/-/jobs/<latest\|{jobId}> | |
3740
| [Get Job Logs by JobID](#get-job-logs-by-jobid) | [GET] /api/job/logs/{jobId} | |
41+
| [Run Job on a Repo](#run-job-on-a-repo) | [POST] /api/repos/{org}/{repo}/-/jobs/run | |
3842

3943
## Details of Job Logs APIs
4044

@@ -142,3 +146,9 @@ Note: This returns the same as [Get Job Logs by Repo](#get-job-logs-by-repo) wit
142146
{"name":"renovate","hostname":"271939e11491","pid":21,"level":20,"logContext":"5a3572bf-49fe-42bb-a066-ff1146fe83d1","msg":"Verifying and cleaning cache: /tmp/renovate/cache/renovate/renovate-cache-v1","time":"2024-05-13T12:42:29.521Z","v":0}
143147
{"name":"renovate","hostname":"271939e11491","pid":21,"level":20,"logContext":"5a3572bf-49fe-42bb-a066-ff1146fe83d1","msg":"Deleted 0 of 29 file cached entries in 840ms","time":"2024-05-13T12:42:30.193Z","v":0}
144148
```
149+
150+
### Run Job on a Repo
151+
152+
API: [POST] /api/repos/{org}/{repo}/-/jobs/run
153+
154+
**Description:** Schedules a job to run Renovate on the given repository

0 commit comments

Comments
 (0)