docs: reporting API documentation (#469)

* Added supported platform to the README

* Reporting API Docs

* Reporting API Docs formatting improvements

* Reporting API Docs - added [GET] to URL format

* Reporting API Docs formatting improvements

* Docs index formatting improvements

* Renamed sample org and repos to generic names

* Fixed documentation of query parameter defaults

* Improved section: Enable Reporting APIs

* Updated Note markdown format

* Updated according to code review comments

* Improved formatting

* Increased note severity

* Minor changes to Reporting API documentation

* Minor changes to Reporting API documentation

* Added important note about Reporting APIs supported for PostgresDB only.

* Minor changes to Reporting API documentation

* docs: updated API endpoints for Reporting APIs

docs/README.md

@@ -20,5 +20,7 @@ The following platforms are supported by Mend Renovate Community Edition and Ent
    - Renovate Community Edition - ([GitHub](./configure-renovate-ce-github.md), [GitLab](./configure-renovate-ce-gitlab.md))
    - Renovate Enterprise Edition - ([GitHub](./configure-renovate-ee-github.md), [GitLab](./configure-renovate-ee-gitlab.md))
 1. Migration ([Renovate On-Premises to Renovate Community](./migrating-to-renovate-ce.md))
-1. API ([API Documentation](./api.md))
+1. API Documentation
+   - [Admin APIs](./api.md)
+   - [Reporting APIs](./reporting-apis.md)
 1. [Advanced topics](./advanced.md)

docs/api.md

@@ -57,3 +57,8 @@ The request body must contain a single repository:
 `GET /api/status`
 
 Return the current status of the service since boot time. This information includes job history, job queue size, in-progress jobs, scheduler status, webhook status, Renovate version, and more. All timestamps in the response body are in UTC.
+
+
+## Reporting APIs (Enterprise Only)
+
+See separate ([Reporting APIs documentation](./reporting-apis.md)) for information about the Reporting APIs.