From ed3da3279fc7910f5e3f48f94badad2232ceb06e Mon Sep 17 00:00:00 2001 From: Shinsuke Sugaya Date: Mon, 5 Oct 2026 08:39:15 +0900 Subject: [PATCH] docs(api): pass admin list parameters in a JSON body (15.9) The admin list endpoints read their paging and filter parameters only from a JSON request body with snake_case keys. Parameters in the URL query string are ignored. Rewrite the curl examples that used the query string, fix the jq filters on job_status, and add a note to the Admin API overview. --- de/15.9/api/admin/api-admin-crawlinginfo.rst | 12 ++++++--- de/15.9/api/admin/api-admin-failureurl.rst | 26 ++++++++++++------- de/15.9/api/admin/api-admin-joblog.rst | 22 ++++++++++------ de/15.9/api/admin/api-admin-labeltype.rst | 6 +++-- de/15.9/api/admin/api-admin-overview.rst | 8 ++++-- de/15.9/api/admin/api-admin-role.rst | 6 +++-- de/15.9/api/admin/api-admin-searchlist.rst | 12 ++++++--- de/15.9/api/admin/api-admin-tagtype.rst | 6 +++-- en/15.9/api/admin/api-admin-crawlinginfo.rst | 12 ++++++--- en/15.9/api/admin/api-admin-failureurl.rst | 26 ++++++++++++------- en/15.9/api/admin/api-admin-joblog.rst | 22 ++++++++++------ en/15.9/api/admin/api-admin-labeltype.rst | 6 +++-- en/15.9/api/admin/api-admin-overview.rst | 8 ++++-- en/15.9/api/admin/api-admin-role.rst | 6 +++-- en/15.9/api/admin/api-admin-searchlist.rst | 12 ++++++--- en/15.9/api/admin/api-admin-tagtype.rst | 6 +++-- es/15.9/api/admin/api-admin-crawlinginfo.rst | 12 ++++++--- es/15.9/api/admin/api-admin-failureurl.rst | 26 ++++++++++++------- es/15.9/api/admin/api-admin-joblog.rst | 22 ++++++++++------ es/15.9/api/admin/api-admin-labeltype.rst | 6 +++-- es/15.9/api/admin/api-admin-overview.rst | 8 ++++-- es/15.9/api/admin/api-admin-role.rst | 6 +++-- es/15.9/api/admin/api-admin-searchlist.rst | 12 ++++++--- es/15.9/api/admin/api-admin-tagtype.rst | 6 +++-- fr/15.9/api/admin/api-admin-crawlinginfo.rst | 12 ++++++--- fr/15.9/api/admin/api-admin-failureurl.rst | 26 ++++++++++++------- fr/15.9/api/admin/api-admin-joblog.rst | 22 ++++++++++------ fr/15.9/api/admin/api-admin-labeltype.rst | 6 +++-- fr/15.9/api/admin/api-admin-overview.rst | 8 ++++-- fr/15.9/api/admin/api-admin-role.rst | 6 +++-- fr/15.9/api/admin/api-admin-searchlist.rst | 12 ++++++--- fr/15.9/api/admin/api-admin-tagtype.rst | 6 +++-- ja/15.9/api/admin/api-admin-crawlinginfo.rst | 12 ++++++--- ja/15.9/api/admin/api-admin-failureurl.rst | 26 ++++++++++++------- ja/15.9/api/admin/api-admin-joblog.rst | 22 ++++++++++------ ja/15.9/api/admin/api-admin-labeltype.rst | 6 +++-- ja/15.9/api/admin/api-admin-overview.rst | 8 ++++-- ja/15.9/api/admin/api-admin-role.rst | 6 +++-- ja/15.9/api/admin/api-admin-searchlist.rst | 12 ++++++--- ja/15.9/api/admin/api-admin-tagtype.rst | 6 +++-- ko/15.9/api/admin/api-admin-crawlinginfo.rst | 12 ++++++--- ko/15.9/api/admin/api-admin-failureurl.rst | 26 ++++++++++++------- ko/15.9/api/admin/api-admin-joblog.rst | 22 ++++++++++------ ko/15.9/api/admin/api-admin-labeltype.rst | 6 +++-- ko/15.9/api/admin/api-admin-overview.rst | 8 ++++-- ko/15.9/api/admin/api-admin-role.rst | 6 +++-- ko/15.9/api/admin/api-admin-searchlist.rst | 12 ++++++--- ko/15.9/api/admin/api-admin-tagtype.rst | 6 +++-- .../15.9/api/admin/api-admin-crawlinginfo.rst | 12 ++++++--- zh-cn/15.9/api/admin/api-admin-failureurl.rst | 26 ++++++++++++------- zh-cn/15.9/api/admin/api-admin-joblog.rst | 22 ++++++++++------ zh-cn/15.9/api/admin/api-admin-labeltype.rst | 6 +++-- zh-cn/15.9/api/admin/api-admin-overview.rst | 8 ++++-- zh-cn/15.9/api/admin/api-admin-role.rst | 6 +++-- zh-cn/15.9/api/admin/api-admin-searchlist.rst | 12 ++++++--- zh-cn/15.9/api/admin/api-admin-tagtype.rst | 6 +++-- 56 files changed, 455 insertions(+), 231 deletions(-) diff --git a/de/15.9/api/admin/api-admin-crawlinginfo.rst b/de/15.9/api/admin/api-admin-crawlinginfo.rst index 42090874..d44c4dd3 100644 --- a/de/15.9/api/admin/api-admin-crawlinginfo.rst +++ b/de/15.9/api/admin/api-admin-crawlinginfo.rst @@ -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 ------------------------- diff --git a/de/15.9/api/admin/api-admin-failureurl.rst b/de/15.9/api/admin/api-admin-failureurl.rst index 6bad72ec..89c661d9 100644 --- a/de/15.9/api/admin/api-admin-failureurl.rst +++ b/de/15.9/api/admin/api-admin-failureurl.rst @@ -257,8 +257,10 @@ 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 ------------------------- @@ -266,17 +268,21 @@ 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 --------------------------- @@ -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 diff --git a/de/15.9/api/admin/api-admin-joblog.rst b/de/15.9/api/admin/api-admin-joblog.rst index e19064ea..a828155a 100644 --- a/de/15.9/api/admin/api-admin-joblog.rst +++ b/de/15.9/api/admin/api-admin-joblog.rst @@ -206,8 +206,10 @@ 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 --------------------------------- @@ -215,9 +217,11 @@ 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 --------------------- @@ -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 ===================== diff --git a/de/15.9/api/admin/api-admin-labeltype.rst b/de/15.9/api/admin/api-admin-labeltype.rst index 2481b264..bbbf9ca4 100644 --- a/de/15.9/api/admin/api-admin-labeltype.rst +++ b/de/15.9/api/admin/api-admin-labeltype.rst @@ -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 ------------------- diff --git a/de/15.9/api/admin/api-admin-overview.rst b/de/15.9/api/admin/api-admin-overview.rst index cea1f594..c5a5b952 100644 --- a/de/15.9/api/admin/api-admin-overview.rst +++ b/de/15.9/api/admin/api-admin-overview.rst @@ -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 ~~~~~~~~ @@ -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 ===================== diff --git a/de/15.9/api/admin/api-admin-role.rst b/de/15.9/api/admin/api-admin-role.rst index 6c6ae696..75e29fd1 100644 --- a/de/15.9/api/admin/api-admin-role.rst +++ b/de/15.9/api/admin/api-admin-role.rst @@ -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 ===================== diff --git a/de/15.9/api/admin/api-admin-searchlist.rst b/de/15.9/api/admin/api-admin-searchlist.rst index 8c3a4d01..010b5d7a 100644 --- a/de/15.9/api/admin/api-admin-searchlist.rst +++ b/de/15.9/api/admin/api-admin-searchlist.rst @@ -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 ---------------- @@ -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 ===================== diff --git a/de/15.9/api/admin/api-admin-tagtype.rst b/de/15.9/api/admin/api-admin-tagtype.rst index 6f4fddc1..1bb99cdb 100644 --- a/de/15.9/api/admin/api-admin-tagtype.rst +++ b/de/15.9/api/admin/api-admin-tagtype.rst @@ -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 ========== diff --git a/en/15.9/api/admin/api-admin-crawlinginfo.rst b/en/15.9/api/admin/api-admin-crawlinginfo.rst index 633b2e1a..bef3d788 100644 --- a/en/15.9/api/admin/api-admin-crawlinginfo.rst +++ b/en/15.9/api/admin/api-admin-crawlinginfo.rst @@ -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 --------------------- diff --git a/en/15.9/api/admin/api-admin-failureurl.rst b/en/15.9/api/admin/api-admin-failureurl.rst index ec1ab7c5..da0f0b79 100644 --- a/en/15.9/api/admin/api-admin-failureurl.rst +++ b/en/15.9/api/admin/api-admin-failureurl.rst @@ -260,8 +260,10 @@ 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 --------------------- @@ -269,17 +271,21 @@ 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 --------------- @@ -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 diff --git a/en/15.9/api/admin/api-admin-joblog.rst b/en/15.9/api/admin/api-admin-joblog.rst index 091794c8..8ea21acb 100644 --- a/en/15.9/api/admin/api-admin-joblog.rst +++ b/en/15.9/api/admin/api-admin-joblog.rst @@ -207,8 +207,10 @@ 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 ------------------------ @@ -216,9 +218,11 @@ 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 ----------- @@ -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 ========= diff --git a/en/15.9/api/admin/api-admin-labeltype.rst b/en/15.9/api/admin/api-admin-labeltype.rst index 293b2e6f..38593f77 100644 --- a/en/15.9/api/admin/api-admin-labeltype.rst +++ b/en/15.9/api/admin/api-admin-labeltype.rst @@ -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 ----------------- diff --git a/en/15.9/api/admin/api-admin-overview.rst b/en/15.9/api/admin/api-admin-overview.rst index a2209441..3d5c20ce 100644 --- a/en/15.9/api/admin/api-admin-overview.rst +++ b/en/15.9/api/admin/api-admin-overview.rst @@ -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 ~~~~~~~~ @@ -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 ========= diff --git a/en/15.9/api/admin/api-admin-role.rst b/en/15.9/api/admin/api-admin-role.rst index 6cbae35d..94b97dd1 100644 --- a/en/15.9/api/admin/api-admin-role.rst +++ b/en/15.9/api/admin/api-admin-role.rst @@ -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 ========= diff --git a/en/15.9/api/admin/api-admin-searchlist.rst b/en/15.9/api/admin/api-admin-searchlist.rst index 729acd2e..53479ddc 100644 --- a/en/15.9/api/admin/api-admin-searchlist.rst +++ b/en/15.9/api/admin/api-admin-searchlist.rst @@ -547,8 +547,10 @@ Search Documents .. 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}' Get Document ------------ @@ -581,8 +583,10 @@ Delete Documents by Query .. 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"}' Reference ========= diff --git a/en/15.9/api/admin/api-admin-tagtype.rst b/en/15.9/api/admin/api-admin-tagtype.rst index 5cf1a44a..3ed13cbb 100644 --- a/en/15.9/api/admin/api-admin-tagtype.rst +++ b/en/15.9/api/admin/api-admin-tagtype.rst @@ -382,8 +382,10 @@ List the Tags of a User .. 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}' See Also ======== diff --git a/es/15.9/api/admin/api-admin-crawlinginfo.rst b/es/15.9/api/admin/api-admin-crawlinginfo.rst index d90e8c63..3eb5b4b5 100644 --- a/es/15.9/api/admin/api-admin-crawlinginfo.rst +++ b/es/15.9/api/admin/api-admin-crawlinginfo.rst @@ -206,16 +206,20 @@ Obtener Lista de Información de Rastreo .. 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}' Filtrar por Sesión Específica ----------------------------- .. 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"}' Obtener Información de Rastreo ------------------------------ diff --git a/es/15.9/api/admin/api-admin-failureurl.rst b/es/15.9/api/admin/api-admin-failureurl.rst index d47de00f..803f1fc4 100644 --- a/es/15.9/api/admin/api-admin-failureurl.rst +++ b/es/15.9/api/admin/api-admin-failureurl.rst @@ -257,8 +257,10 @@ Obtener Lista de URLs Fallidas .. 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}' Filtrar por Número de Errores ----------------------------- @@ -266,17 +268,21 @@ Filtrar por Número de Errores .. code-block:: bash # Obtener solo URLs con 3 o mas errores - 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}' Filtrar por Nombre de Error --------------------------- .. code-block:: bash - # errorName almacena el nombre de clase completamente calificado, por lo que debe especificarse con un comodin - curl -X GET "http://localhost:8080/api/admin/failureurl/logs?errorName=*ConnectException" \ - -H "Authorization: Bearer YOUR_TOKEN" + # error_name almacena el nombre de clase completamente calificado, por lo que debe especificarse con un comodin + curl -X GET "http://localhost:8080/api/admin/failureurl/logs" \ + -H "Authorization: Bearer YOUR_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{"error_name": "*ConnectException"}' Obtener URL Fallida ------------------- @@ -308,8 +314,10 @@ Agregación por Tipo de Error .. code-block:: bash # Contar por tipo de error - 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})' Información de Referencia diff --git a/es/15.9/api/admin/api-admin-joblog.rst b/es/15.9/api/admin/api-admin-joblog.rst index 982c9566..16226274 100644 --- a/es/15.9/api/admin/api-admin-joblog.rst +++ b/es/15.9/api/admin/api-admin-joblog.rst @@ -207,8 +207,10 @@ Obtener Lista de Registros de Trabajos .. 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}' Extraer Solo Trabajos Fallidos ------------------------------ @@ -216,9 +218,11 @@ Extraer Solo Trabajos Fallidos .. code-block:: bash # Filtrar trabajos fallidos con 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")' Obtener Registro de Trabajo ---------------------------- @@ -241,9 +245,11 @@ Calcular Tasa de Éxito de Trabajos .. 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}' Información de Referencia ========================= diff --git a/es/15.9/api/admin/api-admin-labeltype.rst b/es/15.9/api/admin/api-admin-labeltype.rst index 0cd89cea..0db6ee23 100644 --- a/es/15.9/api/admin/api-admin-labeltype.rst +++ b/es/15.9/api/admin/api-admin-labeltype.rst @@ -350,8 +350,10 @@ Obtener lista de tipos de etiqueta .. 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}' Búsqueda usando etiqueta ------------------------ diff --git a/es/15.9/api/admin/api-admin-overview.rst b/es/15.9/api/admin/api-admin-overview.rst index 79e7ab26..1a5cdbd6 100644 --- a/es/15.9/api/admin/api-admin-overview.rst +++ b/es/15.9/api/admin/api-admin-overview.rst @@ -124,6 +124,8 @@ Parámetros (paginación): - Integer - Número de página (comienza en 1. Predeterminado: 1. Si se especifica un valor menor o igual a 0, se trata como 1) +Estos parámetros, y los parámetros de filtro de cada recurso, se especifican en un cuerpo de solicitud JSON con claves en snake_case (por ejemplo, ``{"size": 50, "page": 1}``). Los valores indicados en la cadena de consulta de la URL se ignoran. + Respuesta ~~~~~~~~~ @@ -550,8 +552,10 @@ Obtener Lista de Usuarios .. 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}' Información de Referencia ========================= diff --git a/es/15.9/api/admin/api-admin-role.rst b/es/15.9/api/admin/api-admin-role.rst index c8a90421..2cc7d330 100644 --- a/es/15.9/api/admin/api-admin-role.rst +++ b/es/15.9/api/admin/api-admin-role.rst @@ -276,8 +276,10 @@ Obtener Lista de 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}' Información de Referencia ========================= diff --git a/es/15.9/api/admin/api-admin-searchlist.rst b/es/15.9/api/admin/api-admin-searchlist.rst index 26fc5c5f..0430e830 100644 --- a/es/15.9/api/admin/api-admin-searchlist.rst +++ b/es/15.9/api/admin/api-admin-searchlist.rst @@ -547,8 +547,10 @@ Buscar Documentos .. 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}' Obtener Documento ----------------- @@ -581,8 +583,10 @@ Eliminar Documentos por Consulta .. 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"}' Información de Referencia ========================= diff --git a/es/15.9/api/admin/api-admin-tagtype.rst b/es/15.9/api/admin/api-admin-tagtype.rst index 44e70316..9a0d0227 100644 --- a/es/15.9/api/admin/api-admin-tagtype.rst +++ b/es/15.9/api/admin/api-admin-tagtype.rst @@ -388,8 +388,10 @@ Obtener las etiquetas de un usuario .. 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}' Véase también ============= diff --git a/fr/15.9/api/admin/api-admin-crawlinginfo.rst b/fr/15.9/api/admin/api-admin-crawlinginfo.rst index a4ee5179..54e47b9c 100644 --- a/fr/15.9/api/admin/api-admin-crawlinginfo.rst +++ b/fr/15.9/api/admin/api-admin-crawlinginfo.rst @@ -206,16 +206,20 @@ Obtention de la liste des informations de crawl .. 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}' Filtrage par session spécifique ------------------------------- .. 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"}' Obtention d'une information de crawl ------------------------------------ diff --git a/fr/15.9/api/admin/api-admin-failureurl.rst b/fr/15.9/api/admin/api-admin-failureurl.rst index de15855c..de9cc9bd 100644 --- a/fr/15.9/api/admin/api-admin-failureurl.rst +++ b/fr/15.9/api/admin/api-admin-failureurl.rst @@ -257,8 +257,10 @@ Obtention de la liste des URLs en échec .. 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}' Filtrage par nombre d'erreurs ----------------------------- @@ -266,17 +268,21 @@ Filtrage par nombre d'erreurs .. code-block:: bash # Obtenir uniquement les URLs ayant echoue 3 fois ou plus - 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}' Filtrage par nom d'erreur ------------------------- .. code-block:: bash - # errorName contient le nom de classe complet ; specifier avec un caractere generique - curl -X GET "http://localhost:8080/api/admin/failureurl/logs?errorName=*ConnectException" \ - -H "Authorization: Bearer YOUR_TOKEN" + # error_name contient le nom de classe complet ; specifier avec un caractere generique + curl -X GET "http://localhost:8080/api/admin/failureurl/logs" \ + -H "Authorization: Bearer YOUR_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{"error_name": "*ConnectException"}' Obtention d'une URL en échec ---------------------------- @@ -308,8 +314,10 @@ Agrégation par type d'erreur .. code-block:: bash # Compter par type d'erreur - 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})' Informations complémentaires diff --git a/fr/15.9/api/admin/api-admin-joblog.rst b/fr/15.9/api/admin/api-admin-joblog.rst index e77f7fac..08322774 100644 --- a/fr/15.9/api/admin/api-admin-joblog.rst +++ b/fr/15.9/api/admin/api-admin-joblog.rst @@ -206,8 +206,10 @@ Obtention de la liste des journaux de tâches .. 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}' Extraction des tâches en échec uniquement ----------------------------------------- @@ -215,9 +217,11 @@ Extraction des tâches en échec uniquement .. code-block:: bash # Filtrer les taches en echec avec 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")' Obtention d'un journal de tâche -------------------------------- @@ -240,9 +244,11 @@ Calcul du taux de réussite des tâches .. 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}' Informations complémentaires ============================ diff --git a/fr/15.9/api/admin/api-admin-labeltype.rst b/fr/15.9/api/admin/api-admin-labeltype.rst index ba4395b3..2ec5dbfd 100644 --- a/fr/15.9/api/admin/api-admin-labeltype.rst +++ b/fr/15.9/api/admin/api-admin-labeltype.rst @@ -352,8 +352,10 @@ Obtention de la liste des types de labels .. 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}' Recherche avec un label ------------------------ diff --git a/fr/15.9/api/admin/api-admin-overview.rst b/fr/15.9/api/admin/api-admin-overview.rst index e64b9f48..d3e5a3c9 100644 --- a/fr/15.9/api/admin/api-admin-overview.rst +++ b/fr/15.9/api/admin/api-admin-overview.rst @@ -116,6 +116,8 @@ Paramètres (pagination) : - Integer - Numéro de page (commence à 1 ; par défaut : 1 ; une valeur inférieure ou égale à 0 est traitée comme 1) +Ces paramètres, ainsi que les paramètres de filtre de chaque ressource, se spécifient dans un corps de requête JSON avec des clés en snake_case (par exemple ``{"size": 50, "page": 1}``). Les valeurs passées dans la chaîne de requête de l'URL sont ignorées. + Réponse ~~~~~~~ @@ -554,8 +556,10 @@ Obtention de la liste des utilisateurs .. 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}' Informations complémentaires =============================== diff --git a/fr/15.9/api/admin/api-admin-role.rst b/fr/15.9/api/admin/api-admin-role.rst index 23bb73ed..7741b68f 100644 --- a/fr/15.9/api/admin/api-admin-role.rst +++ b/fr/15.9/api/admin/api-admin-role.rst @@ -276,8 +276,10 @@ Obtention de la liste des rôles .. 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}' Informations complémentaires ============================ diff --git a/fr/15.9/api/admin/api-admin-searchlist.rst b/fr/15.9/api/admin/api-admin-searchlist.rst index 41db6703..48de5f89 100644 --- a/fr/15.9/api/admin/api-admin-searchlist.rst +++ b/fr/15.9/api/admin/api-admin-searchlist.rst @@ -547,8 +547,10 @@ Recherche de documents .. 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}' Obtention d'un document ----------------------- @@ -581,8 +583,10 @@ Suppression de documents par requête .. 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"}' Informations complémentaires ============================= diff --git a/fr/15.9/api/admin/api-admin-tagtype.rst b/fr/15.9/api/admin/api-admin-tagtype.rst index a6f98259..4cb9801b 100644 --- a/fr/15.9/api/admin/api-admin-tagtype.rst +++ b/fr/15.9/api/admin/api-admin-tagtype.rst @@ -387,8 +387,10 @@ Obtention des tags d'un utilisateur .. 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}' Informations complémentaires ============================ diff --git a/ja/15.9/api/admin/api-admin-crawlinginfo.rst b/ja/15.9/api/admin/api-admin-crawlinginfo.rst index 6d72cc1d..d99f18be 100644 --- a/ja/15.9/api/admin/api-admin-crawlinginfo.rst +++ b/ja/15.9/api/admin/api-admin-crawlinginfo.rst @@ -207,16 +207,20 @@ CrawlingInfo APIは、|Fess| のクロール情報（クロールセッション .. 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}' 特定セッションでフィルター -------------------------- .. 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"}' クロール情報の取得 ------------------ diff --git a/ja/15.9/api/admin/api-admin-failureurl.rst b/ja/15.9/api/admin/api-admin-failureurl.rst index a68e073a..08cf4f7a 100644 --- a/ja/15.9/api/admin/api-admin-failureurl.rst +++ b/ja/15.9/api/admin/api-admin-failureurl.rst @@ -260,8 +260,10 @@ FailureUrl APIは、|Fess| のクロール障害URLを管理するためのAPI .. 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}' エラー回数でフィルター ---------------------- @@ -269,17 +271,21 @@ FailureUrl APIは、|Fess| のクロール障害URLを管理するためのAPI .. code-block:: bash # 3回以上エラーが発生したURLのみ取得 - 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}' エラー名でフィルター -------------------- .. code-block:: bash - # errorName には完全修飾クラス名が格納されるため、ワイルドカードで指定する - curl -X GET "http://localhost:8080/api/admin/failureurl/logs?errorName=*ConnectException" \ - -H "Authorization: Bearer YOUR_TOKEN" + # error_name には完全修飾クラス名が格納されるため、ワイルドカードで指定する + curl -X GET "http://localhost:8080/api/admin/failureurl/logs" \ + -H "Authorization: Bearer YOUR_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{"error_name": "*ConnectException"}' 障害URLの取得 ------------- @@ -311,8 +317,10 @@ FailureUrl APIは、|Fess| のクロール障害URLを管理するためのAPI .. code-block:: bash # エラータイプごとにカウント - 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})' 参考情報 diff --git a/ja/15.9/api/admin/api-admin-joblog.rst b/ja/15.9/api/admin/api-admin-joblog.rst index 8187d9ea..6380b620 100644 --- a/ja/15.9/api/admin/api-admin-joblog.rst +++ b/ja/15.9/api/admin/api-admin-joblog.rst @@ -206,8 +206,10 @@ JobLog APIは、|Fess| のジョブ実行ログを参照・管理するための .. 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}' 失敗したジョブのみ抽出 ---------------------- @@ -215,9 +217,11 @@ JobLog APIは、|Fess| のジョブ実行ログを参照・管理するための .. code-block:: bash # 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")' ジョブログの取得 ---------------- @@ -240,9 +244,11 @@ JobLog APIは、|Fess| のジョブ実行ログを参照・管理するための .. 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}' 参考情報 ======== diff --git a/ja/15.9/api/admin/api-admin-labeltype.rst b/ja/15.9/api/admin/api-admin-labeltype.rst index baecd8e8..734198e9 100644 --- a/ja/15.9/api/admin/api-admin-labeltype.rst +++ b/ja/15.9/api/admin/api-admin-labeltype.rst @@ -349,8 +349,10 @@ HTTPステータスコードなど）については :doc:`api-admin-overview` .. 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}' ラベルを使用した検索 -------------------- diff --git a/ja/15.9/api/admin/api-admin-overview.rst b/ja/15.9/api/admin/api-admin-overview.rst index 4c2b1b1b..0359b5a5 100644 --- a/ja/15.9/api/admin/api-admin-overview.rst +++ b/ja/15.9/api/admin/api-admin-overview.rst @@ -124,6 +124,8 @@ Admin APIへのアクセスは、機能ごとではなく単一の権限セッ - Integer - ページ番号（1から開始。デフォルト: 1。0以下を指定した場合は1として扱われます） +これらのパラメーターと各リソースの絞り込みパラメーターは、snake_case のキーを持つ JSON のリクエストボディ（例: ``{"size": 50, "page": 1}``）で指定します。URL のクエリ文字列で指定した値は無視されます。 + レスポンス ~~~~~~~~~~ @@ -549,8 +551,10 @@ Webクロール設定の作成 .. 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}' 参考情報 ======== diff --git a/ja/15.9/api/admin/api-admin-role.rst b/ja/15.9/api/admin/api-admin-role.rst index 123a1718..350c243c 100644 --- a/ja/15.9/api/admin/api-admin-role.rst +++ b/ja/15.9/api/admin/api-admin-role.rst @@ -276,8 +276,10 @@ Role APIは、|Fess| のロールを管理するためのAPIです。 .. 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}' 参考情報 ======== diff --git a/ja/15.9/api/admin/api-admin-searchlist.rst b/ja/15.9/api/admin/api-admin-searchlist.rst index fadfac01..67ce40e0 100644 --- a/ja/15.9/api/admin/api-admin-searchlist.rst +++ b/ja/15.9/api/admin/api-admin-searchlist.rst @@ -547,8 +547,10 @@ SearchList APIは、|Fess| のインデックス内のドキュメントを検 .. 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}' ドキュメント取得 ---------------- @@ -581,8 +583,10 @@ SearchList APIは、|Fess| のインデックス内のドキュメントを検 .. 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"}' 参考情報 ======== diff --git a/ja/15.9/api/admin/api-admin-tagtype.rst b/ja/15.9/api/admin/api-admin-tagtype.rst index c069a2a6..c9017d95 100644 --- a/ja/15.9/api/admin/api-admin-tagtype.rst +++ b/ja/15.9/api/admin/api-admin-tagtype.rst @@ -357,8 +357,10 @@ HTTPステータスコードなど）については :doc:`api-admin-overview` .. 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}' 参考情報 ======== diff --git a/ko/15.9/api/admin/api-admin-crawlinginfo.rst b/ko/15.9/api/admin/api-admin-crawlinginfo.rst index a1bfc69c..04dbece8 100644 --- a/ko/15.9/api/admin/api-admin-crawlinginfo.rst +++ b/ko/15.9/api/admin/api-admin-crawlinginfo.rst @@ -207,16 +207,20 @@ CrawlingInfo API는 |Fess| 의 크롤링 정보(크롤링 세션)를 참조 및 .. 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}' 특정 세션으로 필터링 -------------------------- .. 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"}' 크롤링 정보 조회 ------------------ diff --git a/ko/15.9/api/admin/api-admin-failureurl.rst b/ko/15.9/api/admin/api-admin-failureurl.rst index c02b0718..a498288f 100644 --- a/ko/15.9/api/admin/api-admin-failureurl.rst +++ b/ko/15.9/api/admin/api-admin-failureurl.rst @@ -257,8 +257,10 @@ FailureUrl API는 |Fess| 의 크롤링 실패 URL을 관리하기 위한 API입 .. 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}' 오류 횟수로 필터링 ---------------------- @@ -266,17 +268,21 @@ FailureUrl API는 |Fess| 의 크롤링 실패 URL을 관리하기 위한 API입 .. code-block:: bash # 3회 이상 오류가 발생한 URL만 조회 - 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}' 오류 이름으로 필터링 -------------------- .. code-block:: bash - # errorName에는 완전한정 클래스명을 저장하므로 와일드카드를 사용하여 지정합니다 - curl -X GET "http://localhost:8080/api/admin/failureurl/logs?errorName=*ConnectException" \ - -H "Authorization: Bearer YOUR_TOKEN" + # error_name에는 완전한정 클래스명을 저장하므로 와일드카드를 사용하여 지정합니다 + curl -X GET "http://localhost:8080/api/admin/failureurl/logs" \ + -H "Authorization: Bearer YOUR_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{"error_name": "*ConnectException"}' 실패 URL 조회 ------------- @@ -308,8 +314,10 @@ FailureUrl API는 |Fess| 의 크롤링 실패 URL을 관리하기 위한 API입 .. code-block:: bash # 오류 타입별 카운트 - 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})' 참고 정보 diff --git a/ko/15.9/api/admin/api-admin-joblog.rst b/ko/15.9/api/admin/api-admin-joblog.rst index df45f1e2..259be219 100644 --- a/ko/15.9/api/admin/api-admin-joblog.rst +++ b/ko/15.9/api/admin/api-admin-joblog.rst @@ -206,8 +206,10 @@ JobLog API는 |Fess| 의 작업 실행 로그를 참조 및 관리하기 위한 .. 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}' 실패한 작업만 추출 ---------------------- @@ -215,9 +217,11 @@ JobLog API는 |Fess| 의 작업 실행 로그를 참조 및 관리하기 위한 .. code-block:: bash # 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")' 작업 로그 조회 ---------------- @@ -240,9 +244,11 @@ JobLog API는 |Fess| 의 작업 실행 로그를 참조 및 관리하기 위한 .. 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}' 참고 정보 ========= diff --git a/ko/15.9/api/admin/api-admin-labeltype.rst b/ko/15.9/api/admin/api-admin-labeltype.rst index d8a92aa7..2c94d556 100644 --- a/ko/15.9/api/admin/api-admin-labeltype.rst +++ b/ko/15.9/api/admin/api-admin-labeltype.rst @@ -349,8 +349,10 @@ HTTP 상태 코드 등)에 대해서는 :doc:`api-admin-overview` 를 참조하 .. 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}' 라벨을 사용한 검색 -------------------- diff --git a/ko/15.9/api/admin/api-admin-overview.rst b/ko/15.9/api/admin/api-admin-overview.rst index d9676f42..8cbd3d35 100644 --- a/ko/15.9/api/admin/api-admin-overview.rst +++ b/ko/15.9/api/admin/api-admin-overview.rst @@ -124,6 +124,8 @@ Admin API에 대한 접근은 기능별이 아니라 단일 권한 세트로 제 - Integer - 페이지 번호 (1부터 시작. 기본값: 1. 0 이하를 지정한 경우 1로 처리됩니다) +이 파라미터와 각 리소스의 필터 파라미터는 snake_case 키를 사용하는 JSON 요청 본문(예: ``{"size": 50, "page": 1}``)으로 지정합니다. URL 쿼리 문자열로 지정한 값은 무시됩니다. + 응답 ~~~~~~~~~~~~ @@ -549,8 +551,10 @@ Web 크롤링 설정 만들기 .. 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}' 참고 정보 ============ diff --git a/ko/15.9/api/admin/api-admin-role.rst b/ko/15.9/api/admin/api-admin-role.rst index ce0f5a44..4a30790d 100644 --- a/ko/15.9/api/admin/api-admin-role.rst +++ b/ko/15.9/api/admin/api-admin-role.rst @@ -276,8 +276,10 @@ Role API는 |Fess| 의 역할을 관리하기 위한 API입니다. .. 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}' 참고 정보 ======== diff --git a/ko/15.9/api/admin/api-admin-searchlist.rst b/ko/15.9/api/admin/api-admin-searchlist.rst index 287ccd09..eec2837a 100644 --- a/ko/15.9/api/admin/api-admin-searchlist.rst +++ b/ko/15.9/api/admin/api-admin-searchlist.rst @@ -547,8 +547,10 @@ ID로 문서 삭제 .. 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}' 문서 취득 --------- @@ -581,8 +583,10 @@ ID로 문서 삭제 .. 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"}' 참고 정보 ========= diff --git a/ko/15.9/api/admin/api-admin-tagtype.rst b/ko/15.9/api/admin/api-admin-tagtype.rst index bf1bc4cc..d3f04b86 100644 --- a/ko/15.9/api/admin/api-admin-tagtype.rst +++ b/ko/15.9/api/admin/api-admin-tagtype.rst @@ -357,8 +357,10 @@ HTTP 상태 코드 등)에 대해서는 :doc:`api-admin-overview` 를 참조하 .. 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}' 참고 정보 ========= diff --git a/zh-cn/15.9/api/admin/api-admin-crawlinginfo.rst b/zh-cn/15.9/api/admin/api-admin-crawlinginfo.rst index 40e8830e..d74ce173 100644 --- a/zh-cn/15.9/api/admin/api-admin-crawlinginfo.rst +++ b/zh-cn/15.9/api/admin/api-admin-crawlinginfo.rst @@ -206,16 +206,20 @@ CrawlingInfo API是用于查看和管理 |Fess| 爬虫信息（爬虫会话） .. 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}' 按特定会话过滤 -------------- .. 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"}' 获取爬虫信息 ------------ diff --git a/zh-cn/15.9/api/admin/api-admin-failureurl.rst b/zh-cn/15.9/api/admin/api-admin-failureurl.rst index 027e9bee..9ae04039 100644 --- a/zh-cn/15.9/api/admin/api-admin-failureurl.rst +++ b/zh-cn/15.9/api/admin/api-admin-failureurl.rst @@ -257,8 +257,10 @@ FailureUrl API是用于管理 |Fess| 爬虫失败URL的API。 .. 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}' 按错误次数过滤 -------------- @@ -266,17 +268,21 @@ FailureUrl API是用于管理 |Fess| 爬虫失败URL的API。 .. code-block:: bash # 仅获取发生3次以上错误的URL - 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}' 按错误名称过滤 -------------- .. code-block:: bash - # errorName存储完全限定类名，请使用通配符指定 - curl -X GET "http://localhost:8080/api/admin/failureurl/logs?errorName=*ConnectException" \ - -H "Authorization: Bearer YOUR_TOKEN" + # error_name存储完全限定类名，请使用通配符指定 + curl -X GET "http://localhost:8080/api/admin/failureurl/logs" \ + -H "Authorization: Bearer YOUR_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{"error_name": "*ConnectException"}' 获取失败URL ----------- @@ -308,8 +314,10 @@ FailureUrl API是用于管理 |Fess| 爬虫失败URL的API。 .. code-block:: bash # 按错误类型计数 - 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})' 参考信息 diff --git a/zh-cn/15.9/api/admin/api-admin-joblog.rst b/zh-cn/15.9/api/admin/api-admin-joblog.rst index f4f6adc8..0fc98a82 100644 --- a/zh-cn/15.9/api/admin/api-admin-joblog.rst +++ b/zh-cn/15.9/api/admin/api-admin-joblog.rst @@ -204,8 +204,10 @@ JobLog API是用于查看和管理 |Fess| 作业执行日志的API。 .. 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}' 仅提取失败的作业 ---------------- @@ -213,9 +215,11 @@ JobLog API是用于查看和管理 |Fess| 作业执行日志的API。 .. code-block:: bash # 用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")' 获取作业日志 ------------ @@ -238,9 +242,11 @@ JobLog API是用于查看和管理 |Fess| 作业执行日志的API。 .. 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}' 参考信息 ======== diff --git a/zh-cn/15.9/api/admin/api-admin-labeltype.rst b/zh-cn/15.9/api/admin/api-admin-labeltype.rst index f64960f1..7a49cae6 100644 --- a/zh-cn/15.9/api/admin/api-admin-labeltype.rst +++ b/zh-cn/15.9/api/admin/api-admin-labeltype.rst @@ -349,8 +349,10 @@ HTTP状态码等），请参阅 :doc:`api-admin-overview`。 .. 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}' 使用标签进行搜索 ---------------- diff --git a/zh-cn/15.9/api/admin/api-admin-overview.rst b/zh-cn/15.9/api/admin/api-admin-overview.rst index c0e58810..952a663a 100644 --- a/zh-cn/15.9/api/admin/api-admin-overview.rst +++ b/zh-cn/15.9/api/admin/api-admin-overview.rst @@ -124,6 +124,8 @@ Admin API的访问不是按功能控制的，而是由单一的权限集控制 - Integer - 页码（从1开始。默认：1。指定0以下的值时按1处理） +这些参数以及各资源的筛选参数，需在键为 snake_case 的 JSON 请求体中指定（例如 ``{"size": 50, "page": 1}``）。在 URL 查询字符串中指定的值会被忽略。 + 响应 ~~~~~~~~ @@ -548,8 +550,10 @@ Admin API在大多数情况下返回 HTTP 状态 ``200``，处理结果通过响 .. 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}' 参考信息 ========== diff --git a/zh-cn/15.9/api/admin/api-admin-role.rst b/zh-cn/15.9/api/admin/api-admin-role.rst index 00da78cc..5ae06cea 100644 --- a/zh-cn/15.9/api/admin/api-admin-role.rst +++ b/zh-cn/15.9/api/admin/api-admin-role.rst @@ -276,8 +276,10 @@ Role API是用于管理 |Fess| 角色的API。 .. 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}' 参考信息 ======== diff --git a/zh-cn/15.9/api/admin/api-admin-searchlist.rst b/zh-cn/15.9/api/admin/api-admin-searchlist.rst index 14f5c3e5..835d8da4 100644 --- a/zh-cn/15.9/api/admin/api-admin-searchlist.rst +++ b/zh-cn/15.9/api/admin/api-admin-searchlist.rst @@ -547,8 +547,10 @@ SearchList API是用于在 |Fess| 索引中搜索和管理文档的Admin API。 .. 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}' 获取文档 -------- @@ -581,8 +583,10 @@ SearchList API是用于在 |Fess| 索引中搜索和管理文档的Admin API。 .. 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"}' 参考信息 ======== diff --git a/zh-cn/15.9/api/admin/api-admin-tagtype.rst b/zh-cn/15.9/api/admin/api-admin-tagtype.rst index e4a5c5f4..95a95e42 100644 --- a/zh-cn/15.9/api/admin/api-admin-tagtype.rst +++ b/zh-cn/15.9/api/admin/api-admin-tagtype.rst @@ -357,8 +357,10 @@ HTTP状态码等），请参阅 :doc:`api-admin-overview`。 .. 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}' 参考信息 ========