Skip to content

docs(api): pass admin list parameters in a JSON body (15.9) #570

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marevol merged 1 commit into from
Oct 5, 2026
Merged

docs(api): pass admin list parameters in a JSON body (15.9) #570

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions de/15.9/api/admin/api-admin-crawlinginfo.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,16 +208,20 @@ Crawl-Informationen auflisten

.. code-block:: bash

curl -X GET "http://localhost:8080/api/admin/crawlinginfo/logs?size=50&page=1" \
-H "Authorization: Bearer YOUR_TOKEN"
curl -X GET "http://localhost:8080/api/admin/crawlinginfo/logs" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"size": 50, "page": 1}'

Nach einer bestimmten Sitzung filtern
-------------------------------------

.. code-block:: bash

curl -X GET "http://localhost:8080/api/admin/crawlinginfo/logs?sessionId=20250129100000" \
-H "Authorization: Bearer YOUR_TOKEN"
curl -X GET "http://localhost:8080/api/admin/crawlinginfo/logs" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"session_id": "20250129100000"}'

Crawl-Information abrufen
-------------------------
Expand Down
26 changes: 17 additions & 9 deletions de/15.9/api/admin/api-admin-failureurl.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,26 +257,32 @@ Fehlgeschlagene URLs auflisten

.. code-block:: bash

curl -X GET "http://localhost:8080/api/admin/failureurl/logs?size=100&page=1" \
-H "Authorization: Bearer YOUR_TOKEN"
curl -X GET "http://localhost:8080/api/admin/failureurl/logs" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"size": 100, "page": 1}'

Nach Fehleranzahl filtern
-------------------------

.. code-block:: bash

# Nur URLs mit 3 oder mehr Fehlern abrufen
curl -X GET "http://localhost:8080/api/admin/failureurl/logs?errorCountMin=3" \
-H "Authorization: Bearer YOUR_TOKEN"
curl -X GET "http://localhost:8080/api/admin/failureurl/logs" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"error_count_min": 3}'

Nach Fehlername filtern
-----------------------

.. code-block:: bash

# errorName speichert den vollständig qualifizierten Klassennamen, daher mit Wildcard angeben
curl -X GET "http://localhost:8080/api/admin/failureurl/logs?errorName=*ConnectException" \
-H "Authorization: Bearer YOUR_TOKEN"
# error_name speichert den vollständig qualifizierten Klassennamen, daher mit Wildcard angeben
curl -X GET "http://localhost:8080/api/admin/failureurl/logs" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"error_name": "*ConnectException"}'

Fehlgeschlagene URL abrufen
---------------------------
Expand Down Expand Up @@ -308,8 +314,10 @@ Nach Fehlertyp aggregieren
.. code-block:: bash

# Anzahl nach Fehlertyp zählen
curl -X GET "http://localhost:8080/api/admin/failureurl/logs?size=1000" \
-H "Authorization: Bearer YOUR_TOKEN" | \
curl -X GET "http://localhost:8080/api/admin/failureurl/logs" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"size": 1000}' | \
jq '[.response.logs[].error_name] | group_by(.) | map({error: .[0], count: length})'

Referenzinformationen
Expand Down
22 changes: 14 additions & 8 deletions de/15.9/api/admin/api-admin-joblog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,18 +206,22 @@ Job-Protokolle auflisten

.. code-block:: bash

curl -X GET "http://localhost:8080/api/admin/joblog/logs?size=50&page=1" \
-H "Authorization: Bearer YOUR_TOKEN"
curl -X GET "http://localhost:8080/api/admin/joblog/logs" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"size": 50, "page": 1}'

Nur fehlgeschlagene Jobs filtern
---------------------------------

.. code-block:: bash

# Fehlgeschlagene Jobs mit jq filtern
curl -X GET "http://localhost:8080/api/admin/joblog/logs?size=1000" \
-H "Authorization: Bearer YOUR_TOKEN" | \
jq '.response.logs[] | select(.jobStatus=="fail")'
curl -X GET "http://localhost:8080/api/admin/joblog/logs" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"size": 1000}' | \
jq '.response.logs[] | select(.job_status=="fail")'

Job-Protokoll abrufen
---------------------
Expand All @@ -240,9 +244,11 @@ Job-Erfolgsrate berechnen

.. code-block:: bash

curl -X GET "http://localhost:8080/api/admin/joblog/logs?size=1000" \
-H "Authorization: Bearer YOUR_TOKEN" | \
jq '.response.logs | {total: length, ok: [.[] | select(.jobStatus=="ok")] | length, fail: [.[] | select(.jobStatus=="fail")] | length}'
curl -X GET "http://localhost:8080/api/admin/joblog/logs" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"size": 1000}' | \
jq '.response.logs | {total: length, ok: [.[] | select(.job_status=="ok")] | length, fail: [.[] | select(.job_status=="fail")] | length}'

