Skip to content

Commit 1d1af66

Browse files
nabeelsaabnanabeelsaabna
authored
docs(v11.0.0): update docs (#733)
1 parent 5432fc8 commit 1d1af66

File tree

7 files changed

+206
-105
lines changed

7 files changed

+206
-105
lines changed

‎docs/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ The following platforms are supported by Mend Renovate Community Edition and Ent
2929
- [Configure TLS Communication](./tls.md)
3030
- [Configure Event Notifications](./events.md)
3131
5. Migration ([Renovate On-Premises to Renovate Community](./migrating-to-renovate-ce.md))
32-
6. API Documentation
33-
- [Admin APIs](./api.md)
34-
- [Job APIs](./job-apis.md)
35-
- [Reporting APIs](./reporting-apis.md)
32+
6. [APIs Documentation](./api.md)
33+
- [System APIs](api-system.md)
34+
- [Jobs APIs](api-jobs.md)
35+
- [Reporting APIs](api-reporting.md)
3636
7. [Advanced topics](./advanced.md)

‎docs/advanced.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ Here is an except showing the relative priority of job types:
4747
"manual-pr-close": 20,
4848
"automerge": 30,
4949
"main-commit": 40,
50+
"renovate-config-commit": 40,
5051
"installed": 50,
5152
"repositories-added": 60,
5253
"manual-pr-merge": 70,

‎docs/job-apis.md renamed to ‎docs/api-jobs.md

Lines changed: 13 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Job APIs
22

3+
Enabling jobs APIs is done by setting both `MEND_RNV_API_ENABLED: true` and `MEND_RNV_API_ENABLE_JOBS: true` (both are backward compatible with `MEND_RNV_API_ENABLED`)
4+
35
Job Logs APIs provide a summary of and content for the Job Logs generated by the Renovate CLI.
46

57
The Run Job API schedules a Renovate job to run against a given repository.
@@ -17,9 +19,6 @@ The list below describes the available Job Logs APIs. Follow the links on the AP
1719

1820
Job Logs APIs are enabled with Renovate Admin APIs, which is off by default.
1921

20-
The APIs can be enabled by setting the `MEND_RNV_ADMIN_API_ENABLED` environment variable to `true`.
21-
You must also configure an API secret by setting the `MEND_RNV_SERVER_API_SECRET` variable.
22-
2322
Authentication is done via HTTP Auth, using the API secret as the password.
2423
For example if the secret is `renovateapi` then you would authenticate by adding the following request header:
2524

@@ -33,18 +32,17 @@ For example if the secret is `renovateapi` then you would authenticate by adding
3332

3433
See the table below for a list of Job Logs API URL formats.
3534

36-
| API | URL format | Query parameters |
37-
|-------------------------------------------------|--------------------------------------------------------|---------------------------------|
38-
| [List Jobs by Repo](#list-jobs-by-repo) | [GET] /api/repos/{org}/{repo}/-/jobs | limit (default=100, max=10,000) |
39-
| [Get Job Logs by Repo](#get-job-logs-by-repo) | [GET] /api/repos/{org}/{repo}/-/jobs/<latest\|{jobId}> | |
40-
| [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 | |
35+
| API | URL format | Query parameters |
36+
|-------------------------------------------------|-----------------------------------------------------------|---------------------------------|
37+
| [List Jobs by Repo](#list-jobs-by-repo) | [GET] /api/v1/repos/{org}/{repo}/-/jobs | limit (default=100, max=10,000) |
38+
| [Get Job Logs by Repo](#get-job-logs-by-repo) | [GET] /api/v1/repos/{org}/{repo}/-/jobs/<latest\|{jobId}> | |
39+
| [Run Job on a Repo](#run-job-on-a-repo) | [POST] /api/v1/repos/{org}/{repo}/-/jobs/run | |
4240

4341
## Details of Job Logs APIs
4442

4543
### List Jobs by Repo
4644

47-
API: [GET] /api/repos/{org}/{repo}/-/jobs
45+
API: [GET] /api/v1/repos/{org}/{repo}/-/jobs
4846

4947
query parameters:
5048
- limit
@@ -57,7 +55,7 @@ Pagination is not supported. Results are sorted with most recent job first.
5755

5856
**Example:** Fetch job list for repo `my-org/my-repo`
5957

60-
[GET] http://my.renovate.server.com/api/repos/my-org/my-repo/-/jobs (Note: no trailing slash!)
58+
[GET] http://my.renovate.server.com/api/v1/repos/my-org/my-repo/-/jobs (Note: no trailing slash!)
6159

6260
```json
6361
[
@@ -92,7 +90,7 @@ Pagination is not supported. Results are sorted with most recent job first.
9290

9391
### Get Job Logs by Repo
9492

95-
API: [GET] /api/repos/{org}/{repo}/-/jobs/<latest|{jobId}>
93+
API: [GET] /api/v1/repos/{org}/{repo}/-/jobs/<latest|{jobId}>
9694

9795
**Description:** Get the contents of a single job log for a given repo
9896

@@ -103,11 +101,11 @@ Options:
103101

104102
**Example 1:** Fetch latest job logs for repo `my-org/my-repo`
105103

106-
[GET] http://my.renovate.server.com/api/repos/my-org/my-repo/-/jobs/latest
104+
[GET] http://my.renovate.server.com/api/v1/repos/my-org/my-repo/-/jobs/latest
107105

108106
**Example 2:** Fetch job logs for JobID `5a3572bf-49fe-42bb-a066-ff1146fe83d1` in repo `my-org/my-repo`
109107

110-
[GET] http://my.renovate.server.com/api/repos/my-org/my-repo/-/jobs/5a3572bf-49fe-42bb-a066-ff1146fe83d1
108+
[GET] http://my.renovate.server.com/api/v1/repos/my-org/my-repo/-/jobs/5a3572bf-49fe-42bb-a066-ff1146fe83d1
111109

112110
**Sample output:**
113111

@@ -123,32 +121,9 @@ Options:
123121
{"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}
124122
```
125123

126-
### Get Job Logs by JobID
127-
128-
API: [GET] /api/job/logs/{jobId}
129-
130-
**Description:** Returns the job logs for the specified JobID
131-
132-
Note: This returns the same as [Get Job Logs by Repo](#get-job-logs-by-repo) with JobID variation, but conveniently does not require the {org}/{repo} in the API endpoint.
133-
134-
**Example:** Fetch job logs for JobID `5a3572bf-49fe-42bb-a066-ff1146fe83d1`
135-
136-
[GET] http://my.renovate.server.com/api/job/logs/5a3572bf-49fe-42bb-a066-ff1146fe83d1
137-
138-
```json
139-
{"name":"renovate","hostname":"271939e11491","pid":21,"level":20,"logContext":"5a3572bf-49fe-42bb-a066-ff1146fe83d1","config":{},"msg":"File config","time":"2024-05-13T12:41:58.139Z","v":0}
140-
{"name":"renovate","hostname":"271939e11491","pid":21,"level":20,"logContext":"5a3572bf-49fe-42bb-a066-ff1146fe83d1","config":{},"msg":"CLI config","time":"2024-05-13T12:41:58.143Z","v":0}
141-
{"name":"renovate","hostname":"271939e11491","pid":21,"level":20,"logContext":"5a3572bf-49fe-42bb-a066-ff1146fe83d1","config":{},"msg":"Env config","time":"2024-05-13T12:41:58.152Z","v":0}
142-
{"......many rows removed......"}
143-
{"name":"renovate","hostname":"271939e11491","pid":21,"level":20,"logContext":"5a3572bf-49fe-42bb-a066-ff1146fe83d1","repository":"my-org/my-repo","hosts":[],"msg":"dns cache","time":"2024-05-13T12:42:29.346Z","v":0}
144-
{"name":"renovate","hostname":"271939e11491","pid":21,"level":30,"logContext":"5a3572bf-49fe-42bb-a066-ff1146fe83d1","repository":"my-org/my-repo","cloned":false,"durationMs":29063,"msg":"Repository finished","time":"2024-05-13T12:42:29.348Z","v":0}
145-
{"name":"renovate","hostname":"271939e11491","pid":21,"level":20,"logContext":"5a3572bf-49fe-42bb-a066-ff1146fe83d1","msg":"Checking file package cache for expired items","time":"2024-05-13T12:42:29.351Z","v":0}
146-
{"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}
147-
{"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}
148-
```
149124

150125
### Run Job on a Repo
151126

152-
API: [POST] /api/repos/{org}/{repo}/-/jobs/run
127+
API: [POST] /api/v1/repos/{org}/{repo}/-/jobs/run
153128

154129
**Description:** Schedules a job to run Renovate on the given repository

‎docs/reporting-apis.md renamed to ‎docs/api-reporting.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The list below describes the available reporting APIs. Follow the links on the A
2323

2424
## Enable Reporting APIs
2525

26-
To enable reporting APIs, set `MEND_RNV_REPORTING_ENABLED=true` on the CE/EE Server container.
26+
To enable reporting APIs, set both `MEND_RNV_API_ENABLED: true` and `MEND_RNV_API_ENABLE_REPORTING: true` (backward compatible with `MEND_RNV_REPORTING_ENABLED: true`) on the CE/EE Server container.
2727
Reporting APIs are disabled by default.
2828

2929
When Reporting APIs are enabled, relevant data will be collected after every Renovate job and stored locally in the Renovate database.
@@ -41,23 +41,23 @@ The `Repo pull requests` API is available for GitHub only. To enable it, see con
4141

4242
See the table below for a list of reporting API URL formats.
4343

44-
| API | URL format | Query parameters |
45-
|-----------------------------------------------------------------------------------|-------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|
46-
| [Org list](#org-list) | [GET] /api/orgs | state=[active,suspended,installed(active+suspended),uninstalled,all] (default=installed) <br> limit (default=100, max=10,000) |
47-
| [Org info](#org-info)<br/>[Some data Enterprise only] | [GET] /api/orgs/{org} | |
48-
| [Repo list](#repo-list) | [GET] /api/orgs/{org}/-/repos | state=[installed,uninstalled,all] (default=installed) <br> limit (default=100, max=10,000) |
49-
| [Repo info](#repo-info)<br/>[Some data Enterprise only] | [GET] /api/repos/{org}/{repo} | |
50-
| [Repo dashboard](#repo-dashboard)<br/>[Enterprise only] | [GET] /api/repos/{org}/{repo}/-/dashboard | |
51-
| [Repo pull requests](#repo-pull-requests)<br/>[Enterprise only]<br/>[GitHub only] | [GET] /api/repos/{org}/{repo}/-/pulls | state=[open,merged,closed,all] (default=open) <br> limit (default=100, max=10,000) |
52-
| [LibYears - System](#libyears---system)<br/>[Enterprise only] | [GET] /api/orgs/-/libyears | state=[installed,suspended,active] (default=installed) <br> details (default=false) <br> limit (default=100, max=10,000) |
53-
| [LibYears - Org](#libyears---org)<br/>[Enterprise only] | [GET] /api/orgs/{org}/-/libyears | details (default=false) <br> limit (default=100, max=10,000) |
54-
| [LibYears - Repo](#libyears---repo)<br/>[Enterprise only] | [GET] /api/repos/{org}/{repo}/-/libyears | |
44+
| API | URL format | Query parameters |
45+
|-----------------------------------------------------------------------------------|-----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|
46+
| [Org list](#org-list) | [GET] /api/v1/orgs | state=[active,suspended,installed(active+suspended),uninstalled,all] (default=installed) <br> limit (default=100, max=10,000) |
47+
| [Org info](#org-info)<br/>[Some data Enterprise only] | [GET] /api/v1/orgs/{org} | |
48+
| [Repo list](#repo-list) | [GET] /api/v1/orgs/{org}/-/repos | state=[installed,uninstalled,all] (default=installed) <br> limit (default=100, max=10,000) |
49+
| [Repo info](#repo-info)<br/>[Some data Enterprise only] | [GET] /api/v1/repos/{org}/{repo} | |
50+
| [Repo dashboard](#repo-dashboard)<br/>[Enterprise only] | [GET] /api/v1/repos/{org}/{repo}/-/dashboard | |
51+
| [Repo pull requests](#repo-pull-requests)<br/>[Enterprise only]<br/>[GitHub only] | [GET] /api/v1/repos/{org}/{repo}/-/pulls | state=[open,merged,closed,all] (default=open) <br> limit (default=100, max=10,000) |
52+
| [LibYears - System](#libyears---system)<br/>[Enterprise only] | [GET] /api/v1/orgs/-/libyears | state=[installed,suspended,active] (default=installed) <br> details (default=false) <br> limit (default=100, max=10,000) |
53+
| [LibYears - Org](#libyears---org)<br/>[Enterprise only] | [GET] /api/v1/orgs/{org}/-/libyears | details (default=false) <br> limit (default=100, max=10,000) |
54+
| [LibYears - Repo](#libyears---repo)<br/>[Enterprise only] | [GET] /api/v1/repos/{org}/{repo}/-/libyears | |
5555

5656
## Details of Reporting APIs
5757

5858
### Org list
5959

60-
API: [GET] /api/orgs
60+
API: [GET] /api/v1/orgs
6161

6262
query parameters:
6363
- state
@@ -77,11 +77,11 @@ States:
7777

7878
**Example 1:** Fetch a list of all currently installed orgs
7979

80-
[GET] http://my.renovate.server.com/api/orgs
80+
[GET] http://my.renovate.server.com/api/v1/orgs
8181

8282
**Example 2:** Fetch a list of all installed orgs that have turned off Renovate (ie. enabled,suspended)
8383

84-
[GET] http://my.renovate.server.com/api/orgs?state=suspended
84+
[GET] http://my.renovate.server.com/api/v1/orgs?state=suspended
8585

8686
```json
8787
[
@@ -97,15 +97,15 @@ States:
9797

9898
### Org info
9999

100-
API: [GET] /api/orgs/{org}
100+
API: [GET] /api/v1/orgs/{org}
101101

102102
**Description:** Stats for a single org
103103

104104
Note: Summaries for `renovateStatuses` and `pullRequests` are available only with Enterprise Edition
105105

106106
**Example:** Fetch info and stats for org `my-org`
107107

108-
[GET] http://my.renovate.server.com/api/orgs/my-org (Note: no trailing slash!)
108+
[GET] http://my.renovate.server.com/api/v1/orgs/my-org (Note: no trailing slash!)
109109

110110
```json
111111
{
@@ -142,7 +142,7 @@ Note: Summaries for `renovateStatuses` and `pullRequests` are available only wit
142142

143143
### Repo list
144144

145-
API: [GET] /api/orgs/{org}/-/repos
145+
API: [GET] /api/v1/orgs/{org}/-/repos
146146

147147
query parameters:
148148
- state
@@ -156,7 +156,7 @@ query parameters:
156156

157157
**Example:** Fetch a list of all currently installed repos on org `my-org`
158158

159-
[GET] http://my.renovate.server.com/api/orgs/my-org/-/repos
159+
[GET] http://my.renovate.server.com/api/v1/orgs/my-org/-/repos
160160

161161
```json
162162
[
@@ -177,7 +177,7 @@ query parameters:
177177

178178
**Example:** Fetch a list of all repos (installed and uninstalled)
179179

180-
[GET] http://my.renovate.server.com/api/orgs/my-org/-/repos?state=all
180+
[GET] http://my.renovate.server.com/api/v1/orgs/my-org/-/repos?state=all
181181

182182
```json
183183
[
@@ -212,7 +212,7 @@ query parameters:
212212

213213
**Example:** Fetch a list of uninstalled repos for org `my-org`
214214

215-
[GET] http://my.renovate.server.com/api/orgs/my-org/-/repos?state=uninstalled
215+
[GET] http://my.renovate.server.com/api/v1/orgs/my-org/-/repos?state=uninstalled
216216

217217
```json
218218
[
@@ -235,15 +235,15 @@ query parameters:
235235

236236
### Repo info
237237

238-
API: [GET] /api/repos/{org}/{repo}
238+
API: [GET] /api/v1/repos/{org}/{repo}
239239

240240
**Description:** Stats for a single repo
241241

242242
Note: The `status` field and `pullRequestStats` summaries are available only with Enterprise Edition
243243

244244
**Example:** Fetch info and stats for repo `my-org/demo-repo-2`
245245

246-
[GET] http://my.renovate.server.com/api/repos/my-org/demo-repo-2
246+
[GET] http://my.renovate.server.com/api/v1/repos/my-org/demo-repo-2
247247

248248
```json
249249
{
@@ -264,7 +264,7 @@ Note: The `status` field and `pullRequestStats` summaries are available only wit
264264

265265
### Repo dashboard
266266

267-
API: [GET] /api/repos/{org}/{repo}/-/dashboard
267+
API: [GET] /api/v1/repos/{org}/{repo}/-/dashboard
268268

269269
**Description:** Replicates the Dependency Dashboard Issue contents.
270270
Includes:
@@ -276,7 +276,7 @@ Note: Available only with Enterprise Edition. Returns no data when returned from
276276

277277
**Example:** Fetch all Dependency Dashboard information for repo `my-org/demo-repo-2`
278278

279-
[GET] http://my.renovate.server.com/api/repos/my-org/demo-repo-2/-/dashboard
279+
[GET] http://my.renovate.server.com/api/v1/repos/my-org/demo-repo-2/-/dashboard
280280

281281
```json
282282
{
@@ -507,7 +507,7 @@ Note: Available only with Enterprise Edition. Returns no data when returned from
507507
> 2. Requires `RENOVATE_REPOSITORY_CACHE=enabled` set on Worker containers.
508508
> 3. If using S3 repo cache, the `RENOVATE_X_REPO_CACHE_FORCE_LOCAL` must be set on Worker containers.
509509
510-
API: [GET] /api/repos/{org}/{repo}/-/pulls
510+
API: [GET] /api/v1/repos/{org}/{repo}/-/pulls
511511

512512
Note: Available only with Enterprise Edition. Returns no data when returned from Community Edition.
513513

@@ -527,7 +527,7 @@ Pagination is not supported. Results are sorted with most recently updated first
527527

528528
**Example:** Fetch a list of all open pull requests created by Renovate on repo `my-org/demo-repo-2`
529529

530-
[GET] http://my.renovate.server.com/api/repos/my-org/demo-repo-2/-/pulls
530+
[GET] http://my.renovate.server.com/api/v1/repos/my-org/demo-repo-2/-/pulls
531531

532532
```json
533533
[
@@ -569,7 +569,7 @@ Pagination is not supported. Results are sorted with most recently updated first
569569

570570
### LibYears - System
571571

572-
API: [GET] /api/orgs/-/libyears
572+
API: [GET] /api/v1/orgs/-/libyears
573573

574574
**Description:** Returns system-wide libyears statistics across all organizations
575575

@@ -590,7 +590,7 @@ Optional query parameters:
590590

591591
**Example:** Fetch libyears data for all orgs in the system and include details for each org.
592592

593-
[GET] http://my.renovate.server.com/api/orgs/-/libyears?details=true
593+
[GET] http://my.renovate.server.com/api/v1/orgs/-/libyears?details=true
594594

595595
```json
596596
{
@@ -634,7 +634,7 @@ Optional query parameters:
634634

635635
### LibYears - Org
636636

637-
API: [GET] /api/orgs/{org}/-/libyears
637+
API: [GET] /api/v1/orgs/{org}/-/libyears
638638

639639
**Description:** Returns libyears for a specific organization
640640

@@ -656,7 +656,7 @@ Optional query parameters:
656656

657657
**Example:** Fetch libyears data for my-org-1 and include details for each repository.
658658

659-
[GET] http://my.renovate.server.com/api/orgs/my-org-1/-/libyears?details=true
659+
[GET] http://my.renovate.server.com/api/v1/orgs/my-org-1/-/libyears?details=true
660660

661661
```json
662662
{
@@ -717,7 +717,7 @@ Optional query parameters:
717717

718718
### LibYears - Repo
719719

720-
API: [GET] /api/repos/{org}/{repo}/-/libyears
720+
API: [GET] /api/v1/repos/{org}/{repo}/-/libyears
721721

722722
**Description:** Returns libyears statistics for a specific repository
723723

@@ -728,7 +728,7 @@ Path parameters:
728728

729729
**Example:** Fetch libyears data for repository "my-repo-1" in org "my-org-1"
730730

731-
[GET] http://my.renovate.server.com/api/repos/my-org-1/my-repo-1/-/libyears
731+
[GET] http://my.renovate.server.com/api/v1/repos/my-org-1/my-repo-1/-/libyears
732732

733733
```json
734734
{

0 commit comments

Comments
 (0)