Skip to content

Commit

Permalink
Remove the duplicated section in the docs #1524
Browse files Browse the repository at this point in the history
Signed-off-by: tdruez <[email protected]>
  • Loading branch information
tdruez committed Jan 22, 2025
1 parent 84f4f99 commit 05a0e72
Showing 1 changed file with 0 additions and 29 deletions.
29 changes: 0 additions & 29 deletions docs/rest-api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -591,35 +591,6 @@ This action deletes a "not started" or "queued" pipeline run.
XLSX Report
-----------

Generates an XLSX report of selected projects based on the provided criteria.
The model needs to be provided using the ``model`` query parameter.

``GET /api/projects/?model=MODEL``

Data:
- ``model``: ``package``, ``dependency``, ``resource``, ``relation``, ``message``,
``todo``.

**Any available filters can be applied** to **select the set of projects** you want to
include in the report, such as a string contained in the name, or filter by labels:

Example usage:

1. Generate a report for all projects tagged with "d2d" and include the **TODOS**
worksheet::

GET /api/projects/?model=todo&label=d2d


2. Generate a report for projects whose names contain the word "audit" and include the
**PACKAGES** worksheet::

GET /api/projects/?model=package&name__contains=audit


XLSX Report
-----------

Generates an XLSX report for selected projects based on specified criteria. The
``model`` query parameter is required to determine the type of data to include in the
report.
Expand Down

0 comments on commit 05a0e72

Please sign in to comment.