Referenzinformationen
=====================
Expand Down
6 changes: 4 additions & 2 deletions de/15.9/api/admin/api-admin-labeltype.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -351,8 +351,10 @@ Label-Typ-Liste abrufen

.. code-block:: bash

curl "http://localhost:8080/api/admin/labeltype/settings?size=50&page=1" \
-H "Authorization: Bearer YOUR_TOKEN"
curl -X GET "http://localhost:8080/api/admin/labeltype/settings" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"size": 50, "page": 1}'

Suche mit Label-Typ
-------------------
Expand Down
8 changes: 6 additions & 2 deletions de/15.9/api/admin/api-admin-overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,8 @@ Parameter (Paginierung):
- Integer
- Seitennummer (beginnt bei 1; Standard: 1; Werte <= 0 werden als 1 behandelt)

Diese Parameter sowie die Filterparameter der einzelnen Ressourcen werden in einem JSON-Request-Body mit Schlüsseln in snake_case angegeben (z. B. ``{"size": 50, "page": 1}``). Werte im Query-String der URL werden ignoriert.

Response
~~~~~~~~

Expand Down Expand Up @@ -549,8 +551,10 @@ Benutzerliste abrufen

.. code-block:: bash

curl "http://localhost:8080/api/admin/user/settings?size=50&page=1" \
-H "Authorization: Bearer YOUR_TOKEN"
curl -X GET "http://localhost:8080/api/admin/user/settings" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"size": 50, "page": 1}'

Referenzinformationen
=====================
Expand Down
6 changes: 4 additions & 2 deletions de/15.9/api/admin/api-admin-role.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,8 +276,10 @@ Rollenliste abrufen

.. code-block:: bash

curl -X GET "http://localhost:8080/api/admin/role/settings?size=50&page=1" \
-H "Authorization: Bearer YOUR_TOKEN"
curl -X GET "http://localhost:8080/api/admin/role/settings" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"size": 50, "page": 1}'

Referenzinformationen
=====================
Expand Down
12 changes: 8 additions & 4 deletions de/15.9/api/admin/api-admin-searchlist.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -547,8 +547,10 @@ Dokumente suchen

.. code-block:: bash

curl -X GET "http://localhost:8080/api/admin/searchlist/docs?q=Fess&size=20" \
-H "Authorization: Bearer YOUR_TOKEN"
curl -X GET "http://localhost:8080/api/admin/searchlist/docs" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"q": "Fess", "size": 20}'

Dokument abrufen
----------------
Expand Down Expand Up @@ -581,8 +583,10 @@ Dokumente per Query löschen

.. code-block:: bash

curl -X DELETE "http://localhost:8080/api/admin/searchlist/query?q=url:example.com" \
-H "Authorization: Bearer YOUR_TOKEN"
curl -X DELETE "http://localhost:8080/api/admin/searchlist/query" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"q": "url:example.com"}'

Referenzinformationen
=====================
Expand Down
6 changes: 4 additions & 2 deletions de/15.9/api/admin/api-admin-tagtype.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -387,8 +387,10 @@ Die Tags eines Benutzers auflisten

.. code-block:: bash

curl "http://localhost:8080/api/admin/tagtype/settings?owner=alice&size=50&page=1" \
-H "Authorization: Bearer YOUR_TOKEN"
curl -X GET "http://localhost:8080/api/admin/tagtype/settings" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"owner": "alice", "size": 50, "page": 1}'

Siehe auch
==========
Expand Down
12 changes: 8 additions & 4 deletions en/15.9/api/admin/api-admin-crawlinginfo.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,16 +208,20 @@ List Crawl Information

.. code-block:: bash

curl -X GET "http://localhost:8080/api/admin/crawlinginfo/logs?size=50&page=1" \
-H "Authorization: Bearer YOUR_TOKEN"
curl -X GET "http://localhost:8080/api/admin/crawlinginfo/logs" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"size": 50, "page": 1}'

Filter by Specific Session
--------------------------

.. code-block:: bash

curl -X GET "http://localhost:8080/api/admin/crawlinginfo/logs?sessionId=20250129100000" \
-H "Authorization: Bearer YOUR_TOKEN"
curl -X GET "http://localhost:8080/api/admin/crawlinginfo/logs" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"session_id": "20250129100000"}'

Get Crawl Information
---------------------
Expand Down
26 changes: 17 additions & 9 deletions en/15.9/api/admin/api-admin-failureurl.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,26 +260,32 @@ List Failure URLs

.. code-block:: bash

curl -X GET "http://localhost:8080/api/admin/failureurl/logs?size=100&page=1" \
-H "Authorization: Bearer YOUR_TOKEN"
curl -X GET "http://localhost:8080/api/admin/failureurl/logs" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"size": 100, "page": 1}'

Filter by Error Count
---------------------

.. code-block:: bash

# Get only URLs with 3 or more errors
curl -X GET "http://localhost:8080/api/admin/failureurl/logs?errorCountMin=3" \
-H "Authorization: Bearer YOUR_TOKEN"
curl -X GET "http://localhost:8080/api/admin/failureurl/logs" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"error_count_min": 3}'

Filter by Error Name
--------------------

.. code-block:: bash

# errorName stores the fully-qualified class name, so specify it with a wildcard
curl -X GET "http://localhost:8080/api/admin/failureurl/logs?errorName=*ConnectException" \
-H "Authorization: Bearer YOUR_TOKEN"
# error_name stores the fully-qualified class name, so specify it with a wildcard
curl -X GET "http://localhost:8080/api/admin/failureurl/logs" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"error_name": "*ConnectException"}'

Get Failure URL
---------------
Expand Down Expand Up @@ -311,8 +317,10 @@ Aggregate by Error Type
.. code-block:: bash

# Count by error type
curl -X GET "http://localhost:8080/api/admin/failureurl/logs?size=1000" \
-H "Authorization: Bearer YOUR_TOKEN" | \
curl -X GET "http://localhost:8080/api/admin/failureurl/logs" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"size": 1000}' | \
jq '[.response.logs[].error_name] | group_by(.) | map({error: .[0], count: length})'

Reference
Expand Down
22 changes: 14 additions & 8 deletions en/15.9/api/admin/api-admin-joblog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,18 +207,22 @@ List Job Logs

.. code-block:: bash

curl -X GET "http://localhost:8080/api/admin/joblog/logs?size=50&page=1" \
-H "Authorization: Bearer YOUR_TOKEN"
curl -X GET "http://localhost:8080/api/admin/joblog/logs" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"size": 50, "page": 1}'

Extract Failed Jobs Only
------------------------

.. code-block:: bash

# Filter failed jobs with jq
curl -X GET "http://localhost:8080/api/admin/joblog/logs?size=1000" \
-H "Authorization: Bearer YOUR_TOKEN" | \
jq '.response.logs[] | select(.jobStatus=="fail")'
curl -X GET "http://localhost:8080/api/admin/joblog/logs" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"size": 1000}' | \
jq '.response.logs[] | select(.job_status=="fail")'

Get Job Log
-----------
Expand All @@ -241,9 +245,11 @@ Calculate Job Success Rate

.. code-block:: bash

curl -X GET "http://localhost:8080/api/admin/joblog/logs?size=1000" \
-H "Authorization: Bearer YOUR_TOKEN" | \
jq '.response.logs | {total: length, ok: [.[] | select(.jobStatus=="ok")] | length, fail: [.[] | select(.jobStatus=="fail")] | length}'
curl -X GET "http://localhost:8080/api/admin/joblog/logs" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"size": 1000}' | \
jq '.response.logs | {total: length, ok: [.[] | select(.job_status=="ok")] | length, fail: [.[] | select(.job_status=="fail")] | length}'

Reference
=========
Expand Down
6 changes: 4 additions & 2 deletions en/15.9/api/admin/api-admin-labeltype.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -349,8 +349,10 @@ List Label Types

.. code-block:: bash

curl "http://localhost:8080/api/admin/labeltype/settings?size=50&page=1" \
-H "Authorization: Bearer YOUR_TOKEN"
curl -X GET "http://localhost:8080/api/admin/labeltype/settings" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"size": 50, "page": 1}'

Search with Label
-----------------
Expand Down
8 changes: 6 additions & 2 deletions en/15.9/api/admin/api-admin-overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,8 @@ Parameters (pagination):
- Integer
- Page number (starts from 1. Default: 1. Values of 0 or less are treated as 1)

Specify these parameters, and the filter parameters of each resource, in a JSON request body with snake_case keys (for example, ``{"size": 50, "page": 1}``). Values given in the URL query string are ignored.

Response
~~~~~~~~

Expand Down Expand Up @@ -551,8 +553,10 @@ List Users

.. code-block:: bash

curl "http://localhost:8080/api/admin/user/settings?size=50&page=1" \
-H "Authorization: Bearer YOUR_TOKEN"
curl -X GET "http://localhost:8080/api/admin/user/settings" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"size": 50, "page": 1}'

Reference
=========
Expand Down
6 changes: 4 additions & 2 deletions en/15.9/api/admin/api-admin-role.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,8 +276,10 @@ List Roles

.. code-block:: bash

curl -X GET "http://localhost:8080/api/admin/role/settings?size=50&page=1" \
-H "Authorization: Bearer YOUR_TOKEN"
curl -X GET "http://localhost:8080/api/admin/role/settings" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"size": 50, "page": 1}'

Reference
=========
Expand Down
Loading
Loading