From 2bae51afc33ea3fdb1c1b7ea7f6bee9001f80534 Mon Sep 17 00:00:00 2001 From: Shinsuke Sugaya Date: Sun, 4 Oct 2026 23:03:48 +0900 Subject: [PATCH] docs(15.9): use the snake_case field names of the admin API The admin API maps JSON with CAMEL_TO_LOWER_SNAKE, so request bodies are bound and responses are written with snake_case keys (script_type, sort_order, version_no, ...). Sending the camelCase names shown in the docs leaves every multi-word field unset. Rename the keys in the JSON examples, field tables, curl examples and prose of every 15.9 admin API page in all seven locales. Keys that are map entries rather than bean fields keep their names: user and group attributes (givenName, gidNumber, ...), the log and storage file items (lastModified, hashCode), and the multipart upload parameters (badWordFile, synonymFile, ...). Responses omit null fields, so ldap_admin_security_credentials in the general settings and job_log_id when job logging is off are now described as absent instead of null. --- de/15.9/api/admin/api-admin-accesstoken.rst | 38 +-- de/15.9/api/admin/api-admin-badword.rst | 16 +- de/15.9/api/admin/api-admin-boostdoc.rst | 98 +++---- de/15.9/api/admin/api-admin-crawlinginfo.rst | 28 +- de/15.9/api/admin/api-admin-dataconfig.rst | 62 ++--- de/15.9/api/admin/api-admin-dict.rst | 6 +- de/15.9/api/admin/api-admin-elevateword.rst | 30 +-- de/15.9/api/admin/api-admin-failureurl.rst | 60 ++--- de/15.9/api/admin/api-admin-fileconfig.rst | 132 ++++----- de/15.9/api/admin/api-admin-general.rst | 251 +++++++++-------- de/15.9/api/admin/api-admin-group.rst | 12 +- de/15.9/api/admin/api-admin-joblog.rst | 58 ++-- de/15.9/api/admin/api-admin-keymatch.rst | 46 ++-- de/15.9/api/admin/api-admin-labeltype.rst | 72 ++--- de/15.9/api/admin/api-admin-overview.rst | 18 +- .../api/admin/api-admin-relatedcontent.rst | 66 ++--- de/15.9/api/admin/api-admin-relatedquery.rst | 26 +- de/15.9/api/admin/api-admin-role.rst | 12 +- de/15.9/api/admin/api-admin-scheduler.rst | 82 +++--- de/15.9/api/admin/api-admin-suggest.rst | 14 +- de/15.9/api/admin/api-admin-systeminfo.rst | 20 +- de/15.9/api/admin/api-admin-user.rst | 28 +- de/15.9/api/admin/api-admin-webconfig.rst | 150 +++++------ en/15.9/api/admin/api-admin-accesstoken.rst | 38 +-- en/15.9/api/admin/api-admin-badword.rst | 16 +- en/15.9/api/admin/api-admin-boostdoc.rst | 104 +++---- en/15.9/api/admin/api-admin-crawlinginfo.rst | 28 +- en/15.9/api/admin/api-admin-dataconfig.rst | 62 ++--- en/15.9/api/admin/api-admin-dict.rst | 6 +- en/15.9/api/admin/api-admin-elevateword.rst | 30 +-- en/15.9/api/admin/api-admin-failureurl.rst | 60 ++--- en/15.9/api/admin/api-admin-fileconfig.rst | 130 ++++----- en/15.9/api/admin/api-admin-general.rst | 251 +++++++++-------- en/15.9/api/admin/api-admin-group.rst | 12 +- en/15.9/api/admin/api-admin-joblog.rst | 58 ++-- en/15.9/api/admin/api-admin-keymatch.rst | 46 ++-- en/15.9/api/admin/api-admin-labeltype.rst | 72 ++--- en/15.9/api/admin/api-admin-overview.rst | 18 +- .../api/admin/api-admin-relatedcontent.rst | 66 ++--- en/15.9/api/admin/api-admin-relatedquery.rst | 26 +- en/15.9/api/admin/api-admin-role.rst | 12 +- en/15.9/api/admin/api-admin-scheduler.rst | 82 +++--- en/15.9/api/admin/api-admin-suggest.rst | 16 +- en/15.9/api/admin/api-admin-systeminfo.rst | 20 +- en/15.9/api/admin/api-admin-user.rst | 28 +- en/15.9/api/admin/api-admin-webconfig.rst | 148 +++++----- es/15.9/api/admin/api-admin-accesstoken.rst | 36 +-- es/15.9/api/admin/api-admin-badword.rst | 16 +- es/15.9/api/admin/api-admin-boostdoc.rst | 96 +++---- es/15.9/api/admin/api-admin-crawlinginfo.rst | 28 +- es/15.9/api/admin/api-admin-dataconfig.rst | 62 ++--- es/15.9/api/admin/api-admin-dict.rst | 6 +- es/15.9/api/admin/api-admin-elevateword.rst | 30 +-- es/15.9/api/admin/api-admin-failureurl.rst | 60 ++--- es/15.9/api/admin/api-admin-fileconfig.rst | 132 ++++----- es/15.9/api/admin/api-admin-general.rst | 251 +++++++++-------- es/15.9/api/admin/api-admin-group.rst | 12 +- es/15.9/api/admin/api-admin-joblog.rst | 58 ++-- es/15.9/api/admin/api-admin-keymatch.rst | 46 ++-- es/15.9/api/admin/api-admin-labeltype.rst | 72 ++--- es/15.9/api/admin/api-admin-overview.rst | 18 +- .../api/admin/api-admin-relatedcontent.rst | 64 ++--- es/15.9/api/admin/api-admin-relatedquery.rst | 26 +- es/15.9/api/admin/api-admin-role.rst | 12 +- es/15.9/api/admin/api-admin-scheduler.rst | 82 +++--- es/15.9/api/admin/api-admin-suggest.rst | 16 +- es/15.9/api/admin/api-admin-systeminfo.rst | 20 +- es/15.9/api/admin/api-admin-user.rst | 28 +- es/15.9/api/admin/api-admin-webconfig.rst | 150 +++++------ fr/15.9/api/admin/api-admin-accesstoken.rst | 38 +-- fr/15.9/api/admin/api-admin-badword.rst | 16 +- fr/15.9/api/admin/api-admin-boostdoc.rst | 96 +++---- fr/15.9/api/admin/api-admin-crawlinginfo.rst | 28 +- fr/15.9/api/admin/api-admin-dataconfig.rst | 62 ++--- fr/15.9/api/admin/api-admin-dict.rst | 6 +- fr/15.9/api/admin/api-admin-elevateword.rst | 30 +-- fr/15.9/api/admin/api-admin-failureurl.rst | 60 ++--- fr/15.9/api/admin/api-admin-fileconfig.rst | 132 ++++----- fr/15.9/api/admin/api-admin-general.rst | 253 +++++++++--------- fr/15.9/api/admin/api-admin-group.rst | 12 +- fr/15.9/api/admin/api-admin-joblog.rst | 58 ++-- fr/15.9/api/admin/api-admin-keymatch.rst | 46 ++-- fr/15.9/api/admin/api-admin-labeltype.rst | 72 ++--- fr/15.9/api/admin/api-admin-overview.rst | 18 +- .../api/admin/api-admin-relatedcontent.rst | 66 ++--- fr/15.9/api/admin/api-admin-relatedquery.rst | 28 +- fr/15.9/api/admin/api-admin-role.rst | 12 +- fr/15.9/api/admin/api-admin-scheduler.rst | 82 +++--- fr/15.9/api/admin/api-admin-suggest.rst | 16 +- fr/15.9/api/admin/api-admin-systeminfo.rst | 20 +- fr/15.9/api/admin/api-admin-user.rst | 28 +- fr/15.9/api/admin/api-admin-webconfig.rst | 150 +++++------ ja/15.9/api/admin/api-admin-accesstoken.rst | 38 +-- ja/15.9/api/admin/api-admin-badword.rst | 16 +- ja/15.9/api/admin/api-admin-boostdoc.rst | 100 +++---- ja/15.9/api/admin/api-admin-crawlinginfo.rst | 28 +- ja/15.9/api/admin/api-admin-dataconfig.rst | 64 ++--- ja/15.9/api/admin/api-admin-dict.rst | 6 +- ja/15.9/api/admin/api-admin-elevateword.rst | 30 +-- ja/15.9/api/admin/api-admin-failureurl.rst | 60 ++--- ja/15.9/api/admin/api-admin-fileconfig.rst | 132 ++++----- ja/15.9/api/admin/api-admin-general.rst | 251 +++++++++-------- ja/15.9/api/admin/api-admin-group.rst | 12 +- ja/15.9/api/admin/api-admin-joblog.rst | 58 ++-- ja/15.9/api/admin/api-admin-keymatch.rst | 46 ++-- ja/15.9/api/admin/api-admin-labeltype.rst | 72 ++--- ja/15.9/api/admin/api-admin-overview.rst | 18 +- .../api/admin/api-admin-relatedcontent.rst | 64 ++--- ja/15.9/api/admin/api-admin-relatedquery.rst | 26 +- ja/15.9/api/admin/api-admin-role.rst | 12 +- ja/15.9/api/admin/api-admin-scheduler.rst | 82 +++--- ja/15.9/api/admin/api-admin-suggest.rst | 16 +- ja/15.9/api/admin/api-admin-systeminfo.rst | 20 +- ja/15.9/api/admin/api-admin-user.rst | 26 +- ja/15.9/api/admin/api-admin-webconfig.rst | 150 +++++------ ko/15.9/api/admin/api-admin-accesstoken.rst | 38 +-- ko/15.9/api/admin/api-admin-badword.rst | 16 +- ko/15.9/api/admin/api-admin-boostdoc.rst | 98 +++---- ko/15.9/api/admin/api-admin-crawlinginfo.rst | 28 +- ko/15.9/api/admin/api-admin-dataconfig.rst | 62 ++--- ko/15.9/api/admin/api-admin-dict.rst | 6 +- ko/15.9/api/admin/api-admin-elevateword.rst | 30 +-- ko/15.9/api/admin/api-admin-failureurl.rst | 60 ++--- ko/15.9/api/admin/api-admin-fileconfig.rst | 132 ++++----- ko/15.9/api/admin/api-admin-general.rst | 251 +++++++++-------- ko/15.9/api/admin/api-admin-group.rst | 12 +- ko/15.9/api/admin/api-admin-joblog.rst | 58 ++-- ko/15.9/api/admin/api-admin-keymatch.rst | 46 ++-- ko/15.9/api/admin/api-admin-labeltype.rst | 72 ++--- ko/15.9/api/admin/api-admin-overview.rst | 18 +- .../api/admin/api-admin-relatedcontent.rst | 66 ++--- ko/15.9/api/admin/api-admin-relatedquery.rst | 26 +- ko/15.9/api/admin/api-admin-role.rst | 12 +- ko/15.9/api/admin/api-admin-scheduler.rst | 82 +++--- ko/15.9/api/admin/api-admin-suggest.rst | 16 +- ko/15.9/api/admin/api-admin-systeminfo.rst | 20 +- ko/15.9/api/admin/api-admin-user.rst | 28 +- ko/15.9/api/admin/api-admin-webconfig.rst | 150 +++++------ .../15.9/api/admin/api-admin-accesstoken.rst | 38 +-- zh-cn/15.9/api/admin/api-admin-badword.rst | 16 +- zh-cn/15.9/api/admin/api-admin-boostdoc.rst | 96 +++---- .../15.9/api/admin/api-admin-crawlinginfo.rst | 28 +- zh-cn/15.9/api/admin/api-admin-dataconfig.rst | 62 ++--- zh-cn/15.9/api/admin/api-admin-dict.rst | 6 +- .../15.9/api/admin/api-admin-elevateword.rst | 30 +-- zh-cn/15.9/api/admin/api-admin-failureurl.rst | 60 ++--- zh-cn/15.9/api/admin/api-admin-fileconfig.rst | 132 ++++----- zh-cn/15.9/api/admin/api-admin-general.rst | 249 +++++++++-------- zh-cn/15.9/api/admin/api-admin-group.rst | 12 +- zh-cn/15.9/api/admin/api-admin-joblog.rst | 58 ++-- zh-cn/15.9/api/admin/api-admin-keymatch.rst | 46 ++-- zh-cn/15.9/api/admin/api-admin-labeltype.rst | 72 ++--- zh-cn/15.9/api/admin/api-admin-overview.rst | 18 +- .../api/admin/api-admin-relatedcontent.rst | 66 ++--- .../15.9/api/admin/api-admin-relatedquery.rst | 26 +- zh-cn/15.9/api/admin/api-admin-role.rst | 12 +- zh-cn/15.9/api/admin/api-admin-scheduler.rst | 82 +++--- zh-cn/15.9/api/admin/api-admin-suggest.rst | 18 +- zh-cn/15.9/api/admin/api-admin-systeminfo.rst | 20 +- zh-cn/15.9/api/admin/api-admin-user.rst | 28 +- zh-cn/15.9/api/admin/api-admin-webconfig.rst | 150 +++++------ 161 files changed, 4638 insertions(+), 4645 deletions(-) diff --git a/de/15.9/api/admin/api-admin-accesstoken.rst b/de/15.9/api/admin/api-admin-accesstoken.rst index d90a34a7b..481cd345e 100644 --- a/de/15.9/api/admin/api-admin-accesstoken.rst +++ b/de/15.9/api/admin/api-admin-accesstoken.rst @@ -98,14 +98,14 @@ Response "id": "token_id_1", "name": "API Token 1", "token": "abcd1234efgh5678", - "parameterName": "permission", + "parameter_name": "permission", "permissions": "{role}admin-api", "expires": "2026-01-01T00:00:00", - "createdBy": "admin", - "createdTime": 1735689600000, - "updatedBy": "admin", - "updatedTime": 1735689600000, - "versionNo": 1 + "created_by": "admin", + "created_time": 1735689600000, + "updated_by": "admin", + "updated_time": 1735689600000, + "version_no": 1 } ], "total": 5 @@ -114,9 +114,9 @@ Response .. note:: - Jedes Token-Objekt enthält außerdem Audit- und Versionsinformationen wie ``createdBy``, ``createdTime``, ``updatedBy``, - ``updatedTime`` und ``versionNo``. - ``createdTime`` und ``updatedTime`` werden als Millisekunden seit der Epoche (numerisch) angegeben. + Jedes Token-Objekt enthält außerdem Audit- und Versionsinformationen wie ``created_by``, ``created_time``, ``updated_by``, + ``updated_time`` und ``version_no``. + ``created_time`` und ``updated_time`` werden als Millisekunden seit der Epoche (numerisch) angegeben. Felder mit dem Wert ``null`` werden aus der Response ausgeschlossen. ``permissions`` wird als durch Zeilenumbrüche ( ``\n`` ) getrennte Zeichenkette zurückgegeben. @@ -142,14 +142,14 @@ Response "id": "token_id_1", "name": "API Token 1", "token": "abcd1234efgh5678", - "parameterName": "permission", + "parameter_name": "permission", "permissions": "{role}admin-api", "expires": "2026-01-01T00:00:00", - "createdBy": "admin", - "createdTime": 1735689600000, - "updatedBy": "admin", - "updatedTime": 1735689600000, - "versionNo": 1 + "created_by": "admin", + "created_time": 1735689600000, + "updated_by": "admin", + "updated_time": 1735689600000, + "version_no": 1 } } } @@ -192,7 +192,7 @@ Feldbeschreibungen * - ``permissions`` - Nein - Dem Token zugewiesene Berechtigungen. Mehrere Berechtigungen können durch Zeilenumbrüche ( ``\n`` ) getrennt angegeben werden (Beispiel: ``{role}admin-api`` ). Token, die die Admin API aufrufen sollen, benötigen eine Berechtigung, die ``api.admin.access.permissions`` (Standardwert ``{role}admin-api`` ) entspricht. - * - ``parameterName`` + * - ``parameter_name`` - Nein - Name des Request-Parameters zur Übergabe zusätzlicher Berechtigungen. Enthält eine mit diesem Token authentifizierte Anfrage einen Parameter mit dem hier angegebenen Namen, wird dessen Wert zu ``permissions`` hinzugefügt. Wird dieses Feld weggelassen, wird kein Parameter konfiguriert. * - ``expires`` @@ -239,7 +239,7 @@ Request-Body "name": "Updated API Token", "permissions": "{role}admin-api\n{role}user", "expires": "2026-01-01T00:00:00", - "versionNo": 1 + "version_no": 1 } Feldbeschreibungen @@ -257,9 +257,9 @@ Bei der Aktualisierung werden zusätzlich zu den Feldern der Erstellung folgende * - ``id`` - Ja - ID des zu aktualisierenden Tokens - * - ``versionNo`` + * - ``version_no`` - Ja - - Versionsnummer für optimistisches Sperren. Geben Sie die ``versionNo`` des zuvor abgerufenen Tokens an. + - Versionsnummer für optimistisches Sperren. Geben Sie die ``version_no`` des zuvor abgerufenen Tokens an. .. note:: diff --git a/de/15.9/api/admin/api-admin-badword.rst b/de/15.9/api/admin/api-admin-badword.rst index 84a856491..5005bf447 100644 --- a/de/15.9/api/admin/api-admin-badword.rst +++ b/de/15.9/api/admin/api-admin-badword.rst @@ -92,7 +92,7 @@ Response "settings": [ { "id": "badword_id_1", - "suggestWord": "inappropriate_word" + "suggest_word": "inappropriate_word" } ], "total": 5 @@ -119,7 +119,7 @@ Response "status": 0, "setting": { "id": "badword_id_1", - "suggestWord": "inappropriate_word" + "suggest_word": "inappropriate_word" } } } @@ -141,7 +141,7 @@ Request-Body .. code-block:: json { - "suggestWord": "spam_keyword" + "suggest_word": "spam_keyword" } Feldbeschreibungen @@ -154,7 +154,7 @@ Feldbeschreibungen * - Feld - Erforderlich - Beschreibung - * - ``suggestWord`` + * - ``suggest_word`` - Ja - Das auszuschließende Schlüsselwort (darf keine Leerzeichen enthalten) @@ -189,8 +189,8 @@ Request-Body { "id": "existing_badword_id", - "suggestWord": "updated_spam_keyword", - "versionNo": 1 + "suggest_word": "updated_spam_keyword", + "version_no": 1 } Response @@ -260,7 +260,7 @@ CSV-Format ~~~~~~~~~~ - Die erste Zeile wird als Kopfzeile übersprungen (der Spaltenname ist beliebig; beim Herunterladen wird ``BadWord`` ausgegeben). -- Ab der zweiten Zeile wird pro Zeile ein Bad Word als ``suggestWord`` angegeben. +- Ab der zweiten Zeile wird pro Zeile ein Bad Word als ``suggest_word`` angegeben. - Zeilen, deren Wert nur aus Leerzeichen besteht, werden ignoriert. - Stellen Sie einem Wort ``--`` voran, um es zu löschen (z. B. löscht ``--spam`` das Wort ``spam``). - Die Angabe eines bereits registrierten Worts wird als Aktualisierung behandelt (der Bearbeiter und der Aktualisierungszeitpunkt werden zurückgesetzt). @@ -306,7 +306,7 @@ Spam-Schlüsselwörter ausschließen -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "suggestWord": "spam" + "suggest_word": "spam" }' CSV-Datei hochladen diff --git a/de/15.9/api/admin/api-admin-boostdoc.rst b/de/15.9/api/admin/api-admin-boostdoc.rst index a171dab12..f977a7032 100644 --- a/de/15.9/api/admin/api-admin-boostdoc.rst +++ b/de/15.9/api/admin/api-admin-boostdoc.rst @@ -10,20 +10,20 @@ Durch die Konfiguration von Dokument-Boosts können Sie den Score von Dokumenten und dadurch erreichen, dass diese Dokumente in den Suchergebnissen weiter oben erscheinen. Boosts werden zum Zeitpunkt der Indexierung (beim Crawlen) auf die einzelnen Dokumente angewendet. -Sowohl die Bedingung (``urlExpr``) als auch der Boost-Wert (``boostExpr``) werden mit der im Feld ``scriptType`` -angegebenen Skript-Engine ausgewertet. Für ``scriptType`` können Sie ``javascript`` oder ``groovy`` (erfordert +Sowohl die Bedingung (``url_expr``) als auch der Boost-Wert (``boost_expr``) werden mit der im Feld ``script_type`` +angegebenen Skript-Engine ausgewertet. Für ``script_type`` können Sie ``javascript`` oder ``groovy`` (erfordert das Plugin ``fess-script-groovy``) angeben. Der Erstellungsbildschirm der Administrationsoberfläche füllt -``scriptType`` mit ``javascript`` vor; wird ``scriptType`` im Request-Body dieser API jedoch weggelassen, erfolgt +``script_type`` mit ``javascript`` vor; wird ``script_type`` im Request-Body dieser API jedoch weggelassen, erfolgt keine automatische Vorbelegung, und die Ausdrücke werden als Groovy ausgewertet. -Mehrere Regeln werden in aufsteigender Reihenfolge von ``sortOrder`` ausgewertet; nur der Boost-Wert der ersten zutreffenden Regel wird angewendet +Mehrere Regeln werden in aufsteigender Reihenfolge von ``sort_order`` ausgewertet; nur der Boost-Wert der ersten zutreffenden Regel wird angewendet (sobald eine passende Regel gefunden wurde, werden die nachfolgenden Regeln nicht mehr ausgewertet). .. note:: - In der Administrationsoberfläche wird ``urlExpr`` als „Bedingung", ``boostExpr`` als „Boost-Wert-Ausdruck" und - ``scriptType`` als „Skripttyp" angezeigt. ``scriptType`` erscheint nur in den Request-Bodies und Responses + In der Administrationsoberfläche wird ``url_expr`` als „Bedingung", ``boost_expr`` als „Boost-Wert-Ausdruck" und + ``script_type`` als „Skripttyp" angezeigt. ``script_type`` erscheint nur in den Request-Bodies und Responses von Erstellung/Aktualisierung/Abruf (Liste und Einzelabruf), nicht bei den Filterparametern der Listenabfrage - (``urlExpr``, ``boostExpr``). + (``url_expr``, ``boost_expr``). Einzelheiten zu den Konfigurationsfeldern finden Sie unter :doc:`../../admin/boostdoc-guide`. Basis-URL @@ -94,11 +94,11 @@ Parameter - Integer - Nein - Seitennummer (beginnt bei 1, Standard: 1) - * - ``urlExpr`` + * - ``url_expr`` - String - Nein - Filterung nach Bedingungsausdruck (Teilübereinstimmung) - * - ``boostExpr`` + * - ``boost_expr`` - String - Nein - Filterung nach Boost-Wert-Ausdruck (Teilübereinstimmung) @@ -114,11 +114,11 @@ Response "settings": [ { "id": "boostdoc_id_1", - "urlExpr": "url.startsWith(\"https://docs.example.com/\")", - "boostExpr": "3.0", - "scriptType": "javascript", - "sortOrder": 1, - "versionNo": 1 + "url_expr": "url.startsWith(\"https://docs.example.com/\")", + "boost_expr": "3.0", + "script_type": "javascript", + "sort_order": 1, + "version_no": 1 } ], "total": 5 @@ -127,8 +127,8 @@ Response .. note:: - Jedes Einstellungsobjekt in der Antwort enthält neben den oben gezeigten Feldern auch Metadaten zur Erstellung und Aktualisierung (``createdBy``, ``createdTime``, ``updatedBy``, ``updatedTime``). - ``versionNo`` ist bei der Aktualisierung (PUT) erforderlich; rufen Sie den aktuellen Wert daher zuvor über die Get- oder List-API ab. + Jedes Einstellungsobjekt in der Antwort enthält neben den oben gezeigten Feldern auch Metadaten zur Erstellung und Aktualisierung (``created_by``, ``created_time``, ``updated_by``, ``updated_time``). + ``version_no`` ist bei der Aktualisierung (PUT) erforderlich; rufen Sie den aktuellen Wert daher zuvor über die Get- oder List-API ab. Dokument-Boost abrufen ====================== @@ -150,11 +150,11 @@ Response "status": 0, "setting": { "id": "boostdoc_id_1", - "urlExpr": "url.startsWith(\"https://docs.example.com/\")", - "boostExpr": "3.0", - "scriptType": "javascript", - "sortOrder": 1, - "versionNo": 1 + "url_expr": "url.startsWith(\"https://docs.example.com/\")", + "boost_expr": "3.0", + "script_type": "javascript", + "sort_order": 1, + "version_no": 1 } } } @@ -176,10 +176,10 @@ Request-Body .. code-block:: json { - "urlExpr": "url.startsWith(\"https://important.example.com/\")", - "boostExpr": "5.0", - "scriptType": "javascript", - "sortOrder": 0 + "url_expr": "url.startsWith(\"https://important.example.com/\")", + "boost_expr": "5.0", + "script_type": "javascript", + "sort_order": 0 } Feldbeschreibungen @@ -192,16 +192,16 @@ Feldbeschreibungen * - Feld - Erforderlich - Beschreibung - * - ``urlExpr`` + * - ``url_expr`` - Ja - Bedingungsausdruck. Ein Skript-Ausdruck, der bestimmt, ob ein Dokument geboostet werden soll; muss einen ``Boolean``-Wert zurückgeben. Entspricht dem Feld „Bedingung" in der Administrationsoberfläche (maximal 10000 Zeichen). - * - ``boostExpr`` + * - ``boost_expr`` - Ja - Boost-Wert-Ausdruck. Ein Skript-Ausdruck, der den Boost-Wert (Zahl) zurückgibt. Es kann auch ein fester Wert wie ``3.0`` angegeben werden. Entspricht dem Feld „Boost-Wert-Ausdruck" in der Administrationsoberfläche (maximal 10000 Zeichen). - * - ``scriptType`` + * - ``script_type`` - Nein - - Die Skript-Engine zur Auswertung von ``urlExpr`` und ``boostExpr``. Entweder ``javascript`` oder ``groovy`` (erfordert das Plugin ``fess-script-groovy``). Entspricht dem Feld „Skripttyp" in der Administrationsoberfläche (maximal 100 Zeichen). Wird das Feld weggelassen, werden die Ausdrücke als Groovy ausgewertet. - * - ``sortOrder`` + - Die Skript-Engine zur Auswertung von ``url_expr`` und ``boost_expr``. Entweder ``javascript`` oder ``groovy`` (erfordert das Plugin ``fess-script-groovy``). Entspricht dem Feld „Skripttyp" in der Administrationsoberfläche (maximal 100 Zeichen). Wird das Feld weggelassen, werden die Ausdrücke als Groovy ausgewertet. + * - ``sort_order`` - Ja - Anwendungsreihenfolge. Regeln werden in aufsteigender Reihenfolge ausgewertet; der Boost-Wert der ersten zutreffenden Regel wird angewendet (Formular-Standardwert: 0; ganze Zahl ≥ 0). @@ -236,15 +236,15 @@ Request-Body { "id": "existing_boostdoc_id", - "urlExpr": "url.startsWith(\"https://important.example.com/\")", - "boostExpr": "10.0", - "scriptType": "javascript", - "sortOrder": 0, - "versionNo": 1 + "url_expr": "url.startsWith(\"https://important.example.com/\")", + "boost_expr": "10.0", + "script_type": "javascript", + "sort_order": 0, + "version_no": 1 } -Bei der Aktualisierung sind zusätzlich zu den Feldern beim Erstellen ``id`` (ID der Zielregel, bis zu 1000 Zeichen) und ``versionNo`` (Versionsnummer für optimistisches Sperren) erforderlich. -Geben Sie für ``versionNo`` den aktuellen Wert aus der Antwort der Get- oder List-API an. +Bei der Aktualisierung sind zusätzlich zu den Feldern beim Erstellen ``id`` (ID der Zielregel, bis zu 1000 Zeichen) und ``version_no`` (Versionsnummer für optimistisches Sperren) erforderlich. +Geben Sie für ``version_no`` den aktuellen Wert aus der Antwort der Get- oder List-API an. Die Aktualisierung schlägt fehl, wenn die Versionsnummer nicht übereinstimmt. Response @@ -284,13 +284,13 @@ Response Bedingungsausdrücke und Boost-Wert-Ausdrücke ============================================ -Sowohl ``urlExpr`` (Bedingung) als auch ``boostExpr`` (Boost-Wert-Ausdruck) werden mit der über ``scriptType`` +Sowohl ``url_expr`` (Bedingung) als auch ``boost_expr`` (Boost-Wert-Ausdruck) werden mit der über ``script_type`` angegebenen Skript-Engine ausgewertet (Standard: Groovy; nur der Erstellungsbildschirm der Administrationsoberfläche füllt ``javascript`` vor). Innerhalb eines Ausdrucks können Sie auf die Feldwerte des zu indexierenden Dokuments über Variablen mit dem jeweiligen Feldnamen zugreifen. -- ``urlExpr`` muss einen ``Boolean``-Wert zurückgeben (Beispiel: ``url.startsWith("https://docs.example.com/")``). Ein einfacher regulärer Ausdrucks-String (z. B. ``.*docs\.example\.com.*``) gibt als Skript-Ausdruck keinen ``Boolean``-Wert zurück und funktioniert daher nicht als Bedingung. Für reguläre Ausdrücke verwenden Sie ``String#matches`` (in Groovy und JavaScript mit derselben Schreibweise verfügbar). -- ``boostExpr`` muss einen numerischen Wert zurückgeben. Das Ergebnis wird in ``float`` umgewandelt; ein Boost wird nur angewendet, wenn der Wert größer als 0 ist. +- ``url_expr`` muss einen ``Boolean``-Wert zurückgeben (Beispiel: ``url.startsWith("https://docs.example.com/")``). Ein einfacher regulärer Ausdrucks-String (z. B. ``.*docs\.example\.com.*``) gibt als Skript-Ausdruck keinen ``Boolean``-Wert zurück und funktioniert daher nicht als Bedingung. Für reguläre Ausdrücke verwenden Sie ``String#matches`` (in Groovy und JavaScript mit derselben Schreibweise verfügbar). +- ``boost_expr`` muss einen numerischen Wert zurückgeben. Das Ergebnis wird in ``float`` umgewandelt; ein Boost wird nur angewendet, wenn der Wert größer als 0 ist. .. note:: @@ -299,8 +299,8 @@ Innerhalb eines Ausdrucks können Sie auf die Feldwerte des zu indexierenden Dok ``indexer.favorite.count.enabled`` aktiviert ist (beide standardmäßig aktiviert). Die OpenSearch-Datumsberechnungssyntax wie ``now - 7d`` kann weder in Groovy noch in JavaScript verwendet werden. -Beispiele für Bedingungsausdrücke (``urlExpr``) ------------------------------------------------ +Beispiele für Bedingungsausdrücke (``url_expr``) +------------------------------------------------ .. list-table:: :header-rows: 1 @@ -315,7 +315,7 @@ Beispiele für Bedingungsausdrücke (``urlExpr``) * - ``title.contains("Versionshinweise")`` - Dokumente, deren Titel einen bestimmten Begriff enthält, als Ziel festlegen -Beispiele für Boost-Wert-Ausdrücke (``boostExpr``) +Beispiele für Boost-Wert-Ausdrücke (``boost_expr``) --------------------------------------------------- .. list-table:: @@ -343,9 +343,9 @@ Dokumentations-Website boosten -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "urlExpr": "url.startsWith(\"https://docs.example.com/\")", - "boostExpr": "5.0", - "sortOrder": 0 + "url_expr": "url.startsWith(\"https://docs.example.com/\")", + "boost_expr": "5.0", + "sort_order": 0 }' Inhalte mit vielen Klicks boosten @@ -357,9 +357,9 @@ Inhalte mit vielen Klicks boosten -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "urlExpr": "url.startsWith(\"https://www.example.com/\")", - "boostExpr": "click_count * 0.1 + 1", - "sortOrder": 10 + "url_expr": "url.startsWith(\"https://www.example.com/\")", + "boost_expr": "click_count * 0.1 + 1", + "sort_order": 10 }' Referenzinformationen diff --git a/de/15.9/api/admin/api-admin-crawlinginfo.rst b/de/15.9/api/admin/api-admin-crawlinginfo.rst index cd2172370..420908745 100644 --- a/de/15.9/api/admin/api-admin-crawlinginfo.rst +++ b/de/15.9/api/admin/api-admin-crawlinginfo.rst @@ -67,7 +67,7 @@ Parameter - Integer - Nein - Seitennummer (1-basiert, Standard: 1) - * - ``sessionId`` + * - ``session_id`` - String - Nein - Filter nach Sitzungs-ID (Teilübereinstimmung) @@ -83,17 +83,17 @@ Response "logs": [ { "id": "crawling_info_id_1", - "sessionId": "20250129100000", + "session_id": "20250129100000", "name": "Default Crawler", - "expiredTime": "1738200000000", - "createdTime": 1738108800000 + "expired_time": "1738200000000", + "created_time": 1738108800000 }, { "id": "crawling_info_id_2", - "sessionId": "20250128100000", + "session_id": "20250128100000", "name": "Default Crawler", - "expiredTime": "1738113600000", - "createdTime": 1738022400000 + "expired_time": "1738113600000", + "created_time": 1738022400000 } ], "total": 10 @@ -111,18 +111,18 @@ Response-Felder - Beschreibung * - ``id`` - Crawl-Informations-ID - * - ``sessionId`` + * - ``session_id`` - Sitzungs-ID * - ``name`` - Sitzungsname - * - ``expiredTime`` + * - ``expired_time`` - Ablaufzeit (Epoch-Millisekunden; wird als Zeichenkette zurückgegeben) - * - ``createdTime`` + * - ``created_time`` - Erstellungszeit (Epoch-Millisekunden; wird als Zahl zurückgegeben) .. note:: - Jedes Log-Objekt in der Antwort enthält außerdem ein internes ``crudMode``-Feld + Jedes Log-Objekt in der Antwort enthält außerdem ein internes ``crud_mode``-Feld (eine Ganzzahl, die den CRUD-Operationsmodus angibt; bei Leseoperationen immer ``0``). Clients können dieses Feld gefahrlos ignorieren. @@ -146,10 +146,10 @@ Response "status": 0, "log": { "id": "crawling_info_id_1", - "sessionId": "20250129100000", + "session_id": "20250129100000", "name": "Default Crawler", - "expiredTime": "1738200000000", - "createdTime": 1738108800000 + "expired_time": "1738200000000", + "created_time": 1738108800000 } } } diff --git a/de/15.9/api/admin/api-admin-dataconfig.rst b/de/15.9/api/admin/api-admin-dataconfig.rst index 59b094211..5f2b0fdbe 100644 --- a/de/15.9/api/admin/api-admin-dataconfig.rst +++ b/de/15.9/api/admin/api-admin-dataconfig.rst @@ -74,7 +74,7 @@ Parameter - String - Nein - Filtern nach Konfigurationsname - * - ``handlerName`` + * - ``handler_name`` - String - Nein - Filtern nach Handler-Name @@ -96,14 +96,14 @@ Response "id": "dataconfig_id_1", "name": "Database Crawler", "description": "Datenbank-Crawler", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/mydb", - "handlerScript": "...", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/mydb", + "handler_script": "...", "boost": 1.0, "available": "true", "permissions": "{role}admin", - "virtualHosts": "", - "sortOrder": 0 + "virtual_hosts": "", + "sort_order": 0 } ], "total": 5 @@ -132,14 +132,14 @@ Response "id": "dataconfig_id_1", "name": "Database Crawler", "description": "Datenbank-Crawler", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/mydb\nusername=dbuser\npassword=dbpass", - "handlerScript": "...", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/mydb\nusername=dbuser\npassword=dbpass", + "handler_script": "...", "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin", - "virtualHosts": "" + "virtual_hosts": "" } } } @@ -162,12 +162,12 @@ Request-Body { "name": "Product Database", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/products\nusername=user\npassword=pass", - "handlerScript": "url=\"https://example.com/product/\" + product_id\ntitle=product_name\ncontent=description", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/products\nusername=user\npassword=pass", + "handler_script": "url=\"https://example.com/product/\" + product_id\ntitle=product_name\ncontent=description", "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin\n{role}user" } @@ -187,13 +187,13 @@ Feldbeschreibungen * - ``description`` - Nein - Beschreibung der Konfiguration - * - ``handlerName`` + * - ``handler_name`` - Ja - Name des Datenspeicher-Handlers - * - ``handlerParameter`` + * - ``handler_parameter`` - Nein - Handler-Parameter (Verbindungsinformationen usw.) - * - ``handlerScript`` + * - ``handler_script`` - Nein - Datenkonvertierungsskript * - ``boost`` @@ -202,13 +202,13 @@ Feldbeschreibungen * - ``available`` - Ja - Aktiviert/Deaktiviert (Zeichenkette ``"true"`` / ``"false"``) - * - ``sortOrder`` + * - ``sort_order`` - Ja - Anzeigereihenfolge * - ``permissions`` - Nein - Zugriffsberechtigte Rollen (bei mehreren durch Zeilenumbrüche getrennt) - * - ``virtualHosts`` + * - ``virtual_hosts`` - Nein - Virtuelle Hosts (bei mehreren durch Zeilenumbrüche getrennt) @@ -244,16 +244,16 @@ Request-Body { "id": "existing_dataconfig_id", "name": "Updated Product Database", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/products\nusername=user\npassword=newpass", - "handlerScript": "url=\"https://example.com/product/\" + product_id\ntitle=product_name\ncontent=description + \" \" + features", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/products\nusername=user\npassword=newpass", + "handler_script": "url=\"https://example.com/product/\" + product_id\ntitle=product_name\ncontent=description + \" \" + features", "boost": 1.5, "available": "true", - "sortOrder": 0, - "versionNo": 1 + "sort_order": 0, + "version_no": 1 } -Aktualisierungsanfragen erfordern dieselben Pflichtfelder wie beim Erstellen (``name``, ``handlerName``, ``boost``, ``available``, ``sortOrder``) sowie zusätzlich die folgenden Felder: +Aktualisierungsanfragen erfordern dieselben Pflichtfelder wie beim Erstellen (``name``, ``handler_name``, ``boost``, ``available``, ``sort_order``) sowie zusätzlich die folgenden Felder: .. list-table:: :header-rows: 1 @@ -265,7 +265,7 @@ Aktualisierungsanfragen erfordern dieselben Pflichtfelder wie beim Erstellen (`` * - ``id`` - Ja - ID der zu aktualisierenden Konfiguration - * - ``versionNo`` + * - ``version_no`` - Ja - Versionsnummer für optimistisches Sperren (den beim Abrufen erhaltenen Wert angeben) @@ -341,12 +341,12 @@ Datenbank-Crawl-Konfiguration -H "Content-Type: application/json" \ -d '{ "name": "User Database", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/userdb\nusername=dbuser\npassword=dbpass\nsql=SELECT * FROM users WHERE active=true", - "handlerScript": "url=\"https://example.com/user/\" + user_id\ntitle=username\ncontent=profile", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/userdb\nusername=dbuser\npassword=dbpass\nsql=SELECT * FROM users WHERE active=true", + "handler_script": "url=\"https://example.com/user/\" + user_id\ntitle=username\ncontent=profile", "boost": 1.0, "available": "true", - "sortOrder": 0 + "sort_order": 0 }' Referenzinformationen diff --git a/de/15.9/api/admin/api-admin-dict.rst b/de/15.9/api/admin/api-admin-dict.rst index fb11dc93f..7d00c8059 100644 --- a/de/15.9/api/admin/api-admin-dict.rst +++ b/de/15.9/api/admin/api-admin-dict.rst @@ -179,7 +179,7 @@ Die Felder der einzelnen Einträge im Array ``settings`` der Antwort unterscheid "settings": [ { "id": 1, - "dictId": "ZjA5...synonym.txt", + "dict_id": "ZjA5...synonym.txt", "inputs": "検索,サーチ", "outputs": "検索,サーチ,リサーチ" } @@ -233,7 +233,7 @@ Response "status": 0, "setting": { "id": 1, - "dictId": "ZjA5...synonym.txt", + "dict_id": "ZjA5...synonym.txt", "inputs": "検索,サーチ", "outputs": "検索,サーチ,リサーチ" } @@ -406,7 +406,7 @@ Eintragsfelder je Wörterbuchtyp =============================== Die Felder im Request-Body zum Erstellen/Aktualisieren von Wörterbucheinträgen sowie in der Antwort unterscheiden sich je Wörterbuchtyp. -``id`` (Eintrags-ID) und ``dictId`` (Wörterbuch-ID) sind in der Antwort gemeinsam enthalten. +``id`` (Eintrags-ID) und ``dict_id`` (Wörterbuch-ID) sind in der Antwort gemeinsam enthalten. .. list-table:: :header-rows: 1 diff --git a/de/15.9/api/admin/api-admin-elevateword.rst b/de/15.9/api/admin/api-admin-elevateword.rst index 79c1a744d..6e674fa8d 100644 --- a/de/15.9/api/admin/api-admin-elevateword.rst +++ b/de/15.9/api/admin/api-admin-elevateword.rst @@ -92,11 +92,11 @@ Response "settings": [ { "id": "elevate_id_1", - "suggestWord": "fess", + "suggest_word": "fess", "reading": "", "permissions": "{role}guest", "boost": 100.0, - "labelTypeIds": [] + "label_type_ids": [] } ], "total": 5 @@ -123,11 +123,11 @@ Response "status": 0, "setting": { "id": "elevate_id_1", - "suggestWord": "fess", + "suggest_word": "fess", "reading": "", "permissions": "{role}guest", "boost": 100.0, - "labelTypeIds": [] + "label_type_ids": [] } } } @@ -149,11 +149,11 @@ Request-Body .. code-block:: json { - "suggestWord": "documentation", + "suggest_word": "documentation", "reading": "", "permissions": "{role}guest", "boost": 100.0, - "labelTypeIds": ["label1"] + "label_type_ids": ["label1"] } Feldbeschreibungen @@ -166,7 +166,7 @@ Feldbeschreibungen * - Feld - Erforderlich - Beschreibung - * - ``suggestWord`` + * - ``suggest_word`` - Ja - Das hervorzuhebende Schlüsselwort * - ``reading`` @@ -178,7 +178,7 @@ Feldbeschreibungen * - ``boost`` - Ja - Boost-Wert (Formular-Standardwert: 100.0) - * - ``labelTypeIds`` + * - ``label_type_ids`` - Nein - Ziel-Label-IDs (Array von Zeichenketten) @@ -213,12 +213,12 @@ Request-Body { "id": "existing_elevate_id", - "suggestWord": "documentation", + "suggest_word": "documentation", "reading": "", "permissions": "{role}guest\n{role}user", "boost": 100.0, - "labelTypeIds": ["label1"], - "versionNo": 1 + "label_type_ids": ["label1"], + "version_no": 1 } .. note:: @@ -226,7 +226,7 @@ Request-Body Bei einer Aktualisierung sind zusätzlich zu den Feldern, die bei der Erstellung verwendet werden, folgende Felder erforderlich: - ``id`` - ID des zu aktualisierenden Elevate Words - - ``versionNo`` - Versionsnummer für optimistisches Sperren. Geben Sie den Wert an, der über ``GET /setting/{id}`` abgerufen wurde. + - ``version_no`` - Versionsnummer für optimistisches Sperren. Geben Sie den Wert an, der über ``GET /setting/{id}`` abgerufen wurde. Response -------- @@ -326,7 +326,7 @@ Produktnamen hervorheben -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "suggestWord": "Product X", + "suggest_word": "Product X", "boost": 100.0, "permissions": "{role}guest" }' @@ -340,9 +340,9 @@ Hervorheben für ein bestimmtes Label -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "suggestWord": "API reference", + "suggest_word": "API reference", "boost": 100.0, - "labelTypeIds": ["technical_docs"], + "label_type_ids": ["technical_docs"], "permissions": "{role}guest" }' diff --git a/de/15.9/api/admin/api-admin-failureurl.rst b/de/15.9/api/admin/api-admin-failureurl.rst index 55c1690d4..6bad72ecb 100644 --- a/de/15.9/api/admin/api-admin-failureurl.rst +++ b/de/15.9/api/admin/api-admin-failureurl.rst @@ -71,15 +71,15 @@ Parameter - String - Nein - URL-Filter (Wildcards ``*`` ``?`` werden unterstützt) - * - ``errorCountMin`` + * - ``error_count_min`` - Integer - Nein - Untergrenze für die Fehleranzahl (größer als oder gleich dem angegebenen Wert) - * - ``errorCountMax`` + * - ``error_count_max`` - Integer - Nein - Obergrenze für die Fehleranzahl (kleiner als oder gleich dem angegebenen Wert) - * - ``errorName`` + * - ``error_name`` - String - Nein - Fehlername-Filter (Wildcard-Abgleich mit dem gespeicherten vollständig qualifizierten Klassennamen; ``*`` ``?`` werden unterstützt) @@ -96,22 +96,22 @@ Response { "id": "failure_id_1", "url": "https://example.com/broken-page", - "threadName": "Crawler-1", - "errorName": "java.net.ConnectException", - "errorLog": "Connection refused: connect", - "errorCount": "3", - "lastAccessTime": "1738144800000", - "configId": "webConfig_id_1" + "thread_name": "Crawler-1", + "error_name": "java.net.ConnectException", + "error_log": "Connection refused: connect", + "error_count": "3", + "last_access_time": "1738144800000", + "config_id": "webConfig_id_1" }, { "id": "failure_id_2", "url": "https://example.com/not-found", - "threadName": "Crawler-2", - "errorName": "org.codelibs.fess.exception.ContentNotFoundException", - "errorLog": "Not found: https://example.com/not-found", - "errorCount": "1", - "lastAccessTime": "1738143000000", - "configId": "webConfig_id_1" + "thread_name": "Crawler-2", + "error_name": "org.codelibs.fess.exception.ContentNotFoundException", + "error_log": "Not found: https://example.com/not-found", + "error_count": "1", + "last_access_time": "1738143000000", + "config_id": "webConfig_id_1" } ], "total": 45 @@ -131,22 +131,22 @@ Response-Felder - Fehlgeschlagene-URL-ID * - ``url`` - Die fehlgeschlagene URL - * - ``threadName`` + * - ``thread_name`` - Thread-Name - * - ``errorName`` + * - ``error_name`` - Fehlername (vollständig qualifizierter Klassenname der aufgetretenen Ausnahme; z. B. ``java.net.ConnectException``) - * - ``errorLog`` + * - ``error_log`` - Fehlerprotokoll (Ausnahme-Meldung oder Stack-Trace) - * - ``errorCount`` + * - ``error_count`` - Anzahl der aufgetretenen Fehler (numerischer Wert als Zeichenkette) - * - ``lastAccessTime`` + * - ``last_access_time`` - Letzte Zugriffszeit (Epoch-Millisekunden als Zeichenkette) - * - ``configId`` + * - ``config_id`` - Crawl-Konfigurations-ID .. note:: - Alle Antwortfelder werden als Zeichenketten (JSON string) zurückgegeben. ``errorCount`` ist ein numerischer Wert, der als Zeichenkette dargestellt wird, und ``lastAccessTime`` sind Epoch-Millisekunden, die als Zeichenkette dargestellt werden. + Alle Antwortfelder werden als Zeichenketten (JSON string) zurückgegeben. ``error_count`` ist ein numerischer Wert, der als Zeichenkette dargestellt wird, und ``last_access_time`` sind Epoch-Millisekunden, die als Zeichenkette dargestellt werden. Fehlgeschlagene URL abrufen =========================== @@ -169,12 +169,12 @@ Response "log": { "id": "failure_id_1", "url": "https://example.com/broken-page", - "threadName": "Crawler-1", - "errorName": "java.net.ConnectException", - "errorLog": "Connection refused: connect", - "errorCount": "3", - "lastAccessTime": "1738144800000", - "configId": "webConfig_id_1" + "thread_name": "Crawler-1", + "error_name": "java.net.ConnectException", + "error_log": "Connection refused: connect", + "error_count": "3", + "last_access_time": "1738144800000", + "config_id": "webConfig_id_1" } } } @@ -226,7 +226,7 @@ Response Fehlertypen =========== -``errorName`` speichert den vollständig qualifizierten Klassennamen der Ausnahme, die während des Crawlings aufgetreten ist, genau so wie er erfasst wurde. Es handelt sich nicht um eine feste Aufzählung; je nach ausgelöster Ausnahme kann ein beliebiger Klassenname erscheinen. Im Folgenden sind repräsentative Beispiele aufgeführt. +``error_name`` speichert den vollständig qualifizierten Klassennamen der Ausnahme, die während des Crawlings aufgetreten ist, genau so wie er erfasst wurde. Es handelt sich nicht um eine feste Aufzählung; je nach ausgelöster Ausnahme kann ein beliebiger Klassenname erscheinen. Im Folgenden sind repräsentative Beispiele aufgeführt. .. list-table:: :header-rows: 1 @@ -310,7 +310,7 @@ Nach Fehlertyp aggregieren # Anzahl nach Fehlertyp zählen curl -X GET "http://localhost:8080/api/admin/failureurl/logs?size=1000" \ -H "Authorization: Bearer YOUR_TOKEN" | \ - jq '[.response.logs[].errorName] | group_by(.) | map({error: .[0], count: length})' + jq '[.response.logs[].error_name] | group_by(.) | map({error: .[0], count: length})' Referenzinformationen ===================== diff --git a/de/15.9/api/admin/api-admin-fileconfig.rst b/de/15.9/api/admin/api-admin-fileconfig.rst index 8c8efabaf..abc1215be 100644 --- a/de/15.9/api/admin/api-admin-fileconfig.rst +++ b/de/15.9/api/admin/api-admin-fileconfig.rst @@ -106,20 +106,20 @@ Response "name": "Shared Documents", "description": "Gemeinsame Dokumente", "paths": "smb://server/share/documents", - "includedPaths": ".*\\.pdf$", - "excludedPaths": ".*/(temp|cache)/.*", - "includedDocPaths": "", - "excludedDocPaths": "", - "configParameter": "", + "included_paths": ".*\\.pdf$", + "excluded_paths": ".*/(temp|cache)/.*", + "included_doc_paths": "", + "excluded_doc_paths": "", + "config_parameter": "", "depth": 10, - "maxAccessCount": 1000, - "numOfThread": 1, - "intervalTime": 1000, + "max_access_count": 1000, + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, "available": "true", "permissions": "{role}admin", - "virtualHosts": "", - "sortOrder": 0 + "virtual_hosts": "", + "sort_order": 0 } ], "total": 5 @@ -151,34 +151,34 @@ Response "name": "Shared Documents", "description": "Gemeinsame Dokumente", "paths": "smb://server/share/documents", - "includedPaths": ".*\\.pdf$", - "excludedPaths": ".*/(temp|cache)/.*", - "includedDocPaths": "", - "excludedDocPaths": "", - "configParameter": "", + "included_paths": ".*\\.pdf$", + "excluded_paths": ".*/(temp|cache)/.*", + "included_doc_paths": "", + "excluded_doc_paths": "", + "config_parameter": "", "depth": 10, - "maxAccessCount": 1000, - "numOfThread": 1, - "intervalTime": 1000, + "max_access_count": 1000, + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin", - "virtualHosts": "", - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_hosts": "", + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } .. note:: - Die Response enthält die vom Server automatisch gesetzten Felder ``createdBy``, ``createdTime``, - ``updatedBy``, ``updatedTime`` und ``versionNo``. - ``versionNo`` wird bei der Aktualisierung benötigt (siehe „Datei-Crawl-Konfiguration aktualisieren" weiter unten). + Die Response enthält die vom Server automatisch gesetzten Felder ``created_by``, ``created_time``, + ``updated_by``, ``updated_time`` und ``version_no``. + ``version_no`` wird bei der Aktualisierung benötigt (siehe „Datei-Crawl-Konfiguration aktualisieren" weiter unten). Datei-Crawl-Konfiguration erstellen ===================================== @@ -199,13 +199,13 @@ Request-Body { "name": "Local Files", "paths": "file:///data/documents", - "includedPaths": ".*\\.(pdf|doc|docx|xls|xlsx)$", - "excludedPaths": ".*/(temp|backup)/.*", - "numOfThread": 2, - "intervalTime": 500, + "included_paths": ".*\\.(pdf|doc|docx|xls|xlsx)$", + "excluded_paths": ".*/(temp|backup)/.*", + "num_of_thread": 2, + "interval_time": 500, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin\n{role}user" } @@ -228,31 +228,31 @@ Feldbeschreibungen * - ``paths`` - Ja - Crawl-Startpfade (bei mehreren durch Zeilenumbruch getrennt). Anzugeben mit einem der Protokolle ``file:``, ``smb:``, ``smb1:``, ``ftp:``, ``s3:`` oder ``gcs:`` - * - ``includedPaths`` + * - ``included_paths`` - Nein - Regex-Muster für zu crawlende Pfade - * - ``excludedPaths`` + * - ``excluded_paths`` - Nein - Regex-Muster für auszuschließende Pfade - * - ``includedDocPaths`` + * - ``included_doc_paths`` - Nein - Regex-Muster für zu indexierende Pfade - * - ``excludedDocPaths`` + * - ``excluded_doc_paths`` - Nein - Regex-Muster für vom Index auszuschließende Pfade - * - ``configParameter`` + * - ``config_parameter`` - Nein - Zusätzliche Konfigurationsparameter (Format ``key=value``, ein Eintrag pro Zeile) * - ``depth`` - Nein - Crawl-Tiefe (0 oder größer) - * - ``maxAccessCount`` + * - ``max_access_count`` - Nein - Maximale Zugriffsanzahl (0 oder größer) - * - ``numOfThread`` + * - ``num_of_thread`` - Ja - Anzahl paralleler Threads (1 oder größer) - * - ``intervalTime`` + * - ``interval_time`` - Ja - Zugriffsintervall (Millisekunden, 0 oder größer) * - ``boost`` @@ -261,19 +261,19 @@ Feldbeschreibungen * - ``available`` - Ja - Aktiviert/Deaktiviert (Zeichenkette ``"true"`` / ``"false"``) - * - ``sortOrder`` + * - ``sort_order`` - Ja - Anzeigereihenfolge (0 oder größer) * - ``permissions`` - Nein - Zugriffsberechtigte Rollen (bei mehreren durch Zeilenumbruch getrennt) - * - ``virtualHosts`` + * - ``virtual_hosts`` - Nein - Virtuelle Hosts (bei mehreren durch Zeilenumbruch getrennt) .. note:: - Audit-Felder wie ``createdBy``, ``createdTime``, ``updatedBy`` und ``updatedTime`` werden + Audit-Felder wie ``created_by``, ``created_time``, ``updated_by`` und ``updated_time`` werden serverseitig automatisch gesetzt und müssen nicht im Request-Body angegeben werden. Response @@ -303,8 +303,8 @@ Request Request-Body ~~~~~~~~~~~~ -Bei der Aktualisierung sind neben den Feldern aus der Erstellung zusätzlich ``id`` zur Identifikation der Zielkonfiguration und ``versionNo`` als Versionsnummer erforderlich. -Für ``versionNo`` ist der aktuelle Wert aus der Response der Abruf-API (GET) anzugeben. +Bei der Aktualisierung sind neben den Feldern aus der Erstellung zusätzlich ``id`` zur Identifikation der Zielkonfiguration und ``version_no`` als Versionsnummer erforderlich. +Für ``version_no`` ist der aktuelle Wert aus der Response der Abruf-API (GET) anzugeben. .. code-block:: json @@ -312,16 +312,16 @@ Für ``versionNo`` ist der aktuelle Wert aus der Response der Abruf-API (GET) an "id": "existing_fileconfig_id", "name": "Updated Local Files", "paths": "file:///data/documents", - "includedPaths": ".*\\.(pdf|doc|docx|xls|xlsx|ppt|pptx)$", - "excludedPaths": ".*/(temp|backup|archive)/.*", + "included_paths": ".*\\.(pdf|doc|docx|xls|xlsx|ppt|pptx)$", + "excluded_paths": ".*/(temp|backup|archive)/.*", "depth": 10, - "maxAccessCount": 10000, - "numOfThread": 3, - "intervalTime": 300, + "max_access_count": 10000, + "num_of_thread": 3, + "interval_time": 300, "boost": 1.2, "available": "true", - "sortOrder": 0, - "versionNo": 1 + "sort_order": 0, + "version_no": 1 } Zusätzliche Felder bei der Aktualisierung @@ -337,9 +337,9 @@ Zusätzliche Felder bei der Aktualisierung * - ``id`` - Ja - Konfigurations-ID der zu aktualisierenden Konfiguration (max. 1000 Zeichen) - * - ``versionNo`` + * - ``version_no`` - Ja - - Aktuelle Versionsnummer der zu aktualisierenden Konfiguration. Anzugeben ist der ``versionNo``-Wert aus der Response der Abruf-API (GET) + - Aktuelle Versionsnummer der zu aktualisierenden Konfiguration. Anzugeben ist der ``version_no``-Wert aus der Response der Abruf-API (GET) Response -------- @@ -418,13 +418,13 @@ Crawl-Konfiguration für lokale Dateien -d '{ "name": "Local Files", "paths": "file:///data/documents", - "includedPaths": ".*\\.(pdf|doc|docx)$", - "excludedPaths": ".*/(temp|backup)/.*", - "numOfThread": 2, - "intervalTime": 500, + "included_paths": ".*\\.(pdf|doc|docx)$", + "excluded_paths": ".*/(temp|backup)/.*", + "num_of_thread": 2, + "interval_time": 500, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}guest" }' @@ -439,14 +439,14 @@ Crawl-Konfiguration für SMB-Freigaben -d '{ "name": "SMB Share", "paths": "smb://server/documents", - "includedPaths": ".*\\.(pdf|doc|docx)$", - "excludedPaths": ".*/(temp|private)/.*", - "maxAccessCount": 50000, - "numOfThread": 3, - "intervalTime": 200, + "included_paths": ".*\\.(pdf|doc|docx)$", + "excluded_paths": ".*/(temp|private)/.*", + "max_access_count": 50000, + "num_of_thread": 3, + "interval_time": 200, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}guest" }' diff --git a/de/15.9/api/admin/api-admin-general.rst b/de/15.9/api/admin/api-admin-general.rst index 4a872b18b..6c401d881 100644 --- a/de/15.9/api/admin/api-admin-general.rst +++ b/de/15.9/api/admin/api-admin-general.rst @@ -69,37 +69,36 @@ Zahlen ausgedrückt werden. "version": "15.9.0", "status": 0, "setting": { - "incrementalCrawling": "true", - "dayForCleanup": -1, - "crawlingThreadCount": 5, - "searchLog": "true", - "userInfo": "true", - "userFavorite": "false", - "webApiJson": "true", - "defaultLabelValue": "", - "defaultSortValue": "", - "appendQueryParameter": "false", - "loginRequired": "false", + "incremental_crawling": "true", + "day_for_cleanup": -1, + "crawling_thread_count": 5, + "search_log": "true", + "user_info": "true", + "user_favorite": "false", + "web_api_json": "true", + "default_label_value": "", + "default_sort_value": "", + "append_query_parameter": "false", + "login_required": "false", "thumbnail": "true", - "failureCountThreshold": -1, - "popularWord": "true", - "csvFileEncoding": "UTF-8", - "purgeSearchLogDay": 30, - "purgeJobLogDay": 30, - "purgeUserInfoDay": 30, - "purgeSuggestSearchLogDay": 30, - "notificationTo": "", - "suggestSearchLog": "true", - "suggestDocuments": "true", - "ldapProviderUrl": "ldap://localhost:389/", - "ldapBaseDn": "dc=example,dc=com", - "ldapAdminSecurityPrincipal": "cn=admin,dc=example,dc=com", - "ldapAdminSecurityCredentials": null, - "logLevel": "", - "ssoType": "none", - "storageType": "", - "notificationLogin": "", - "notificationSearchTop": "" + "failure_count_threshold": -1, + "popular_word": "true", + "csv_file_encoding": "UTF-8", + "purge_search_log_day": 30, + "purge_job_log_day": 30, + "purge_user_info_day": 30, + "purge_suggest_search_log_day": 30, + "notification_to": "", + "suggest_search_log": "true", + "suggest_documents": "true", + "ldap_provider_url": "ldap://localhost:389/", + "ldap_base_dn": "dc=example,dc=com", + "ldap_admin_security_principal": "cn=admin,dc=example,dc=com", + "log_level": "", + "sso_type": "none", + "storage_type": "", + "notification_login": "", + "notification_search_top": "" } } } @@ -116,11 +115,11 @@ Zahlen ausgedrückt werden. Aus Sicherheitsgründen werden Felder mit Anmeldeinformationen nicht mit ihren tatsächlichen Werten in der Antwort zurückgegeben. - - Das LDAP-Administratorpasswort ``ldapAdminSecurityCredentials`` wird stets als - ``null`` zurückgegeben. - - Andere Secrets (``storageAccessKey`` / ``storageSecretKey`` / - ``oicClientId`` / ``oicClientSecret`` / ``spnegoPreauthPassword`` / - ``entraidClientId`` / ``entraidClientSecret``) werden bei gesetztem Wert als + - Das LDAP-Administratorpasswort ``ldap_admin_security_credentials`` ist nie in der + Antwort enthalten. + - Andere Secrets (``storage_access_key`` / ``storage_secret_key`` / + ``oic_client_id`` / ``oic_client_secret`` / ``spnego_preauth_password`` / + ``entraid_client_id`` / ``entraid_client_secret``) werden bei gesetztem Wert als Maskierungswert ``"**********"`` zurückgegeben, bzw. als leere Zeichenkette (``""``), wenn sie nicht gesetzt sind. @@ -149,10 +148,10 @@ ihre vorhandenen Werte. Die folgenden vier Felder sind erforderlich und MÜSSEN in **jedem** PUT-Request enthalten sein, auch bei einer partiellen Aktualisierung: - - ``dayForCleanup`` - - ``crawlingThreadCount`` - - ``failureCountThreshold`` - - ``csvFileEncoding`` + - ``day_for_cleanup`` + - ``crawling_thread_count`` + - ``failure_count_threshold`` + - ``csv_file_encoding`` Fehlt eines dieser Felder, schlägt die Validierung fehl und die API gibt HTTP 400 mit ``status: 1`` und einer Fehlermeldung ``message`` zurück. Da der @@ -181,12 +180,12 @@ ihre vorhandenen Werte. .. code-block:: json { - "incrementalCrawling": "true", - "dayForCleanup": -1, - "crawlingThreadCount": 10, - "failureCountThreshold": 100, - "csvFileEncoding": "UTF-8", - "popularWord": "true" + "incremental_crawling": "true", + "day_for_cleanup": -1, + "crawling_thread_count": 10, + "failure_count_threshold": 100, + "csv_file_encoding": "UTF-8", + "popular_word": "true" } Wichtigste Felder @@ -204,124 +203,124 @@ Admin-Oberfläche). Ein-/Aus-Einstellungen werden als Zeichenketten ``"true"`` / * - Feld - Erforderlich - Beschreibung - * - ``incrementalCrawling`` + * - ``incremental_crawling`` - Nein - Inkrementelles Crawling aktivieren/deaktivieren - * - ``dayForCleanup`` + * - ``day_for_cleanup`` - Ja - Anzahl der Tage, die gecrawlte Dokumente aufbewahrt werden (-1 = Cleanup deaktiviert; Bereich: -1 bis 1000) - * - ``crawlingThreadCount`` + * - ``crawling_thread_count`` - Ja - Anzahl der für das Crawling verwendeten Threads (Bereich: 0 bis 100) - * - ``failureCountThreshold`` + * - ``failure_count_threshold`` - Ja - Schwellenwert der Fehleranzahl, ab der das Crawling einer URL gestoppt wird (-1 = deaktiviert; Bereich: -1 bis 10000) - * - ``csvFileEncoding`` + * - ``csv_file_encoding`` - Ja - Kodierung des CSV-Exports - * - ``searchLog`` + * - ``search_log`` - Nein - Suchanfragen-Protokoll aktivieren/deaktivieren - * - ``userInfo`` + * - ``user_info`` - Nein - Aufzeichnung von Benutzerinformationen aktivieren/deaktivieren - * - ``userFavorite`` + * - ``user_favorite`` - Nein - Favoriten-Funktion aktivieren/deaktivieren - * - ``webApiJson`` + * - ``web_api_json`` - Nein - JSON-Web-API aktivieren/deaktivieren - * - ``appValue`` + * - ``app_value`` - Nein - Anwendungsspezifischer zusätzlicher Konfigurationswert - * - ``virtualHostValue`` + * - ``virtual_host_value`` - Nein - Virtuelle-Host-Konfiguration (für Mehrmandanten-Setups) - * - ``popularWord`` + * - ``popular_word`` - Nein - Aggregation/Anzeige beliebter Wörter aktivieren/deaktivieren - * - ``defaultLabelValue`` + * - ``default_label_value`` - Nein - Standard-Labelwert - * - ``defaultSortValue`` + * - ``default_sort_value`` - Nein - Standard-Sortierreihenfolge - * - ``appendQueryParameter`` + * - ``append_query_parameter`` - Nein - Anfügen von Abfrageparametern an die Suchergebnis-URL - * - ``loginRequired`` + * - ``login_required`` - Nein - Ob für die Suche eine Anmeldung erforderlich ist - * - ``loginLink`` + * - ``login_link`` - Nein - Anzeige des Anmeldelinks auf der Suchseite aktivieren/deaktivieren * - ``thumbnail`` - Nein - Generierung von Vorschaubildern aktivieren/deaktivieren - * - ``resultCollapsed`` + * - ``result_collapsed`` - Nein - Einklappen ähnlicher Dokumente in den Suchergebnissen aktivieren/deaktivieren - * - ``ignoreFailureType`` + * - ``ignore_failure_type`` - Nein - Zu ignorierende Crawl-Fehlertypen - * - ``crawlingUserAgent`` + * - ``crawling_user_agent`` - Nein - User-Agent-Zeichenkette, die beim Crawling gesendet wird - * - ``purgeSearchLogDay`` + * - ``purge_search_log_day`` - Nein - Anzahl der Tage, die das Suchprotokoll aufbewahrt wird (-1 = deaktiviert; Bereich: -1 bis 100000) - * - ``purgeJobLogDay`` + * - ``purge_job_log_day`` - Nein - Anzahl der Tage, die das Job-Protokoll aufbewahrt wird (-1 = deaktiviert; Bereich: -1 bis 100000) - * - ``purgeUserInfoDay`` + * - ``purge_user_info_day`` - Nein - Anzahl der Tage, die Benutzerinformationen aufbewahrt werden (-1 = deaktiviert; Bereich: -1 bis 100000) - * - ``purgeSuggestSearchLogDay`` + * - ``purge_suggest_search_log_day`` - Nein - Anzahl der Tage, die das Suggest-Suchprotokoll aufbewahrt wird (0 = deaktiviert; Bereich: 0 bis 100000) - * - ``purgeByBots`` + * - ``purge_by_bots`` - Nein - Bot-User-Agents, deren Suchprotokolle verworfen werden - * - ``notificationTo`` + * - ``notification_to`` - Nein - Empfänger-E-Mail-Adresse für Systembenachrichtigungen - * - ``notificationLogin`` + * - ``notification_login`` - Nein - Benachrichtigungstext, der auf der Anmeldeseite angezeigt wird - * - ``notificationSearchTop`` + * - ``notification_search_top`` - Nein - Benachrichtigungstext, der auf der Suchstartseite angezeigt wird - * - ``notificationAdvanceSearch`` + * - ``notification_advance_search`` - Nein - Benachrichtigungstext, der auf der erweiterten Suchseite angezeigt wird - * - ``suggestSearchLog`` + * - ``suggest_search_log`` - Nein - Suggest aus dem Suchprotokoll aktivieren/deaktivieren - * - ``suggestDocuments`` + * - ``suggest_documents`` - Nein - Suggest aus Dokumenten aktivieren/deaktivieren - * - ``logLevel`` + * - ``log_level`` - Nein - Log-Level des Systemprotokolls - * - ``logNotificationEnabled`` + * - ``log_notification_enabled`` - Nein - Benachrichtigung über ERROR/WARN-Protokolle aktivieren/deaktivieren - * - ``logNotificationLevel`` + * - ``log_notification_level`` - Nein - Log-Benachrichtigungsstufe - * - ``slackWebhookUrls`` + * - ``slack_webhook_urls`` - Nein - Slack-Webhook-URL für Benachrichtigungen - * - ``googleChatWebhookUrls`` + * - ``google_chat_webhook_urls`` - Nein - Google-Chat-Webhook-URL für Benachrichtigungen - * - ``searchUseBrowserLocale`` + * - ``search_use_browser_locale`` - Nein - Ob der Browser-Locale bei der Suche verwendet werden soll - * - ``ragLlmName`` + * - ``rag_llm_name`` - Nein - Name des LLM-Providers für RAG - * - ``llmLogLevel`` + * - ``llm_log_level`` - Nein - Log-Level für LLM-bezogene Pakete @@ -339,29 +338,29 @@ Admin-Oberfläche). * - Feld - Beschreibung - * - ``ldapProviderUrl`` + * - ``ldap_provider_url`` - LDAP-Verbindungs-URL - * - ``ldapBaseDn`` + * - ``ldap_base_dn`` - LDAP-Basis-DN - * - ``ldapSecurityPrincipal`` + * - ``ldap_security_principal`` - Security Principal für die LDAP-Bindung - * - ``ldapAdminSecurityPrincipal`` + * - ``ldap_admin_security_principal`` - Security Principal für LDAP-Verwaltungsoperationen - * - ``ldapAdminSecurityCredentials`` - - LDAP-Administratorpasswort (in der Antwort durch ``null`` ersetzt) - * - ``ldapAccountFilter`` / ``ldapGroupFilter`` + * - ``ldap_admin_security_credentials`` + - LDAP-Administratorpasswort (nie in der Antwort enthalten) + * - ``ldap_account_filter`` / ``ldap_group_filter`` - Suchfilter für Benutzer/Gruppen - * - ``ldapMemberofAttribute`` + * - ``ldap_memberof_attribute`` - LDAP-Attributname, der die Gruppenzugehörigkeit angibt - * - ``ssoType`` + * - ``sso_type`` - SSO-Typ (``none`` / ``oic`` / ``saml`` / ``spnego`` / ``entraid``) - * - ``oicClientId`` / ``oicClientSecret`` / ``oicAuthServerUrl`` usw. + * - ``oic_client_id`` / ``oic_client_secret`` / ``oic_auth_server_url`` usw. - OpenID-Connect-Einstellungen - * - ``samlIdpEntityid`` / ``samlSpEntityid`` usw. + * - ``saml_idp_entityid`` / ``saml_sp_entityid`` usw. - SAML-Einstellungen - * - ``spnegoKrb5Conf`` / ``spnegoLoginConf`` usw. + * - ``spnego_krb5_conf`` / ``spnego_login_conf`` usw. - SPNEGO-Einstellungen - * - ``entraidClientId`` / ``entraidTenant`` usw. + * - ``entraid_client_id`` / ``entraid_tenant`` usw. - Microsoft-Entra-ID-Einstellungen Speicherbezogene Felder @@ -376,24 +375,24 @@ verwaltet werden. * - Feld - Beschreibung - * - ``storageType`` + * - ``storage_type`` - Speichertyp (``auto`` / ``s3`` / ``gcs``) - * - ``storageEndpoint`` + * - ``storage_endpoint`` - Endpunkt-URL des Speichers - * - ``storageAccessKey`` / ``storageSecretKey`` + * - ``storage_access_key`` / ``storage_secret_key`` - Access Key / Secret Key für die Authentifizierung - * - ``storageBucket`` + * - ``storage_bucket`` - Bucket-Name - * - ``storageRegion`` + * - ``storage_region`` - S3-Region - * - ``storageProjectId`` / ``storageCredentialsPath`` + * - ``storage_project_id`` / ``storage_credentials_path`` - GCS-Projekt-ID / Pfad zur Anmeldeinformationsdatei .. note:: - Secret-Felder wie ``ldapAdminSecurityCredentials``, ``storageAccessKey`` / - ``storageSecretKey``, ``oicClientId`` / ``oicClientSecret``, - ``entraidClientId`` / ``entraidClientSecret`` sowie ``spnegoPreauthPassword`` + Secret-Felder wie ``ldap_admin_security_credentials``, ``storage_access_key`` / + ``storage_secret_key``, ``oic_client_id`` / ``oic_client_secret``, + ``entraid_client_id`` / ``entraid_client_secret`` sowie ``spnego_preauth_password`` behalten ihren gespeicherten Wert (werden nicht aktualisiert), wenn der Maskierungswert ``"**********"`` unverändert gesendet wird. Senden Sie den tatsächlichen Wert nur dann, wenn Sie ihn ändern möchten. @@ -429,8 +428,8 @@ Verwendungsbeispiele .. note:: - Die nachstehenden Beispiele enthalten die Pflichtfelder (``dayForCleanup``, - ``crawlingThreadCount``, ``failureCountThreshold``, ``csvFileEncoding``). Da + Die nachstehenden Beispiele enthalten die Pflichtfelder (``day_for_cleanup``, + ``crawling_thread_count``, ``failure_count_threshold``, ``csv_file_encoding``). Da diese unabhängig von der jeweiligen Änderung stets angegeben werden müssen, rufen Sie im realen Betrieb die aktuellen Werte über ``GET`` ab und geben Sie sie an (die folgenden Beispiele verwenden Standardwerte). @@ -444,11 +443,11 @@ Crawl-Einstellungen aktualisieren -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "incrementalCrawling": "true", - "crawlingThreadCount": 10, - "failureCountThreshold": 100, - "dayForCleanup": -1, - "csvFileEncoding": "UTF-8" + "incremental_crawling": "true", + "crawling_thread_count": 10, + "failure_count_threshold": 100, + "day_for_cleanup": -1, + "csv_file_encoding": "UTF-8" }' Protokoll-Aufbewahrungsdauer aktualisieren @@ -460,13 +459,13 @@ Protokoll-Aufbewahrungsdauer aktualisieren -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "dayForCleanup": -1, - "crawlingThreadCount": 5, - "failureCountThreshold": -1, - "csvFileEncoding": "UTF-8", - "purgeSearchLogDay": 90, - "purgeJobLogDay": 90, - "purgeUserInfoDay": 90 + "day_for_cleanup": -1, + "crawling_thread_count": 5, + "failure_count_threshold": -1, + "csv_file_encoding": "UTF-8", + "purge_search_log_day": 90, + "purge_job_log_day": 90, + "purge_user_info_day": 90 }' Suggest-Einstellungen aktualisieren @@ -478,12 +477,12 @@ Suggest-Einstellungen aktualisieren -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "dayForCleanup": -1, - "crawlingThreadCount": 5, - "failureCountThreshold": -1, - "csvFileEncoding": "UTF-8", - "suggestSearchLog": "true", - "suggestDocuments": "true" + "day_for_cleanup": -1, + "crawling_thread_count": 5, + "failure_count_threshold": -1, + "csv_file_encoding": "UTF-8", + "suggest_search_log": "true", + "suggest_documents": "true" }' Referenzinformationen diff --git a/de/15.9/api/admin/api-admin-group.rst b/de/15.9/api/admin/api-admin-group.rst index de8e28616..dea5e24a0 100644 --- a/de/15.9/api/admin/api-admin-group.rst +++ b/de/15.9/api/admin/api-admin-group.rst @@ -90,7 +90,7 @@ Response "attributes": { "gidNumber": "1000" }, - "versionNo": 1 + "version_no": 1 }, { "id": "group_id_2", @@ -98,7 +98,7 @@ Response "attributes": { "gidNumber": "1001" }, - "versionNo": 1 + "version_no": 1 } ], "total": 5 @@ -129,7 +129,7 @@ Response "attributes": { "gidNumber": "1000" }, - "versionNo": 1 + "version_no": 1 } } } @@ -209,7 +209,7 @@ Request-Body "attributes": { "gidNumber": "1002" }, - "versionNo": 1 + "version_no": 1 } Feldbeschreibungen @@ -231,9 +231,9 @@ Feldbeschreibungen * - ``attributes`` - Nein - Attribut-Map (enthält LDAP-Attribute wie ``gidNumber``). Werte werden als Zeichenketten angegeben - * - ``versionNo`` + * - ``version_no`` - Ja - - Versionsnummer für optimistisches Sperren. Geben Sie den Wert von ``versionNo`` an, der beim Abrufen der Gruppe ermittelt wurde + - Versionsnummer für optimistisches Sperren. Geben Sie den Wert von ``version_no`` an, der beim Abrufen der Gruppe ermittelt wurde Response -------- diff --git a/de/15.9/api/admin/api-admin-joblog.rst b/de/15.9/api/admin/api-admin-joblog.rst index e04f97e2a..e19064ea9 100644 --- a/de/15.9/api/admin/api-admin-joblog.rst +++ b/de/15.9/api/admin/api-admin-joblog.rst @@ -80,25 +80,25 @@ Response "logs": [ { "id": "joblog_id_1", - "jobName": "Default Crawler", - "jobStatus": "ok", + "job_name": "Default Crawler", + "job_status": "ok", "target": "all", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "scriptResult": "Job completed successfully", - "startTime": "1738116000000", - "endTime": "1738118723000" + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "script_result": "Job completed successfully", + "start_time": "1738116000000", + "end_time": "1738118723000" }, { "id": "joblog_id_2", - "jobName": "Default Crawler", - "jobStatus": "fail", + "job_name": "Default Crawler", + "job_status": "fail", "target": "all", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "scriptResult": "Error: Connection timeout", - "startTime": "1738029600000", - "endTime": "1738030215000" + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "script_result": "Error: Connection timeout", + "start_time": "1738029600000", + "end_time": "1738030215000" } ], "total": 100 @@ -116,26 +116,26 @@ Response-Felder - Beschreibung * - ``id`` - Job-Protokoll-ID - * - ``jobName`` + * - ``job_name`` - Job-Name - * - ``jobStatus`` + * - ``job_status`` - Job-Status (``ok``: Erfolg, ``fail``: Fehlgeschlagen, ``running``: Wird ausgeführt) * - ``target`` - Ausführungsziel (Zielname des Schedulers; Standardwert ist ``all``) - * - ``scriptType`` + * - ``script_type`` - Skript-Typ (z. B. ``javascript``) - * - ``scriptData`` + * - ``script_data`` - Ausführungsskript - * - ``scriptResult`` + * - ``script_result`` - Ausführungsergebnis - * - ``startTime`` + * - ``start_time`` - Startzeit (Epoch-Millisekunden; wird als Zeichenkette zurückgegeben) - * - ``endTime`` + * - ``end_time`` - Endzeit (Epoch-Millisekunden; wird als Zeichenkette zurückgegeben). Bei laufenden Jobs nicht vorhanden. .. note:: - Jedes Log-Objekt in der Antwort enthält außerdem ein internes ``crudMode``-Feld + Jedes Log-Objekt in der Antwort enthält außerdem ein internes ``crud_mode``-Feld (eine Ganzzahl, die den CRUD-Operationsmodus angibt; bei Leseoperationen immer ``0``). Clients können dieses Feld gefahrlos ignorieren. @@ -159,14 +159,14 @@ Response "status": 0, "log": { "id": "joblog_id_1", - "jobName": "Default Crawler", - "jobStatus": "ok", + "job_name": "Default Crawler", + "job_status": "ok", "target": "all", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "scriptResult": "Crawl completed successfully.\nDocuments indexed: 1234\nDocuments updated: 567\nDocuments deleted: 12\nErrors: 0", - "startTime": "1738116000000", - "endTime": "1738118723000" + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "script_result": "Crawl completed successfully.\nDocuments indexed: 1234\nDocuments updated: 567\nDocuments deleted: 12\nErrors: 0", + "start_time": "1738116000000", + "end_time": "1738118723000" } } } diff --git a/de/15.9/api/admin/api-admin-keymatch.rst b/de/15.9/api/admin/api-admin-keymatch.rst index 64910dab3..0ded7bf26 100644 --- a/de/15.9/api/admin/api-admin-keymatch.rst +++ b/de/15.9/api/admin/api-admin-keymatch.rst @@ -92,9 +92,9 @@ Response "id": "keymatch_id_1", "term": "download", "query": "title:download OR content:download", - "maxSize": 10, + "max_size": 10, "boost": 10.0, - "versionNo": 1 + "version_no": 1 } ], "total": 5 @@ -104,8 +104,8 @@ Response .. note:: In ``total`` wird die Gesamtanzahl der Einträge angegeben, die den Filterbedingungen entsprechen (nicht die Anzahl der Einträge auf der aktuellen Seite). - Jedes Einstellungsobjekt kann zusätzlich zu den oben genannten Feldern ``virtualHost``, - ``createdBy``, ``createdTime``, ``updatedBy`` und ``updatedTime`` enthalten, sofern diese Werte gesetzt sind. + Jedes Einstellungsobjekt kann zusätzlich zu den oben genannten Feldern ``virtual_host``, + ``created_by``, ``created_time``, ``updated_by`` und ``updated_time`` enthalten, sofern diese Werte gesetzt sind. KeyMatch abrufen ================ @@ -129,21 +129,21 @@ Response "id": "keymatch_id_1", "term": "download", "query": "title:download OR content:download", - "maxSize": 10, + "max_size": 10, "boost": 10.0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } .. note:: - ``versionNo`` ist die Versionsnummer für optimistisches Sperren. Beim Aktualisieren eines KeyMatch-Eintrags muss der beim Abrufen erhaltene - ``versionNo``-Wert im Request-Body angegeben werden. Falls die angegebene ID nicht existiert, wird ein Fehler zurückgegeben. + ``version_no`` ist die Versionsnummer für optimistisches Sperren. Beim Aktualisieren eines KeyMatch-Eintrags muss der beim Abrufen erhaltene + ``version_no``-Wert im Request-Body angegeben werden. Falls die angegebene ID nicht existiert, wird ein Fehler zurückgegeben. KeyMatch erstellen ================== @@ -164,7 +164,7 @@ Request-Body { "term": "pricing", "query": "url:*/pricing* OR title:pricing", - "maxSize": 5, + "max_size": 5, "boost": 20.0 } @@ -187,7 +187,7 @@ Feldbeschreibungen - String - Ja - Match-Abfrage (maximale Länge gemäß Konfigurationswert ``form.admin.max.input.size``) - * - ``maxSize`` + * - ``max_size`` - Integer - Ja - Maximale Anzahl anzuzeigender Einträge (ganzzahlig, mindestens 0; Standardwert im Verwaltungsformular: 10) @@ -195,16 +195,16 @@ Feldbeschreibungen - Float - Ja - Boost-Wert (Standardwert im Verwaltungsformular: 100.0) - * - ``virtualHost`` + * - ``virtual_host`` - String - Nein - Name des virtuellen Hosts (maximal 1000 Zeichen; anzugeben, wenn KeyMatch-Einträge pro virtuellem Host unterschieden werden sollen) .. note:: - ``maxSize`` und ``boost`` sind bei der Verwendung über die API Pflichtfelder. Die Standardwerte werden im Verwaltungsformular angezeigt und gelten + ``max_size`` und ``boost`` sind bei der Verwendung über die API Pflichtfelder. Die Standardwerte werden im Verwaltungsformular angezeigt und gelten nicht automatisch für die API. Werden diese Felder ausgelassen, wird ein Validierungsfehler zurückgegeben. - Hinweis: ``createdBy`` und ``createdTime`` werden auch dann vom Server überschrieben, wenn sie im Request angegeben werden. + Hinweis: ``created_by`` und ``created_time`` werden auch dann vom Server überschrieben, wenn sie im Request angegeben werden. Response -------- @@ -239,15 +239,15 @@ Request-Body "id": "existing_keymatch_id", "term": "pricing", "query": "url:*/pricing* OR title:pricing OR content:price", - "maxSize": 10, + "max_size": 10, "boost": 15.0, - "versionNo": 1 + "version_no": 1 } Feldbeschreibungen ~~~~~~~~~~~~~~~~~~ -Zusätzlich zu den Feldern beim Erstellen (``term``, ``query``, ``maxSize``, ``boost``, ``virtualHost``) sind folgende Felder anzugeben. +Zusätzlich zu den Feldern beim Erstellen (``term``, ``query``, ``max_size``, ``boost``, ``virtual_host``) sind folgende Felder anzugeben. .. list-table:: :header-rows: 1 @@ -261,7 +261,7 @@ Zusätzlich zu den Feldern beim Erstellen (``term``, ``query``, ``maxSize``, ``b - String - Ja - ID des zu aktualisierenden KeyMatch-Eintrags (maximal 1000 Zeichen) - * - ``versionNo`` + * - ``version_no`` - Integer - Ja - Versionsnummer für optimistisches Sperren; anzugeben ist der beim Abrufen erhaltene Wert @@ -314,7 +314,7 @@ Produktseiten-KeyMatch erstellen -d '{ "term": "product features", "query": "url:*/products/* AND (title:features OR content:features)", - "maxSize": 10, + "max_size": 10, "boost": 15.0 }' @@ -329,7 +329,7 @@ KeyMatch für Support-Seiten -d '{ "term": "help", "query": "url:*/support/* OR url:*/help/* OR url:*/faq/*", - "maxSize": 5, + "max_size": 5, "boost": 20.0 }' diff --git a/de/15.9/api/admin/api-admin-labeltype.rst b/de/15.9/api/admin/api-admin-labeltype.rst index c7054afcf..2481b2648 100644 --- a/de/15.9/api/admin/api-admin-labeltype.rst +++ b/de/15.9/api/admin/api-admin-labeltype.rst @@ -101,16 +101,16 @@ Antwort "id": "label_id_1", "name": "Documentation", "value": "docs", - "includedPaths": ".*docs\\.example\\.com.*", - "excludedPaths": "", + "included_paths": ".*docs\\.example\\.com.*", + "excluded_paths": "", "permissions": "{role}admin", - "virtualHost": "", - "sortOrder": 0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_host": "", + "sort_order": 0, + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } ], "total": 5 @@ -119,8 +119,8 @@ Antwort .. note:: - Jedes Einstellungsobjekt enthält auch die Audit-Felder ``createdBy`` / ``createdTime`` / ``updatedBy`` / - ``updatedTime`` sowie ``versionNo`` für optimistisches Sperren (Felder mit dem Wert ``null`` + Jedes Einstellungsobjekt enthält auch die Audit-Felder ``created_by`` / ``created_time`` / ``updated_by`` / + ``updated_time`` sowie ``version_no`` für optimistisches Sperren (Felder mit dem Wert ``null`` werden weggelassen). Das ``response``-Objekt enthält stets ``version``, das die Produktversion angibt; in den folgenden Beispielen wird es der Übersichtlichkeit halber teilweise weggelassen. @@ -146,16 +146,16 @@ Antwort "id": "label_id_1", "name": "Documentation", "value": "docs", - "includedPaths": ".*docs\\.example\\.com.*", - "excludedPaths": "", + "included_paths": ".*docs\\.example\\.com.*", + "excluded_paths": "", "permissions": "{role}admin", - "virtualHost": "", - "sortOrder": 0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_host": "", + "sort_order": 0, + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } @@ -179,9 +179,9 @@ Anfragetext { "name": "News", "value": "news", - "includedPaths": ".*news\\.example\\.com.*\n.*example\\.com/news/.*", - "excludedPaths": ".*/(archive|old)/.*", - "sortOrder": 1, + "included_paths": ".*news\\.example\\.com.*\n.*example\\.com/news/.*", + "excluded_paths": ".*/(archive|old)/.*", + "sort_order": 1, "permissions": "{role}guest" } @@ -204,11 +204,11 @@ Feldbeschreibung - String - Ja - Label-Wert (wird bei der Suche als ``label``-Parameter verwendet). Nur alphanumerische Zeichen und Unterstriche (``_``) sind zulässig; der Wert muss dem regulären Ausdruck ``^[a-zA-Z0-9_]+$`` entsprechen (maximal 100 Zeichen). - * - ``includedPaths`` + * - ``included_paths`` - String - Nein - Regulärer Ausdruck für Label-Zielpfade. Bei mehreren Angaben durch Zeilenumbruch (``\n``) trennen. - * - ``excludedPaths`` + * - ``excluded_paths`` - String - Nein - Regulärer Ausdruck für ausgeschlossene Pfade. Bei mehreren Angaben durch Zeilenumbruch (``\n``) trennen. @@ -216,18 +216,18 @@ Feldbeschreibung - String - Nein - Zugriffsberechtigte Rollen/Gruppen/Benutzer (Beispiel: ``{role}admin``). Bei mehreren Angaben durch Zeilenumbruch (``\n``) trennen. - * - ``sortOrder`` + * - ``sort_order`` - Integer - Nein - Anzeigereihenfolge (ganze Zahl >= 0). Standardwert ist ``0``. - * - ``virtualHost`` + * - ``virtual_host`` - String - Nein - Virtueller Host (maximal 1000 Zeichen). .. note:: - Audit-Felder wie ``createdBy`` / ``createdTime`` werden serverseitig automatisch gesetzt + Audit-Felder wie ``created_by`` / ``created_time`` werden serverseitig automatisch gesetzt und müssen nicht in der Anfrage angegeben werden. Antwort @@ -265,11 +265,11 @@ Anfragetext "id": "existing_label_id", "name": "News Articles", "value": "news", - "includedPaths": ".*news\\.example\\.com.*\n.*example\\.com/(news|articles)/.*", - "excludedPaths": ".*/(archive|old|draft)/.*", - "sortOrder": 1, + "included_paths": ".*news\\.example\\.com.*\n.*example\\.com/(news|articles)/.*", + "excluded_paths": ".*/(archive|old|draft)/.*", + "sort_order": 1, "permissions": "{role}guest", - "versionNo": 1 + "version_no": 1 } Bei der Aktualisierung sind zusätzlich zu den Feldern beim Erstellen folgende Felder erforderlich. @@ -286,10 +286,10 @@ Bei der Aktualisierung sind zusätzlich zu den Feldern beim Erstellen folgende F - String - Ja - ID des zu aktualisierenden Label-Typs. - * - ``versionNo`` + * - ``version_no`` - Integer - Ja - - Versionsnummer für optimistisches Sperren. Geben Sie den ``versionNo``-Wert aus der Abrufantwort an. Stimmt die angegebene Version nicht mit der aktuellen überein, schlägt die Aktualisierung fehl. + - Versionsnummer für optimistisches Sperren. Geben Sie den ``version_no``-Wert aus der Abrufantwort an. Stimmt die angegebene Version nicht mit der aktuellen überein, schlägt die Aktualisierung fehl. Antwort ------- @@ -341,8 +341,8 @@ Dokumentations-Label erstellen -d '{ "name": "Technical Documentation", "value": "tech_docs", - "includedPaths": ".*docs\\.example\\.com.*\n.*example\\.com/documentation/.*", - "sortOrder": 0, + "included_paths": ".*docs\\.example\\.com.*\n.*example\\.com/documentation/.*", + "sort_order": 0, "permissions": "{role}guest" }' diff --git a/de/15.9/api/admin/api-admin-overview.rst b/de/15.9/api/admin/api-admin-overview.rst index 283b8b02f..f7fd9fdae 100644 --- a/de/15.9/api/admin/api-admin-overview.rst +++ b/de/15.9/api/admin/api-admin-overview.rst @@ -515,22 +515,22 @@ Web-Crawl-Konfiguration erstellen -d '{ "name": "Example Site", "urls": "https://example.com/", - "includedUrls": ".*example.com.*", - "excludedUrls": "", - "userAgent": "Mozilla/5.0 (compatible; Fess)", - "numOfThread": 1, - "intervalTime": 1000, + "included_urls": ".*example.com.*", + "excluded_urls": "", + "user_agent": "Mozilla/5.0 (compatible; Fess)", + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, - "maxAccessCount": 1000, + "max_access_count": 1000, "depth": 3, - "sortOrder": 1, + "sort_order": 1, "available": "true" }' .. note:: - Beim Erstellen einer Web-Crawl-Konfiguration sind ``name``, ``urls``, ``userAgent``, ``numOfThread``, - ``intervalTime``, ``boost``, ``available`` und ``sortOrder`` erforderlich. Werden diese + Beim Erstellen einer Web-Crawl-Konfiguration sind ``name``, ``urls``, ``user_agent``, ``num_of_thread``, + ``interval_time``, ``boost``, ``available`` und ``sort_order`` erforderlich. Werden diese weggelassen, kommt es zu einem Validierungsfehler (``status: 1``). ``available`` wird als Zeichenkette angegeben; setzen Sie ``"true"`` oder ``"false"``. diff --git a/de/15.9/api/admin/api-admin-relatedcontent.rst b/de/15.9/api/admin/api-admin-relatedcontent.rst index 50c945656..b411204e9 100644 --- a/de/15.9/api/admin/api-admin-relatedcontent.rst +++ b/de/15.9/api/admin/api-admin-relatedcontent.rst @@ -93,13 +93,13 @@ Response "id": "content_id_1", "term": "fess", "content": "
Fess is an open source search server.
", - "virtualHost": "", - "sortOrder": 0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_host": "", + "sort_order": 0, + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } ], "total": 5 @@ -109,10 +109,10 @@ Response .. note:: Jedes Element von ``settings`` sowie das ``setting``-Objekt des Einzelabruf-Endpunkts enthält - die Felder der gespeicherten Entität unverändert. Neben ``term``, ``content``, ``sortOrder`` - und ``virtualHost`` werden auch die Audit-Felder ``createdBy``, ``createdTime``, ``updatedBy``, - ``updatedTime`` sowie das Feld ``versionNo`` zur optimistischen Sperrung zurückgegeben. - ``createdTime`` und ``updatedTime`` werden als Millisekunden seit dem Epoch-Zeitpunkt (Zahlen) + die Felder der gespeicherten Entität unverändert. Neben ``term``, ``content``, ``sort_order`` + und ``virtual_host`` werden auch die Audit-Felder ``created_by``, ``created_time``, ``updated_by``, + ``updated_time`` sowie das Feld ``version_no`` zur optimistischen Sperrung zurückgegeben. + ``created_time`` und ``updated_time`` werden als Millisekunden seit dem Epoch-Zeitpunkt (Zahlen) angegeben. Felder, die nicht gesetzt sind (null), werden in der Antwort weggelassen. Außerdem enthält das ``response``-Objekt jeder Antwort stets ``version``, das die Produktversion angibt (Details siehe :doc:`api-admin-overview`). @@ -140,20 +140,20 @@ Response "id": "content_id_1", "term": "fess", "content": "
Fess is an open source search server.
", - "virtualHost": "", - "sortOrder": 0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_host": "", + "sort_order": 0, + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } .. note:: - Der ``versionNo``-Wert, der beim Aktualisieren (PUT) benötigt wird, ist der in dieser + Der ``version_no``-Wert, der beim Aktualisieren (PUT) benötigt wird, ist der in dieser Abrufantwort enthaltene Wert. Verwandten Inhalt erstellen @@ -175,8 +175,8 @@ Request-Body { "term": "search", "content": "

About Search

Learn more about search features...

", - "sortOrder": 0, - "virtualHost": "" + "sort_order": 0, + "virtual_host": "" } Feldbeschreibungen @@ -195,10 +195,10 @@ Feldbeschreibungen * - ``content`` - Ja - Anzuzeigender HTML-Inhalt (max. 10000 Zeichen) - * - ``sortOrder`` + * - ``sort_order`` - Nein - Anzeigereihenfolge (ganze Zahl zwischen 0 und 2147483647) - * - ``virtualHost`` + * - ``virtual_host`` - Nein - Virtueller Host (max. 1000 Zeichen) @@ -236,9 +236,9 @@ Request-Body "id": "existing_content_id", "term": "search", "content": "

About Search

Updated information...

", - "sortOrder": 0, - "virtualHost": "", - "versionNo": 1 + "sort_order": 0, + "virtual_host": "", + "version_no": 1 } Feldbeschreibungen @@ -260,13 +260,13 @@ Feldbeschreibungen * - ``content`` - Ja - Anzuzeigender HTML-Inhalt (max. 10000 Zeichen) - * - ``sortOrder`` + * - ``sort_order`` - Nein - Anzeigereihenfolge (ganze Zahl zwischen 0 und 2147483647) - * - ``virtualHost`` + * - ``virtual_host`` - Nein - Virtueller Host (max. 1000 Zeichen) - * - ``versionNo`` + * - ``version_no`` - Ja - Versionsnummer zur optimistischen Sperrung. Geben Sie den in der Antwort von ``setting/{id}`` enthaltenen Wert an. @@ -286,8 +286,8 @@ Response .. note:: - Audit-Felder wie ``createdBy``, ``createdTime``, ``updatedBy``, ``updatedTime`` sowie - ``crudMode`` werden ignoriert, auch wenn sie im Request-Body enthalten sind, da sie + Audit-Felder wie ``created_by``, ``created_time``, ``updated_by``, ``updated_time`` sowie + ``crud_mode`` werden ignoriert, auch wenn sie im Request-Body enthalten sind, da sie serverseitig automatisch gesetzt werden. Sie müssen diese beim Erstellen oder Aktualisieren nicht angeben. @@ -327,7 +327,7 @@ Verwandter Inhalt für Produktinformationen -d '{ "term": "product", "content": "

Our Products

", - "sortOrder": 0 + "sort_order": 0 }' Verwandter Inhalt für Support-Informationen @@ -341,7 +341,7 @@ Verwandter Inhalt für Support-Informationen -d '{ "term": "support", "content": "

Need help? Contact: support@example.com

", - "sortOrder": 0 + "sort_order": 0 }' Referenzinformationen diff --git a/de/15.9/api/admin/api-admin-relatedquery.rst b/de/15.9/api/admin/api-admin-relatedquery.rst index 4dde8ceb7..77faf256b 100644 --- a/de/15.9/api/admin/api-admin-relatedquery.rst +++ b/de/15.9/api/admin/api-admin-relatedquery.rst @@ -90,7 +90,7 @@ Response "id": "query_id_1", "term": "fess", "queries": "fess tutorial\nfess installation\nfess configuration", - "versionNo": 1 + "version_no": 1 } ], "total": 5 @@ -99,9 +99,9 @@ Response .. note:: - Jede Einstellung enthält ``versionNo`` (Versionsnummer für optimistisches Sperren). ``virtualHost`` - und Audit-Felder (``createdBy``, ``createdTime``, ``updatedBy``, ``updatedTime``) werden nur dann - aufgenommen, wenn ein Wert gesetzt ist. Ein leerer ``virtualHost`` wird nicht in die Response aufgenommen. + Jede Einstellung enthält ``version_no`` (Versionsnummer für optimistisches Sperren). ``virtual_host`` + und Audit-Felder (``created_by``, ``created_time``, ``updated_by``, ``updated_time``) werden nur dann + aufgenommen, wenn ein Wert gesetzt ist. Ein leerer ``virtual_host`` wird nicht in die Response aufgenommen. Verwandte Abfrage abrufen ========================== @@ -126,8 +126,8 @@ Response "id": "query_id_1", "term": "fess", "queries": "fess tutorial\nfess installation\nfess configuration", - "virtualHost": "site1.example.com", - "versionNo": 1 + "virtual_host": "site1.example.com", + "version_no": 1 } } } @@ -151,7 +151,7 @@ Request-Body { "term": "search", "queries": "search tutorial\nsearch syntax\nadvanced search", - "virtualHost": "" + "virtual_host": "" } Feldbeschreibungen @@ -170,13 +170,13 @@ Feldbeschreibungen * - ``queries`` - Ja - Verwandte Abfragen. Zeilenumbruch-getrennte Zeichenkette mit einem Eintrag pro Zeile (Leerzeilen werden ignoriert; maximal 10000 Zeichen) - * - ``virtualHost`` + * - ``virtual_host`` - Nein - Virtueller Host (maximal 1000 Zeichen) .. note:: - ``crudMode`` wird serverseitig automatisch gesetzt und muss nicht im Request-Body angegeben werden. + ``crud_mode`` wird serverseitig automatisch gesetzt und muss nicht im Request-Body angegeben werden. Response -------- @@ -212,8 +212,8 @@ Request-Body "id": "existing_query_id", "term": "search", "queries": "search tutorial\nsearch syntax\nadvanced search\nsearch tips", - "virtualHost": "", - "versionNo": 1 + "virtual_host": "", + "version_no": 1 } Feldbeschreibungen @@ -235,10 +235,10 @@ Feldbeschreibungen * - ``queries`` - Ja - Verwandte Abfragen. Zeilenumbruch-getrennte Zeichenkette mit einem Eintrag pro Zeile (Leerzeilen werden ignoriert; maximal 10000 Zeichen) - * - ``virtualHost`` + * - ``virtual_host`` - Nein - Virtueller Host (maximal 1000 Zeichen) - * - ``versionNo`` + * - ``version_no`` - Ja - Versionsnummer für optimistisches Sperren. Geben Sie den beim Abrufen in der Response enthaltenen Wert an. diff --git a/de/15.9/api/admin/api-admin-role.rst b/de/15.9/api/admin/api-admin-role.rst index c128de641..6c6ae6964 100644 --- a/de/15.9/api/admin/api-admin-role.rst +++ b/de/15.9/api/admin/api-admin-role.rst @@ -87,12 +87,12 @@ Response { "id": "role_id_1", "name": "admin", - "versionNo": 1 + "version_no": 1 }, { "id": "role_id_2", "name": "user", - "versionNo": 1 + "version_no": 1 } ], "total": 5 @@ -120,7 +120,7 @@ Response "setting": { "id": "role_id_1", "name": "admin", - "versionNo": 1 + "version_no": 1 } } } @@ -194,7 +194,7 @@ Request-Body { "id": "existing_role_id", "name": "editor_updated", - "versionNo": 1 + "version_no": 1 } Feldbeschreibungen @@ -216,9 +216,9 @@ Feldbeschreibungen * - ``attributes`` - Nein - Attribut-Map. Werte werden als Zeichenketten angegeben - * - ``versionNo`` + * - ``version_no`` - Ja - - Versionsnummer für optimistisches Sperren. Geben Sie den Wert von ``versionNo`` an, der beim Abrufen der Rolle ermittelt wurde + - Versionsnummer für optimistisches Sperren. Geben Sie den Wert von ``version_no`` an, der beim Abrufen der Rolle ermittelt wurde Response -------- diff --git a/de/15.9/api/admin/api-admin-scheduler.rst b/de/15.9/api/admin/api-admin-scheduler.rst index c3a71a145..948c5e2b4 100644 --- a/de/15.9/api/admin/api-admin-scheduler.rst +++ b/de/15.9/api/admin/api-admin-scheduler.rst @@ -91,14 +91,14 @@ Response "id": "job_id_1", "name": "Default Crawler", "target": "all", - "cronExpression": "0 0 0 * * ?", - "scriptType": "javascript", - "scriptData": "...", - "jobLogging": "true", + "cron_expression": "0 0 0 * * ?", + "script_type": "javascript", + "script_data": "...", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 0, - "versionNo": 1, + "sort_order": 0, + "version_no": 1, "running": false } ], @@ -112,7 +112,7 @@ Response .. note:: - Im Response werden ``jobLogging`` / ``crawler`` / ``available`` als Zeichenketten (``"true"`` / ``"false"``) zurückgegeben. ``running`` ist ein boolescher Wert und ein reines Response-Feld, das anzeigt, ob der Job gerade ausgeführt wird (kann im Request nicht gesetzt werden). ``total`` ist die Gesamtanzahl der zur Abfrage passenden Jobs. + Im Response werden ``job_logging`` / ``crawler`` / ``available`` als Zeichenketten (``"true"`` / ``"false"``) zurückgegeben. ``running`` ist ein boolescher Wert und ein reines Response-Feld, das anzeigt, ob der Job gerade ausgeführt wird (kann im Request nicht gesetzt werden). ``total`` ist die Gesamtanzahl der zur Abfrage passenden Jobs. Geplanten Job abrufen ===================== @@ -136,14 +136,14 @@ Response "id": "job_id_1", "name": "Default Crawler", "target": "all", - "cronExpression": "0 0 0 * * ?", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "jobLogging": "true", + "cron_expression": "0 0 0 * * ?", + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 0, - "versionNo": 1, + "sort_order": 0, + "version_no": 1, "running": false } } @@ -168,13 +168,13 @@ Request-Body { "name": "Daily Crawler", "target": "all", - "cronExpression": "0 0 2 * * ?", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "jobLogging": "true", + "cron_expression": "0 0 2 * * ?", + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 1 + "sort_order": 1 } Feldbeschreibungen @@ -193,16 +193,16 @@ Feldbeschreibungen * - ``target`` - Ja - Ausführungsziel (max. 100 Zeichen). ``all`` oder einen bestimmten Zielnamen angeben - * - ``cronExpression`` + * - ``cron_expression`` - Nein - Cron-Ausdruck (Sekunde Minute Stunde Tag Monat Wochentag). Max. 100 Zeichen, wird als Cron-Ausdruck validiert. Ist das Feld leer, wird der Job nicht geplant und kann nur manuell gestartet werden - * - ``scriptType`` + * - ``script_type`` - Ja - Skript-Typ (max. 100 Zeichen). ``javascript`` (Standard für neue Jobs, festgelegt über die Eigenschaft ``job.default.script``) oder ``groovy`` (erfordert das Plugin ``fess-script-groovy``) - * - ``scriptData`` + * - ``script_data`` - Nein - Ausführungsskript. Die maximale Größe richtet sich nach ``form.admin.max.input.size`` in ``fess_config.properties`` - * - ``jobLogging`` + * - ``job_logging`` - Nein - Job-Protokollierung aktivieren (Zeichenkette) * - ``crawler`` @@ -211,17 +211,17 @@ Feldbeschreibungen * - ``available`` - Nein - Aktiviert/Deaktiviert (Zeichenkette) - * - ``sortOrder`` + * - ``sort_order`` - Ja - Anzeigereihenfolge (Ganzzahl zwischen 0 und 2147483647) .. note:: - ``jobLogging`` / ``crawler`` / ``available`` sind Zeichenkettenfelder. Im Request aktiviert die Angabe von ``"on"`` oder ``"true"`` (Groß-/Kleinschreibung wird nicht berücksichtigt) das jeweilige Feld; jeder andere Wert (``"false"``, leere Zeichenkette oder nicht angegeben) wird als deaktiviert behandelt. Im Response werden die Werte als ``"true"`` / ``"false"`` zurückgegeben. + ``job_logging`` / ``crawler`` / ``available`` sind Zeichenkettenfelder. Im Request aktiviert die Angabe von ``"on"`` oder ``"true"`` (Groß-/Kleinschreibung wird nicht berücksichtigt) das jeweilige Feld; jeder andere Wert (``"false"``, leere Zeichenkette oder nicht angegeben) wird als deaktiviert behandelt. Im Response werden die Werte als ``"true"`` / ``"false"`` zurückgegeben. .. note:: - ``crudMode`` wird serverseitig automatisch gesetzt und muss im Request nicht angegeben werden. Audit-Felder wie ``createdBy`` / ``createdTime`` werden ebenfalls serverseitig gesetzt. + ``crud_mode`` wird serverseitig automatisch gesetzt und muss im Request nicht angegeben werden. Audit-Felder wie ``created_by`` / ``created_time`` werden ebenfalls serverseitig gesetzt. Response -------- @@ -274,19 +274,19 @@ Request-Body "id": "existing_job_id", "name": "Updated Crawler", "target": "all", - "cronExpression": "0 0 3 * * ?", - "scriptType": "javascript", - "scriptData": "...", - "jobLogging": "true", + "cron_expression": "0 0 3 * * ?", + "script_type": "javascript", + "script_data": "...", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 1, - "versionNo": 1 + "sort_order": 1, + "version_no": 1 } .. note:: - Für Aktualisierungen sind ``id`` (max. 1000 Zeichen) und ``versionNo`` Pflichtfelder. ``versionNo`` wird für optimistisches Sperren verwendet; geben Sie den Wert an, der im GET-Response zurückgegeben wurde. Stimmt der Wert nicht überein, schlägt die Aktualisierung fehl. Die weiteren Pflichtfelder (``name`` / ``target`` / ``scriptType`` / ``sortOrder``) sind dieselben wie beim Erstellen. + Für Aktualisierungen sind ``id`` (max. 1000 Zeichen) und ``version_no`` Pflichtfelder. ``version_no`` wird für optimistisches Sperren verwendet; geben Sie den Wert an, der im GET-Response zurückgegeben wurde. Stimmt der Wert nicht überein, schlägt die Aktualisierung fehl. Die weiteren Pflichtfelder (``name`` / ``target`` / ``script_type`` / ``sort_order``) sind dieselben wie beim Erstellen. Response -------- @@ -344,7 +344,7 @@ Response { "response": { "status": 0, - "jobLogId": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6" + "job_log_id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6" } } @@ -357,15 +357,15 @@ Response-Felder * - Feld - Beschreibung - * - ``jobLogId`` - - Job-Protokoll-ID des gestarteten Jobs. Wird ausgegeben, wenn die Job-Protokollierung aktiviert ist. Ist die Job-Protokollierung deaktiviert, ist der Wert ``null``. + * - ``job_log_id`` + - Job-Protokoll-ID des gestarteten Jobs. Wird ausgegeben, wenn die Job-Protokollierung aktiviert ist. Ist die Job-Protokollierung deaktiviert, fehlt das Feld in der Antwort. Hinweise -------- - Wenn der Job bereits läuft, schlägt der Start fehl und es wird ein Fehler zurückgegeben (``status`` ungleich ``0``). - Wenn der Job deaktiviert ist (``available`` ist nicht aktiviert), schlägt der Start ebenfalls fehl und es wird ein Fehler zurückgegeben. -- ``jobLogId`` wird nur ausgegeben, wenn die Job-Protokollierung aktiviert ist (``jobLogging`` ist aktiviert). +- ``job_log_id`` wird nur ausgegeben, wenn die Job-Protokollierung aktiviert ist (``job_logging`` ist aktiviert). Job stoppen =========== @@ -405,13 +405,13 @@ Crawl-Job erstellen und ausführen -d '{ "name": "Hourly Crawler", "target": "all", - "cronExpression": "0 0 * * * ?", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "jobLogging": "true", + "cron_expression": "0 0 * * * ?", + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 1 + "sort_order": 1 }' # Job sofort ausführen diff --git a/de/15.9/api/admin/api-admin-suggest.rst b/de/15.9/api/admin/api-admin-suggest.rst index 902ffd437..4e1f85fc9 100644 --- a/de/15.9/api/admin/api-admin-suggest.rst +++ b/de/15.9/api/admin/api-admin-suggest.rst @@ -74,9 +74,9 @@ Response "version": "15.9.0", "status": 0, "setting": { - "totalWordsNum": 1500, - "documentWordsNum": 1200, - "queryWordsNum": 450 + "total_words_num": 1500, + "document_words_num": 1200, + "query_words_num": 450 } } } @@ -90,16 +90,16 @@ Response-Felder * - Feld - Beschreibung - * - ``setting.totalWordsNum`` + * - ``setting.total_words_num`` - Gesamtzahl der Suggest-Wörter (Anzahl der im Suggest-Index registrierten Suggest-Wörter) - * - ``setting.documentWordsNum`` + * - ``setting.document_words_num`` - Anzahl der aus Dokumenten abgeleiteten Suggest-Wörter (Suggest-Wörter mit einer Dokumenthäufigkeit von 1 oder mehr) - * - ``setting.queryWordsNum`` + * - ``setting.query_words_num`` - Anzahl der aus Suchanfragen abgeleiteten Suggest-Wörter (Suggest-Wörter mit einer Anfragehäufigkeit von 1 oder mehr) .. note:: - ``documentWordsNum`` und ``queryWordsNum`` schließen sich nicht gegenseitig aus. Wenn ein Suggest-Wort sowohl aus Dokumenten als auch aus Suchanfragen stammt, wird es in beiden Zählungen berücksichtigt. Daher kann die Summe von ``documentWordsNum`` und ``queryWordsNum`` von ``totalWordsNum`` abweichen. + ``document_words_num`` und ``query_words_num`` schließen sich nicht gegenseitig aus. Wenn ein Suggest-Wort sowohl aus Dokumenten als auch aus Suchanfragen stammt, wird es in beiden Zählungen berücksichtigt. Daher kann die Summe von ``document_words_num`` und ``query_words_num`` von ``total_words_num`` abweichen. Alle Suggest-Wörter löschen ============================ diff --git a/de/15.9/api/admin/api-admin-systeminfo.rst b/de/15.9/api/admin/api-admin-systeminfo.rst index 19ecbf8af..a931cd7f9 100644 --- a/de/15.9/api/admin/api-admin-systeminfo.rst +++ b/de/15.9/api/admin/api-admin-systeminfo.rst @@ -57,22 +57,22 @@ mit ``label`` und ``value``. "response": { "version": "15.9.0", "status": 0, - "envProps": [ + "env_props": [ {"label": "JAVA_HOME", "value": "/usr/lib/jvm/java-21"}, {"label": "FESS_DICTIONARY_PATH", "value": "/var/lib/fess/dict"} ], - "systemProps": [ + "system_props": [ {"label": "java.version", "value": "21.0.1"}, {"label": "java.vendor", "value": "Oracle Corporation"}, {"label": "os.name", "value": "Linux"}, {"label": "user.dir", "value": "/opt/fess"} ], - "fessProps": [ + "fess_props": [ {"label": "crawler.document.max.site.length", "value": "100"}, {"label": "indexer.thread.dump.enabled", "value": "true"}, {"label": "app.cipher.key", "value": "XXXXXXXX"} ], - "bugReportProps": [ + "bug_report_props": [ {"label": "os.name", "value": "Linux"}, {"label": "java.vm.version", "value": "21.0.1+12"} ] @@ -92,24 +92,24 @@ Response-Felder - Produktversion von |Fess| (Beispiel: ``15.9.0``). * - ``status`` - Ergebniscode der Verarbeitung. ``0`` steht für erfolgreiche Ausführung. - * - ``envProps`` + * - ``env_props`` - Liste der Umgebungsvariablen (Array aus ``label`` / ``value``). Die Werte werden unverändert über ``System.getenv()`` zurückgegeben. - * - ``systemProps`` + * - ``system_props`` - Liste der Java-Systemeigenschaften (Array aus ``label`` / ``value``). Die Werte werden unverändert über ``System.getProperties()`` zurückgegeben. - * - ``fessProps`` + * - ``fess_props`` - Liste der |Fess|-Konfigurationseigenschaften (Array aus ``label`` / ``value``). Enthält die Einstellungen aus ``fess_config.properties`` sowie die über die Administrationsoberfläche gesetzten Systemeigenschaften. Vertrauliche Einträge werden maskiert (siehe Hinweis unten). - * - ``bugReportProps`` + * - ``bug_report_props`` - Liste der für Fehlerberichte gesammelten Informationen (Array aus ``label`` / ``value``). Enthält wichtige Systemeigenschaften zu Betriebssystem und Java-Laufzeitumgebung (``os.name``, ``os.version``, ``java.vm.version`` u. a.) sowie die |Fess|-Systemeigenschaftswerte. .. note:: - In ``fessProps`` werden die folgenden vertraulichen Konfigurationswerte maskiert und als ``XXXXXXXX`` zurückgegeben: + In ``fess_props`` werden die folgenden vertraulichen Konfigurationswerte maskiert und als ``XXXXXXXX`` zurückgegeben: ``http.proxy.password``, ``ldap.admin.security.credentials``, ``spnego.preauth.password``, ``app.cipher.key``, ``oic.client.id``, ``oic.client.secret``. .. warning:: - ``envProps`` (Umgebungsvariablen) und ``systemProps`` (Java-Systemeigenschaften) werden nicht maskiert — + ``env_props`` (Umgebungsvariablen) und ``system_props`` (Java-Systemeigenschaften) werden nicht maskiert — die gesetzten Werte werden unverändert zurückgegeben. Wenn Umgebungsvariablen oder Systemeigenschaften Zugangsdaten oder andere vertrauliche Informationen enthalten, erscheinen diese im Response. diff --git a/de/15.9/api/admin/api-admin-user.rst b/de/15.9/api/admin/api-admin-user.rst index 5d0026aa8..f3b85d0d3 100644 --- a/de/15.9/api/admin/api-admin-user.rst +++ b/de/15.9/api/admin/api-admin-user.rst @@ -105,7 +105,7 @@ Antwort }, "roles": ["admin"], "groups": [], - "versionNo": 1 + "version_no": 1 } ], "total": 10 @@ -150,7 +150,7 @@ Antwort }, "roles": ["admin"], "groups": [], - "versionNo": 1 + "version_no": 1 } } } @@ -179,7 +179,7 @@ Anfrage-Body { "name": "testuser", "password": "securepassword", - "confirmPassword": "securepassword", + "confirm_password": "securepassword", "attributes": { "surname": "Test", "givenName": "User", @@ -205,7 +205,7 @@ Feldbeschreibungen * - ``password`` - Nein - Passwort - * - ``confirmPassword`` + * - ``confirm_password`` - Nein - Bestätigungspasswort * - ``attributes`` @@ -220,8 +220,8 @@ Feldbeschreibungen .. note:: - Die REST API führt keine Pflichtprüfung für das Passwort, keinen Abgleich zwischen ``password`` und ``confirmPassword`` und keine Passwortrichtlinienvalidierung durch (diese werden nur in der Admin-Oberfläche angewendet). - In der Praxis wird empfohlen, ein gültiges ``password`` anzugeben, dessen Wert mit ``confirmPassword`` übereinstimmt. + Die REST API führt keine Pflichtprüfung für das Passwort, keinen Abgleich zwischen ``password`` und ``confirm_password`` und keine Passwortrichtlinienvalidierung durch (diese werden nur in der Admin-Oberfläche angewendet). + In der Praxis wird empfohlen, ein gültiges ``password`` anzugeben, dessen Wert mit ``confirm_password`` übereinstimmt. Die Schlüssel von ``attributes`` sind die Attributnamen der Benutzerentität (die aus LDAP abgeleiteten Schemaelementnamen). Die häufigsten Schlüssel sind: @@ -276,7 +276,7 @@ Anfrage-Body "id": "existing_user_id", "name": "testuser", "password": "newpassword", - "confirmPassword": "newpassword", + "confirm_password": "newpassword", "attributes": { "surname": "Test", "givenName": "User Updated", @@ -284,7 +284,7 @@ Anfrage-Body }, "roles": ["user", "editor"], "groups": ["group_id_1", "group_id_2"], - "versionNo": 1 + "version_no": 1 } Feldbeschreibungen @@ -303,13 +303,13 @@ Feldbeschreibungen * - ``name`` - Ja - Benutzername (Login-ID) - * - ``versionNo`` + * - ``version_no`` - Ja - Versionsnummer (für optimistisches Sperren) * - ``password`` - Nein - Neues Passwort (wird nur aktualisiert, wenn angegeben) - * - ``confirmPassword`` + * - ``confirm_password`` - Nein - Bestätigungspasswort * - ``attributes`` @@ -324,8 +324,8 @@ Feldbeschreibungen .. note:: - Bei der Aktualisierung sind ``id``, ``name`` und ``versionNo`` erforderlich. - ``versionNo`` ist der Wert, der beim Abrufen des Zielbenutzers (GET) zurückgegeben wird, und entspricht der OpenSearch-Dokumentversion. + Bei der Aktualisierung sind ``id``, ``name`` und ``version_no`` erforderlich. + ``version_no`` ist der Wert, der beim Abrufen des Zielbenutzers (GET) zurückgegeben wird, und entspricht der OpenSearch-Dokumentversion. Stimmt er nicht mit der aktuellen Version überein, wird die Anfrage als Konflikt behandelt und die Aktualisierung abgelehnt. Antwort @@ -390,7 +390,7 @@ Neuen Benutzer erstellen -d '{ "name": "john.doe", "password": "SecureP@ss123", - "confirmPassword": "SecureP@ss123", + "confirm_password": "SecureP@ss123", "attributes": { "surname": "Doe", "givenName": "John", @@ -412,7 +412,7 @@ Benutzerrollen ändern "id": "user_id_123", "name": "john.doe", "roles": ["user", "editor", "admin"], - "versionNo": 1 + "version_no": 1 }' Referenzinformationen diff --git a/de/15.9/api/admin/api-admin-webconfig.rst b/de/15.9/api/admin/api-admin-webconfig.rst index 2d6283d96..a5b913620 100644 --- a/de/15.9/api/admin/api-admin-webconfig.rst +++ b/de/15.9/api/admin/api-admin-webconfig.rst @@ -106,21 +106,21 @@ Response "name": "Example Site", "description": "Beispielseite", "urls": "https://example.com/", - "includedUrls": ".*example\\.com.*", - "excludedUrls": ".*\\.(pdf|zip)$", - "includedDocUrls": "", - "excludedDocUrls": "", - "configParameter": "", + "included_urls": ".*example\\.com.*", + "excluded_urls": ".*\\.(pdf|zip)$", + "included_doc_urls": "", + "excluded_doc_urls": "", + "config_parameter": "", "depth": 3, - "maxAccessCount": 1000, - "userAgent": "Mozilla/5.0", - "numOfThread": 1, - "intervalTime": 1000, + "max_access_count": 1000, + "user_agent": "Mozilla/5.0", + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, "available": "true", "permissions": "{role}admin", - "virtualHosts": "", - "sortOrder": 0 + "virtual_hosts": "", + "sort_order": 0 } ], "total": 5 @@ -152,35 +152,35 @@ Response "name": "Example Site", "description": "Beispielseite", "urls": "https://example.com/", - "includedUrls": ".*example\\.com.*", - "excludedUrls": ".*\\.(pdf|zip)$", - "includedDocUrls": "", - "excludedDocUrls": "", - "configParameter": "", + "included_urls": ".*example\\.com.*", + "excluded_urls": ".*\\.(pdf|zip)$", + "included_doc_urls": "", + "excluded_doc_urls": "", + "config_parameter": "", "depth": 3, - "maxAccessCount": 1000, - "userAgent": "Mozilla/5.0", - "numOfThread": 1, - "intervalTime": 1000, + "max_access_count": 1000, + "user_agent": "Mozilla/5.0", + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin", - "virtualHosts": "", - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_hosts": "", + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } .. note:: - Die Response enthält die vom Server automatisch gesetzten Felder ``createdBy``, ``createdTime``, - ``updatedBy``, ``updatedTime`` und ``versionNo``. - ``versionNo`` wird bei der Aktualisierung benötigt (siehe „Web-Crawl-Konfiguration aktualisieren" weiter unten). + Die Response enthält die vom Server automatisch gesetzten Felder ``created_by``, ``created_time``, + ``updated_by``, ``updated_time`` und ``version_no``. + ``version_no`` wird bei der Aktualisierung benötigt (siehe „Web-Crawl-Konfiguration aktualisieren" weiter unten). Web-Crawl-Konfiguration erstellen =================================== @@ -201,14 +201,14 @@ Request-Body { "name": "Corporate Site", "urls": "https://www.example.com/", - "includedUrls": ".*www\\.example\\.com.*", - "excludedUrls": ".*\\.(pdf|zip|exe)$", - "userAgent": "Mozilla/5.0", - "numOfThread": 3, - "intervalTime": 500, + "included_urls": ".*www\\.example\\.com.*", + "excluded_urls": ".*\\.(pdf|zip|exe)$", + "user_agent": "Mozilla/5.0", + "num_of_thread": 3, + "interval_time": 500, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin\n{role}user" } @@ -231,34 +231,34 @@ Feldbeschreibungen * - ``urls`` - Ja - Crawl-Start-URLs (bei mehreren durch Zeilenumbruch getrennt). Anzugeben mit ``http:`` oder ``https:`` - * - ``includedUrls`` + * - ``included_urls`` - Nein - Regex-Muster für zu crawlende URLs - * - ``excludedUrls`` + * - ``excluded_urls`` - Nein - Regex-Muster für auszuschließende URLs - * - ``includedDocUrls`` + * - ``included_doc_urls`` - Nein - Regex-Muster für zu indexierende URLs - * - ``excludedDocUrls`` + * - ``excluded_doc_urls`` - Nein - Regex-Muster für vom Index auszuschließende URLs - * - ``configParameter`` + * - ``config_parameter`` - Nein - Zusätzliche Konfigurationsparameter (Format ``key=value``, ein Eintrag pro Zeile) * - ``depth`` - Nein - Crawl-Tiefe (0 oder größer) - * - ``maxAccessCount`` + * - ``max_access_count`` - Nein - Maximale Zugriffsanzahl (0 oder größer) - * - ``userAgent`` + * - ``user_agent`` - Ja - User-Agent-Zeichenkette (max. 200 Zeichen) - * - ``numOfThread`` + * - ``num_of_thread`` - Ja - Anzahl paralleler Threads (1 oder größer) - * - ``intervalTime`` + * - ``interval_time`` - Ja - Zugriffsintervall (Millisekunden, 0 oder größer) * - ``boost`` @@ -267,19 +267,19 @@ Feldbeschreibungen * - ``available`` - Ja - Aktiviert/Deaktiviert (Zeichenkette ``"true"`` / ``"false"``) - * - ``sortOrder`` + * - ``sort_order`` - Ja - Anzeigereihenfolge (0 oder größer) * - ``permissions`` - Nein - Zugriffsberechtigte Rollen (bei mehreren durch Zeilenumbruch getrennt) - * - ``virtualHosts`` + * - ``virtual_hosts`` - Nein - Virtuelle Hosts (bei mehreren durch Zeilenumbruch getrennt) .. note:: - Audit-Felder wie ``createdBy``, ``createdTime``, ``updatedBy`` und ``updatedTime`` werden + Audit-Felder wie ``created_by``, ``created_time``, ``updated_by`` und ``updated_time`` werden serverseitig automatisch gesetzt und müssen nicht im Request-Body angegeben werden. Response @@ -309,8 +309,8 @@ Request Request-Body ~~~~~~~~~~~~ -Bei der Aktualisierung sind neben den Feldern aus der Erstellung zusätzlich ``id`` zur Identifikation der Zielkonfiguration und ``versionNo`` als Versionsnummer erforderlich. -Für ``versionNo`` ist der aktuelle Wert aus der Response der Abruf-API (GET) anzugeben. +Bei der Aktualisierung sind neben den Feldern aus der Erstellung zusätzlich ``id`` zur Identifikation der Zielkonfiguration und ``version_no`` als Versionsnummer erforderlich. +Für ``version_no`` ist der aktuelle Wert aus der Response der Abruf-API (GET) anzugeben. .. code-block:: json @@ -318,17 +318,17 @@ Für ``versionNo`` ist der aktuelle Wert aus der Response der Abruf-API (GET) an "id": "existing_webconfig_id", "name": "Updated Corporate Site", "urls": "https://www.example.com/", - "includedUrls": ".*www\\.example\\.com.*", - "excludedUrls": ".*\\.(pdf|zip|exe|dmg)$", - "userAgent": "Mozilla/5.0", + "included_urls": ".*www\\.example\\.com.*", + "excluded_urls": ".*\\.(pdf|zip|exe|dmg)$", + "user_agent": "Mozilla/5.0", "depth": 10, - "maxAccessCount": 10000, - "numOfThread": 5, - "intervalTime": 300, + "max_access_count": 10000, + "num_of_thread": 5, + "interval_time": 300, "boost": 1.2, "available": "true", - "sortOrder": 0, - "versionNo": 1 + "sort_order": 0, + "version_no": 1 } Zusätzliche Felder bei der Aktualisierung @@ -344,9 +344,9 @@ Zusätzliche Felder bei der Aktualisierung * - ``id`` - Ja - Konfigurations-ID der zu aktualisierenden Konfiguration (max. 1000 Zeichen) - * - ``versionNo`` + * - ``version_no`` - Ja - - Aktuelle Versionsnummer der zu aktualisierenden Konfiguration. Anzugeben ist der ``versionNo``-Wert aus der Response der Abruf-API (GET) + - Aktuelle Versionsnummer der zu aktualisierenden Konfiguration. Anzugeben ist der ``version_no``-Wert aus der Response der Abruf-API (GET) Response -------- @@ -385,7 +385,7 @@ Response URL-Muster-Beispiele ==================== -Für ``includedUrls`` / ``excludedUrls`` / ``includedDocUrls`` / ``excludedDocUrls`` werden reguläre Ausdrücke angegeben. +Für ``included_urls`` / ``excluded_urls`` / ``included_doc_urls`` / ``excluded_doc_urls`` werden reguläre Ausdrücke angegeben. .. list-table:: :header-rows: 1 @@ -418,16 +418,16 @@ Crawl-Konfiguration für Unternehmenswebsite -d '{ "name": "Corporate Website", "urls": "https://www.example.com/", - "includedUrls": ".*www\\.example\\.com.*", - "excludedUrls": ".*/(login|admin|api)/.*", - "userAgent": "Mozilla/5.0", + "included_urls": ".*www\\.example\\.com.*", + "excluded_urls": ".*/(login|admin|api)/.*", + "user_agent": "Mozilla/5.0", "depth": 5, - "maxAccessCount": 10000, - "numOfThread": 3, - "intervalTime": 500, + "max_access_count": 10000, + "num_of_thread": 3, + "interval_time": 500, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}guest" }' @@ -442,15 +442,15 @@ Crawl-Konfiguration für Dokumentationswebsite -d '{ "name": "Documentation Site", "urls": "https://docs.example.com/", - "includedUrls": ".*docs\\.example\\.com.*", - "includedDocUrls": ".*\\.(html|htm)$", - "userAgent": "Mozilla/5.0", - "maxAccessCount": 50000, - "numOfThread": 5, - "intervalTime": 200, + "included_urls": ".*docs\\.example\\.com.*", + "included_doc_urls": ".*\\.(html|htm)$", + "user_agent": "Mozilla/5.0", + "max_access_count": 50000, + "num_of_thread": 5, + "interval_time": 200, "boost": 1.5, "available": "true", - "sortOrder": 0 + "sort_order": 0 }' Referenzinformationen diff --git a/en/15.9/api/admin/api-admin-accesstoken.rst b/en/15.9/api/admin/api-admin-accesstoken.rst index af7da8f5b..443f467ed 100644 --- a/en/15.9/api/admin/api-admin-accesstoken.rst +++ b/en/15.9/api/admin/api-admin-accesstoken.rst @@ -98,14 +98,14 @@ Response "id": "token_id_1", "name": "API Token 1", "token": "abcd1234efgh5678", - "parameterName": "permission", + "parameter_name": "permission", "permissions": "{role}admin-api", "expires": "2026-01-01T00:00:00", - "createdBy": "admin", - "createdTime": 1735689600000, - "updatedBy": "admin", - "updatedTime": 1735689600000, - "versionNo": 1 + "created_by": "admin", + "created_time": 1735689600000, + "updated_by": "admin", + "updated_time": 1735689600000, + "version_no": 1 } ], "total": 5 @@ -114,9 +114,9 @@ Response .. note:: - Each token object also includes audit and version information such as ``createdBy`` , ``createdTime`` , ``updatedBy`` , - ``updatedTime`` , and ``versionNo`` . - ``createdTime`` and ``updatedTime`` are milliseconds since epoch (numeric). + Each token object also includes audit and version information such as ``created_by`` , ``created_time`` , ``updated_by`` , + ``updated_time`` , and ``version_no`` . + ``created_time`` and ``updated_time`` are milliseconds since epoch (numeric). Fields with a value of ``null`` are excluded from the response. ``permissions`` is returned as a newline ( ``\n`` ) separated string. @@ -142,14 +142,14 @@ Response "id": "token_id_1", "name": "API Token 1", "token": "abcd1234efgh5678", - "parameterName": "permission", + "parameter_name": "permission", "permissions": "{role}admin-api", "expires": "2026-01-01T00:00:00", - "createdBy": "admin", - "createdTime": 1735689600000, - "updatedBy": "admin", - "updatedTime": 1735689600000, - "versionNo": 1 + "created_by": "admin", + "created_time": 1735689600000, + "updated_by": "admin", + "updated_time": 1735689600000, + "version_no": 1 } } } @@ -192,7 +192,7 @@ Field Descriptions * - ``permissions`` - No - Permissions granted to this token. Multiple permissions can be specified separated by newlines ( ``\n`` ) (example: ``{role}admin-api`` ). Tokens that call the Admin API require a permission matching ``api.admin.access.permissions`` (default value: ``{role}admin-api`` ). - * - ``parameterName`` + * - ``parameter_name`` - No - Request parameter name for passing additional permissions. If a request authenticated with this token contains a parameter with the name specified here, its value will be added to ``permissions`` . If omitted, this is not configured. * - ``expires`` @@ -239,7 +239,7 @@ Request Body "name": "Updated API Token", "permissions": "{role}admin-api\n{role}user", "expires": "2026-01-01T00:00:00", - "versionNo": 1 + "version_no": 1 } Field Descriptions @@ -257,9 +257,9 @@ For updates, the following fields are used in addition to the fields used at cre * - ``id`` - Yes - ID of the token to update - * - ``versionNo`` + * - ``version_no`` - Yes - - Version number for optimistic locking. Specify the ``versionNo`` of the token retrieved beforehand. + - Version number for optimistic locking. Specify the ``version_no`` of the token retrieved beforehand. .. note:: diff --git a/en/15.9/api/admin/api-admin-badword.rst b/en/15.9/api/admin/api-admin-badword.rst index 35bdffaae..d9c39b73b 100644 --- a/en/15.9/api/admin/api-admin-badword.rst +++ b/en/15.9/api/admin/api-admin-badword.rst @@ -92,7 +92,7 @@ Response "settings": [ { "id": "badword_id_1", - "suggestWord": "inappropriate_word" + "suggest_word": "inappropriate_word" } ], "total": 5 @@ -119,7 +119,7 @@ Response "status": 0, "setting": { "id": "badword_id_1", - "suggestWord": "inappropriate_word" + "suggest_word": "inappropriate_word" } } } @@ -141,7 +141,7 @@ Request Body .. code-block:: json { - "suggestWord": "spam_keyword" + "suggest_word": "spam_keyword" } Field Description @@ -154,7 +154,7 @@ Field Description * - Field - Required - Description - * - ``suggestWord`` + * - ``suggest_word`` - Yes - Keyword to exclude (cannot contain whitespace characters) @@ -189,8 +189,8 @@ Request Body { "id": "existing_badword_id", - "suggestWord": "updated_spam_keyword", - "versionNo": 1 + "suggest_word": "updated_spam_keyword", + "version_no": 1 } Response @@ -260,7 +260,7 @@ CSV Format ~~~~~~~~~~ - The first line is skipped as a header row (the column name is arbitrary; ``BadWord`` is written on download). -- From the second line onward, write one bad word per line as the ``suggestWord``. +- From the second line onward, write one bad word per line as the ``suggest_word``. - Lines whose value is blank are ignored. - Prefix a word with ``--`` to delete it (e.g., ``--spam`` deletes ``spam``). - Specifying an already-registered word is treated as an update (the updater and update time are reset). @@ -306,7 +306,7 @@ Exclude Spam Keyword -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "suggestWord": "spam" + "suggest_word": "spam" }' Upload CSV File diff --git a/en/15.9/api/admin/api-admin-boostdoc.rst b/en/15.9/api/admin/api-admin-boostdoc.rst index 25e7feef3..674368858 100644 --- a/en/15.9/api/admin/api-admin-boostdoc.rst +++ b/en/15.9/api/admin/api-admin-boostdoc.rst @@ -10,19 +10,19 @@ By configuring document boosts, you can raise the score of documents matching sp and make them appear higher in search results. Boosts are applied to each document at index time (during crawling). -Both the condition (``urlExpr``) and the boost value (``boostExpr``) are evaluated using the scripting -engine specified in the ``scriptType`` field. ``scriptType`` can be ``javascript`` or ``groovy`` (which -requires the ``fess-script-groovy`` plugin). The admin console's create screen prefills ``scriptType`` -with ``javascript``, but if this API's request body omits ``scriptType``, it is not auto-filled and the +Both the condition (``url_expr``) and the boost value (``boost_expr``) are evaluated using the scripting +engine specified in the ``script_type`` field. ``script_type`` can be ``javascript`` or ``groovy`` (which +requires the ``fess-script-groovy`` plugin). The admin console's create screen prefills ``script_type`` +with ``javascript``, but if this API's request body omits ``script_type``, it is not auto-filled and the expressions are evaluated as Groovy. -Multiple rules are evaluated in ascending order of ``sortOrder``, and only the boost value of the first +Multiple rules are evaluated in ascending order of ``sort_order``, and only the boost value of the first matching rule is applied (once a matching rule is found, subsequent rules are not evaluated). .. note:: - In the admin console, ``urlExpr`` is displayed as "Condition", ``boostExpr`` as "Boost Expression", and - ``scriptType`` as "Script Type". ``scriptType`` appears only in the create/update/detail (list and single) - request bodies and responses, not in the list filter parameters (``urlExpr``, ``boostExpr``). + In the admin console, ``url_expr`` is displayed as "Condition", ``boost_expr`` as "Boost Expression", and + ``script_type`` as "Script Type". ``script_type`` appears only in the create/update/detail (list and single) + request bodies and responses, not in the list filter parameters (``url_expr``, ``boost_expr``). For details on configuration items, refer to :doc:`../../admin/boostdoc-guide`. Base URL @@ -93,11 +93,11 @@ Parameters - Integer - No - Page number (starts from 1; default: 1) - * - ``urlExpr`` + * - ``url_expr`` - String - No - Filter by condition expression (partial match) - * - ``boostExpr`` + * - ``boost_expr`` - String - No - Filter by boost expression (partial match) @@ -113,11 +113,11 @@ Response "settings": [ { "id": "boostdoc_id_1", - "urlExpr": "url.startsWith(\"https://docs.example.com/\")", - "boostExpr": "3.0", - "scriptType": "javascript", - "sortOrder": 1, - "versionNo": 1 + "url_expr": "url.startsWith(\"https://docs.example.com/\")", + "boost_expr": "3.0", + "script_type": "javascript", + "sort_order": 1, + "version_no": 1 } ], "total": 5 @@ -127,8 +127,8 @@ Response .. note:: In addition to the fields shown above, each setting object in the response also includes - creation/update metadata (``createdBy``, ``createdTime``, ``updatedBy``, ``updatedTime``). - ``versionNo`` is required when updating (PUT), so retrieve its current value via the get or list API before updating. + creation/update metadata (``created_by``, ``created_time``, ``updated_by``, ``updated_time``). + ``version_no`` is required when updating (PUT), so retrieve its current value via the get or list API before updating. Get Document Boost ================== @@ -150,11 +150,11 @@ Response "status": 0, "setting": { "id": "boostdoc_id_1", - "urlExpr": "url.startsWith(\"https://docs.example.com/\")", - "boostExpr": "3.0", - "scriptType": "javascript", - "sortOrder": 1, - "versionNo": 1 + "url_expr": "url.startsWith(\"https://docs.example.com/\")", + "boost_expr": "3.0", + "script_type": "javascript", + "sort_order": 1, + "version_no": 1 } } } @@ -176,10 +176,10 @@ Request Body .. code-block:: json { - "urlExpr": "url.startsWith(\"https://important.example.com/\")", - "boostExpr": "5.0", - "scriptType": "javascript", - "sortOrder": 0 + "url_expr": "url.startsWith(\"https://important.example.com/\")", + "boost_expr": "5.0", + "script_type": "javascript", + "sort_order": 0 } Field Descriptions @@ -192,16 +192,16 @@ Field Descriptions * - Field - Required - Description - * - ``urlExpr`` + * - ``url_expr`` - Yes - Condition expression. A script expression that determines whether a document should be boosted, returning ``Boolean``. Corresponds to "Condition" in the admin console (maximum 10,000 characters). - * - ``boostExpr`` + * - ``boost_expr`` - Yes - Boost expression. A script expression that returns the boost value (numeric). A fixed value such as ``3.0`` can also be specified. Corresponds to "Boost Expression" in the admin console (maximum 10,000 characters). - * - ``scriptType`` + * - ``script_type`` - No - - The scripting engine used to evaluate ``urlExpr`` and ``boostExpr``. Either ``javascript`` or ``groovy`` (which requires the ``fess-script-groovy`` plugin). Corresponds to "Script Type" in the admin console (maximum 100 characters). If omitted, the expressions are evaluated as Groovy. - * - ``sortOrder`` + - The scripting engine used to evaluate ``url_expr`` and ``boost_expr``. Either ``javascript`` or ``groovy`` (which requires the ``fess-script-groovy`` plugin). Corresponds to "Script Type" in the admin console (maximum 100 characters). If omitted, the expressions are evaluated as Groovy. + * - ``sort_order`` - Yes - Evaluation order. Rules are evaluated in ascending order, and the boost value of the first matching rule is applied (form default value: 0; must be an integer of 0 or greater). @@ -236,15 +236,15 @@ Request Body { "id": "existing_boostdoc_id", - "urlExpr": "url.startsWith(\"https://important.example.com/\")", - "boostExpr": "10.0", - "scriptType": "javascript", - "sortOrder": 0, - "versionNo": 1 + "url_expr": "url.startsWith(\"https://important.example.com/\")", + "boost_expr": "10.0", + "script_type": "javascript", + "sort_order": 0, + "version_no": 1 } -For updates, in addition to the fields used when creating, ``id`` (the ID of the target rule, up to 1000 characters) and ``versionNo`` (the version number for optimistic locking) are required. -Specify the current version number from the get or list API response for ``versionNo``. The update fails if the version number does not match. +For updates, in addition to the fields used when creating, ``id`` (the ID of the target rule, up to 1000 characters) and ``version_no`` (the version number for optimistic locking) are required. +Specify the current version number from the get or list API response for ``version_no``. The update fails if the version number does not match. Response -------- @@ -283,13 +283,13 @@ Response Condition and Boost Expressions ================================ -Both ``urlExpr`` (condition) and ``boostExpr`` (boost expression) are evaluated using the scripting engine -specified by ``scriptType`` (default: Groovy; only the admin console's create screen prefills +Both ``url_expr`` (condition) and ``boost_expr`` (boost expression) are evaluated using the scripting engine +specified by ``script_type`` (default: Groovy; only the admin console's create screen prefills ``javascript``). Inside an expression, the field values of the document being indexed can be referenced as variables by field name. -- ``urlExpr`` must return ``Boolean`` (e.g., ``url.startsWith("https://docs.example.com/")``). A plain regular expression string (e.g., ``.*docs\.example\.com.*``) does not return ``Boolean`` as a script expression and therefore does not function as a condition. To use regular expressions, use ``String#matches`` (available with the same notation in both Groovy and JavaScript). -- ``boostExpr`` must return a numeric value. The result is converted to ``float``, and the boost is applied only when the value is greater than 0. +- ``url_expr`` must return ``Boolean`` (e.g., ``url.startsWith("https://docs.example.com/")``). A plain regular expression string (e.g., ``.*docs\.example\.com.*``) does not return ``Boolean`` as a script expression and therefore does not function as a condition. To use regular expressions, use ``String#matches`` (available with the same notation in both Groovy and JavaScript). +- ``boost_expr`` must return a numeric value. The result is converted to ``float``, and the boost is applied only when the value is greater than 0. .. note:: @@ -298,8 +298,8 @@ Inside an expression, the field values of the document being indexed can be refe ``indexer.favorite.count.enabled`` are enabled (both enabled by default), respectively. OpenSearch date-math syntax such as ``now - 7d`` cannot be used in either Groovy or JavaScript. -urlExpr Examples ----------------- +url_expr Examples +----------------- .. list-table:: :header-rows: 1 @@ -314,8 +314,8 @@ urlExpr Examples * - ``title.contains("Release Notes")`` - Target documents whose title contains a specific term -boostExpr Examples ------------------- +boost_expr Examples +------------------- .. list-table:: :header-rows: 1 @@ -342,9 +342,9 @@ Boost a Documentation Site -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "urlExpr": "url.startsWith(\"https://docs.example.com/\")", - "boostExpr": "5.0", - "sortOrder": 0 + "url_expr": "url.startsWith(\"https://docs.example.com/\")", + "boost_expr": "5.0", + "sort_order": 0 }' Boost Frequently Clicked Content @@ -356,9 +356,9 @@ Boost Frequently Clicked Content -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "urlExpr": "url.startsWith(\"https://www.example.com/\")", - "boostExpr": "click_count * 0.1 + 1", - "sortOrder": 10 + "url_expr": "url.startsWith(\"https://www.example.com/\")", + "boost_expr": "click_count * 0.1 + 1", + "sort_order": 10 }' Reference diff --git a/en/15.9/api/admin/api-admin-crawlinginfo.rst b/en/15.9/api/admin/api-admin-crawlinginfo.rst index 3e52270fa..633b2e1ab 100644 --- a/en/15.9/api/admin/api-admin-crawlinginfo.rst +++ b/en/15.9/api/admin/api-admin-crawlinginfo.rst @@ -67,7 +67,7 @@ Parameters - Integer - No - Page number (1-based, default: 1) - * - ``sessionId`` + * - ``session_id`` - String - No - Session ID filter (partial match) @@ -83,17 +83,17 @@ Response "logs": [ { "id": "crawling_info_id_1", - "sessionId": "20250129100000", + "session_id": "20250129100000", "name": "Default Crawler", - "expiredTime": "1738200000000", - "createdTime": 1738108800000 + "expired_time": "1738200000000", + "created_time": 1738108800000 }, { "id": "crawling_info_id_2", - "sessionId": "20250128100000", + "session_id": "20250128100000", "name": "Default Crawler", - "expiredTime": "1738113600000", - "createdTime": 1738022400000 + "expired_time": "1738113600000", + "created_time": 1738022400000 } ], "total": 10 @@ -111,18 +111,18 @@ Response Fields - Description * - ``id`` - Crawl information ID - * - ``sessionId`` + * - ``session_id`` - Session ID * - ``name`` - Session name - * - ``expiredTime`` + * - ``expired_time`` - Expiration time (epoch milliseconds; returned as a string) - * - ``createdTime`` + * - ``created_time`` - Created time (epoch milliseconds; returned as a number) .. note:: - Each log object in the response also includes an internal ``crudMode`` field + Each log object in the response also includes an internal ``crud_mode`` field (an integer indicating the CRUD operation mode, always ``0`` for read operations). Clients can safely ignore it. @@ -146,10 +146,10 @@ Response "status": 0, "log": { "id": "crawling_info_id_1", - "sessionId": "20250129100000", + "session_id": "20250129100000", "name": "Default Crawler", - "expiredTime": "1738200000000", - "createdTime": 1738108800000 + "expired_time": "1738200000000", + "created_time": 1738108800000 } } } diff --git a/en/15.9/api/admin/api-admin-dataconfig.rst b/en/15.9/api/admin/api-admin-dataconfig.rst index 1e2104544..51aec9365 100644 --- a/en/15.9/api/admin/api-admin-dataconfig.rst +++ b/en/15.9/api/admin/api-admin-dataconfig.rst @@ -74,7 +74,7 @@ Parameters - String - No - Filter by configuration name - * - ``handlerName`` + * - ``handler_name`` - String - No - Filter by handler name @@ -96,14 +96,14 @@ Response "id": "dataconfig_id_1", "name": "Database Crawler", "description": "Database crawler", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/mydb", - "handlerScript": "...", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/mydb", + "handler_script": "...", "boost": 1.0, "available": "true", "permissions": "{role}admin", - "virtualHosts": "", - "sortOrder": 0 + "virtual_hosts": "", + "sort_order": 0 } ], "total": 5 @@ -132,14 +132,14 @@ Response "id": "dataconfig_id_1", "name": "Database Crawler", "description": "Database crawler", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/mydb\nusername=dbuser\npassword=dbpass", - "handlerScript": "...", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/mydb\nusername=dbuser\npassword=dbpass", + "handler_script": "...", "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin", - "virtualHosts": "" + "virtual_hosts": "" } } } @@ -162,12 +162,12 @@ Request Body { "name": "Product Database", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/products\nusername=user\npassword=pass", - "handlerScript": "url=\"https://example.com/product/\" + product_id\ntitle=product_name\ncontent=description", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/products\nusername=user\npassword=pass", + "handler_script": "url=\"https://example.com/product/\" + product_id\ntitle=product_name\ncontent=description", "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin\n{role}user" } @@ -187,13 +187,13 @@ Field Description * - ``description`` - No - Configuration description - * - ``handlerName`` + * - ``handler_name`` - Yes - Data store handler name - * - ``handlerParameter`` + * - ``handler_parameter`` - No - Handler parameters (connection information, etc.) - * - ``handlerScript`` + * - ``handler_script`` - No - Data transformation script * - ``boost`` @@ -202,13 +202,13 @@ Field Description * - ``available`` - Yes - Enable/disable (string ``"true"`` / ``"false"``) - * - ``sortOrder`` + * - ``sort_order`` - Yes - Display order * - ``permissions`` - No - Access permission roles (newline-separated for multiple values) - * - ``virtualHosts`` + * - ``virtual_hosts`` - No - Virtual hosts (newline-separated for multiple values) @@ -244,16 +244,16 @@ Request Body { "id": "existing_dataconfig_id", "name": "Updated Product Database", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/products\nusername=user\npassword=newpass", - "handlerScript": "url=\"https://example.com/product/\" + product_id\ntitle=product_name\ncontent=description + \" \" + features", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/products\nusername=user\npassword=newpass", + "handler_script": "url=\"https://example.com/product/\" + product_id\ntitle=product_name\ncontent=description + \" \" + features", "boost": 1.5, "available": "true", - "sortOrder": 0, - "versionNo": 1 + "sort_order": 0, + "version_no": 1 } -Update requests require the same required fields as creation (``name``, ``handlerName``, ``boost``, ``available``, ``sortOrder``), plus the following fields: +Update requests require the same required fields as creation (``name``, ``handler_name``, ``boost``, ``available``, ``sort_order``), plus the following fields: .. list-table:: :header-rows: 1 @@ -265,7 +265,7 @@ Update requests require the same required fields as creation (``name``, ``handle * - ``id`` - Yes - ID of the configuration to update - * - ``versionNo`` + * - ``version_no`` - Yes - Version number for optimistic locking (specify the value returned when the setting was retrieved) @@ -338,12 +338,12 @@ Database Crawl Configuration -H "Content-Type: application/json" \ -d '{ "name": "User Database", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/userdb\nusername=dbuser\npassword=dbpass\nsql=SELECT * FROM users WHERE active=true", - "handlerScript": "url=\"https://example.com/user/\" + user_id\ntitle=username\ncontent=profile", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/userdb\nusername=dbuser\npassword=dbpass\nsql=SELECT * FROM users WHERE active=true", + "handler_script": "url=\"https://example.com/user/\" + user_id\ntitle=username\ncontent=profile", "boost": 1.0, "available": "true", - "sortOrder": 0 + "sort_order": 0 }' Reference diff --git a/en/15.9/api/admin/api-admin-dict.rst b/en/15.9/api/admin/api-admin-dict.rst index 6b5cb7611..8417eefc6 100644 --- a/en/15.9/api/admin/api-admin-dict.rst +++ b/en/15.9/api/admin/api-admin-dict.rst @@ -179,7 +179,7 @@ The fields of each item in the ``settings`` array of the response differ by dict "settings": [ { "id": 1, - "dictId": "ZjA5...synonym.txt", + "dict_id": "ZjA5...synonym.txt", "inputs": "検索,サーチ", "outputs": "検索,サーチ,リサーチ" } @@ -233,7 +233,7 @@ Response "status": 0, "setting": { "id": 1, - "dictId": "ZjA5...synonym.txt", + "dict_id": "ZjA5...synonym.txt", "inputs": "検索,サーチ", "outputs": "検索,サーチ,リサーチ" } @@ -406,7 +406,7 @@ Item Fields per Dictionary Type =============================== The fields of the request body and response for creating and updating dictionary items differ by dictionary type. -``id`` (item ID) and ``dictId`` (dictionary ID) are commonly included in the response. +``id`` (item ID) and ``dict_id`` (dictionary ID) are commonly included in the response. .. list-table:: :header-rows: 1 diff --git a/en/15.9/api/admin/api-admin-elevateword.rst b/en/15.9/api/admin/api-admin-elevateword.rst index de0d111e0..2b12ed09a 100644 --- a/en/15.9/api/admin/api-admin-elevateword.rst +++ b/en/15.9/api/admin/api-admin-elevateword.rst @@ -92,11 +92,11 @@ Response "settings": [ { "id": "elevate_id_1", - "suggestWord": "fess", + "suggest_word": "fess", "reading": "", "permissions": "{role}guest", "boost": 100.0, - "labelTypeIds": [] + "label_type_ids": [] } ], "total": 5 @@ -123,11 +123,11 @@ Response "status": 0, "setting": { "id": "elevate_id_1", - "suggestWord": "fess", + "suggest_word": "fess", "reading": "", "permissions": "{role}guest", "boost": 100.0, - "labelTypeIds": [] + "label_type_ids": [] } } } @@ -149,11 +149,11 @@ Request Body .. code-block:: json { - "suggestWord": "documentation", + "suggest_word": "documentation", "reading": "", "permissions": "{role}guest", "boost": 100.0, - "labelTypeIds": ["label1"] + "label_type_ids": ["label1"] } Field Description @@ -166,7 +166,7 @@ Field Description * - Field - Required - Description - * - ``suggestWord`` + * - ``suggest_word`` - Yes - Keyword to elevate * - ``reading`` @@ -178,7 +178,7 @@ Field Description * - ``boost`` - Yes - Boost value (form default value: 100.0) - * - ``labelTypeIds`` + * - ``label_type_ids`` - No - Target label IDs (array of strings) @@ -213,12 +213,12 @@ Request Body { "id": "existing_elevate_id", - "suggestWord": "documentation", + "suggest_word": "documentation", "reading": "", "permissions": "{role}guest\n{role}user", "boost": 100.0, - "labelTypeIds": ["label1"], - "versionNo": 1 + "label_type_ids": ["label1"], + "version_no": 1 } .. note:: @@ -226,7 +226,7 @@ Request Body When updating, the following fields are required in addition to the fields used for creation: - ``id`` - ID of the elevate word to update - - ``versionNo`` - Version number for optimistic locking. Specify the value obtained from ``GET /setting/{id}``. + - ``version_no`` - Version number for optimistic locking. Specify the value obtained from ``GET /setting/{id}``. Response -------- @@ -326,7 +326,7 @@ Elevate Product Name -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "suggestWord": "Product X", + "suggest_word": "Product X", "boost": 100.0, "permissions": "{role}guest" }' @@ -340,9 +340,9 @@ Elevate to Specific Label -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "suggestWord": "API reference", + "suggest_word": "API reference", "boost": 100.0, - "labelTypeIds": ["technical_docs"], + "label_type_ids": ["technical_docs"], "permissions": "{role}guest" }' diff --git a/en/15.9/api/admin/api-admin-failureurl.rst b/en/15.9/api/admin/api-admin-failureurl.rst index e22dd912b..ec1ab7c57 100644 --- a/en/15.9/api/admin/api-admin-failureurl.rst +++ b/en/15.9/api/admin/api-admin-failureurl.rst @@ -71,15 +71,15 @@ Parameters - String - No - URL filter (wildcards ``*`` ``?`` supported) - * - ``errorCountMin`` + * - ``error_count_min`` - Integer - No - Lower bound for the error count (greater than or equal to the specified value) - * - ``errorCountMax`` + * - ``error_count_max`` - Integer - No - Upper bound for the error count (less than or equal to the specified value) - * - ``errorName`` + * - ``error_name`` - String - No - Error name filter (wildcard match against the stored fully-qualified class name; ``*`` ``?`` supported) @@ -96,22 +96,22 @@ Response { "id": "failure_id_1", "url": "https://example.com/broken-page", - "threadName": "Crawler-1", - "errorName": "java.net.ConnectException", - "errorLog": "Connection refused: connect", - "errorCount": "3", - "lastAccessTime": "1738144800000", - "configId": "webConfig_id_1" + "thread_name": "Crawler-1", + "error_name": "java.net.ConnectException", + "error_log": "Connection refused: connect", + "error_count": "3", + "last_access_time": "1738144800000", + "config_id": "webConfig_id_1" }, { "id": "failure_id_2", "url": "https://example.com/not-found", - "threadName": "Crawler-2", - "errorName": "org.codelibs.fess.exception.ContentNotFoundException", - "errorLog": "Not found: https://example.com/not-found", - "errorCount": "1", - "lastAccessTime": "1738143000000", - "configId": "webConfig_id_1" + "thread_name": "Crawler-2", + "error_name": "org.codelibs.fess.exception.ContentNotFoundException", + "error_log": "Not found: https://example.com/not-found", + "error_count": "1", + "last_access_time": "1738143000000", + "config_id": "webConfig_id_1" } ], "total": 45 @@ -131,23 +131,23 @@ Response Fields - Failure URL ID * - ``url`` - Failed URL - * - ``threadName`` + * - ``thread_name`` - Thread name - * - ``errorName`` + * - ``error_name`` - Error name (fully-qualified class name of the exception that occurred; e.g. ``java.net.ConnectException``) - * - ``errorLog`` + * - ``error_log`` - Error log (exception message or stack trace) - * - ``errorCount`` + * - ``error_count`` - Number of error occurrences (a numeric value as a string) - * - ``lastAccessTime`` + * - ``last_access_time`` - Last access time (epoch milliseconds as a string) - * - ``configId`` + * - ``config_id`` - Crawl configuration ID .. note:: All response fields are returned as strings (JSON string). - ``errorCount`` is a numeric value represented as a string, and ``lastAccessTime`` is epoch milliseconds represented as a string. + ``error_count`` is a numeric value represented as a string, and ``last_access_time`` is epoch milliseconds represented as a string. Get Failure URL =============== @@ -170,12 +170,12 @@ Response "log": { "id": "failure_id_1", "url": "https://example.com/broken-page", - "threadName": "Crawler-1", - "errorName": "java.net.ConnectException", - "errorLog": "Connection refused: connect", - "errorCount": "3", - "lastAccessTime": "1738144800000", - "configId": "webConfig_id_1" + "thread_name": "Crawler-1", + "error_name": "java.net.ConnectException", + "error_log": "Connection refused: connect", + "error_count": "3", + "last_access_time": "1738144800000", + "config_id": "webConfig_id_1" } } } @@ -227,7 +227,7 @@ Response Error Types =========== -``errorName`` stores the fully-qualified class name of the exception that occurred during +``error_name`` stores the fully-qualified class name of the exception that occurred during crawling, exactly as captured. It is not a fixed enumeration; any class name may appear depending on the exception that was raised. The following are representative examples. @@ -313,7 +313,7 @@ Aggregate by Error Type # Count by error type curl -X GET "http://localhost:8080/api/admin/failureurl/logs?size=1000" \ -H "Authorization: Bearer YOUR_TOKEN" | \ - jq '[.response.logs[].errorName] | group_by(.) | map({error: .[0], count: length})' + jq '[.response.logs[].error_name] | group_by(.) | map({error: .[0], count: length})' Reference ========= diff --git a/en/15.9/api/admin/api-admin-fileconfig.rst b/en/15.9/api/admin/api-admin-fileconfig.rst index 7f4532eab..0e85b9788 100644 --- a/en/15.9/api/admin/api-admin-fileconfig.rst +++ b/en/15.9/api/admin/api-admin-fileconfig.rst @@ -106,20 +106,20 @@ Response "name": "Shared Documents", "description": "Shared documents", "paths": "smb://server/share/documents", - "includedPaths": ".*\\.pdf$", - "excludedPaths": ".*/(temp|cache)/.*", - "includedDocPaths": "", - "excludedDocPaths": "", - "configParameter": "", + "included_paths": ".*\\.pdf$", + "excluded_paths": ".*/(temp|cache)/.*", + "included_doc_paths": "", + "excluded_doc_paths": "", + "config_parameter": "", "depth": 10, - "maxAccessCount": 1000, - "numOfThread": 1, - "intervalTime": 1000, + "max_access_count": 1000, + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, "available": "true", "permissions": "{role}admin", - "virtualHosts": "", - "sortOrder": 0 + "virtual_hosts": "", + "sort_order": 0 } ], "total": 5 @@ -151,34 +151,34 @@ Response "name": "Shared Documents", "description": "Shared documents", "paths": "smb://server/share/documents", - "includedPaths": ".*\\.pdf$", - "excludedPaths": ".*/(temp|cache)/.*", - "includedDocPaths": "", - "excludedDocPaths": "", - "configParameter": "", + "included_paths": ".*\\.pdf$", + "excluded_paths": ".*/(temp|cache)/.*", + "included_doc_paths": "", + "excluded_doc_paths": "", + "config_parameter": "", "depth": 10, - "maxAccessCount": 1000, - "numOfThread": 1, - "intervalTime": 1000, + "max_access_count": 1000, + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin", - "virtualHosts": "", - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_hosts": "", + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } .. note:: - The response includes ``createdBy``, ``createdTime``, ``updatedBy``, ``updatedTime``, and ``versionNo``, + The response includes ``created_by``, ``created_time``, ``updated_by``, ``updated_time``, and ``version_no``, which are automatically populated by the server when a configuration is created or updated. - ``versionNo`` is required when updating a configuration (see "Update File Crawl Configuration" below). + ``version_no`` is required when updating a configuration (see "Update File Crawl Configuration" below). Create File Crawl Configuration =============================== @@ -199,13 +199,13 @@ Request Body { "name": "Local Files", "paths": "file:///data/documents", - "includedPaths": ".*\\.(pdf|doc|docx|xls|xlsx)$", - "excludedPaths": ".*/(temp|backup)/.*", - "numOfThread": 2, - "intervalTime": 500, + "included_paths": ".*\\.(pdf|doc|docx|xls|xlsx)$", + "excluded_paths": ".*/(temp|backup)/.*", + "num_of_thread": 2, + "interval_time": 500, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin\n{role}user" } @@ -228,31 +228,31 @@ Field Description * - ``paths`` - Yes - Crawl start paths (newline-separated for multiple paths). Specify using one of the following protocols: ``file:``, ``smb:``, ``smb1:``, ``ftp:``, ``s3:``, or ``gcs:`` - * - ``includedPaths`` + * - ``included_paths`` - No - Regex pattern for paths to include in crawling - * - ``excludedPaths`` + * - ``excluded_paths`` - No - Regex pattern for paths to exclude from crawling - * - ``includedDocPaths`` + * - ``included_doc_paths`` - No - Regex pattern for paths to include in indexing - * - ``excludedDocPaths`` + * - ``excluded_doc_paths`` - No - Regex pattern for paths to exclude from indexing - * - ``configParameter`` + * - ``config_parameter`` - No - Additional configuration parameters (``key=value`` format, one entry per line) * - ``depth`` - No - Crawl depth (0 or greater) - * - ``maxAccessCount`` + * - ``max_access_count`` - No - Maximum access count (0 or greater) - * - ``numOfThread`` + * - ``num_of_thread`` - Yes - Number of parallel threads (1 or greater) - * - ``intervalTime`` + * - ``interval_time`` - Yes - Access interval in milliseconds (0 or greater) * - ``boost`` @@ -261,19 +261,19 @@ Field Description * - ``available`` - Yes - Enable/disable (string ``"true"`` / ``"false"``) - * - ``sortOrder`` + * - ``sort_order`` - Yes - Display order (0 or greater) * - ``permissions`` - No - Access permission roles (newline-separated for multiple values) - * - ``virtualHosts`` + * - ``virtual_hosts`` - No - Virtual hosts (newline-separated for multiple values) .. note:: - Audit fields such as ``createdBy``, ``createdTime``, ``updatedBy``, and ``updatedTime`` are + Audit fields such as ``created_by``, ``created_time``, ``updated_by``, and ``updated_time`` are automatically set by the server and do not need to be included in the request body. Response @@ -303,8 +303,8 @@ Request Request Body ~~~~~~~~~~~~ -When updating, ``id`` to identify the target configuration and ``versionNo`` are required in addition to the fields used at creation time. -Specify the current value of ``versionNo`` as returned in the GET response. +When updating, ``id`` to identify the target configuration and ``version_no`` are required in addition to the fields used at creation time. +Specify the current value of ``version_no`` as returned in the GET response. .. code-block:: json @@ -312,16 +312,16 @@ Specify the current value of ``versionNo`` as returned in the GET response. "id": "existing_fileconfig_id", "name": "Updated Local Files", "paths": "file:///data/documents", - "includedPaths": ".*\\.(pdf|doc|docx|xls|xlsx|ppt|pptx)$", - "excludedPaths": ".*/(temp|backup|archive)/.*", + "included_paths": ".*\\.(pdf|doc|docx|xls|xlsx|ppt|pptx)$", + "excluded_paths": ".*/(temp|backup|archive)/.*", "depth": 10, - "maxAccessCount": 10000, - "numOfThread": 3, - "intervalTime": 300, + "max_access_count": 10000, + "num_of_thread": 3, + "interval_time": 300, "boost": 1.2, "available": "true", - "sortOrder": 0, - "versionNo": 1 + "sort_order": 0, + "version_no": 1 } Additional Fields for Update @@ -337,9 +337,9 @@ Additional Fields for Update * - ``id`` - Yes - ID of the configuration to update (up to 1000 characters) - * - ``versionNo`` + * - ``version_no`` - Yes - - Current version number of the configuration to update. Use the ``versionNo`` value from the GET response. + - Current version number of the configuration to update. Use the ``version_no`` value from the GET response. Response -------- @@ -418,13 +418,13 @@ Local File Crawl Configuration -d '{ "name": "Local Files", "paths": "file:///data/documents", - "includedPaths": ".*\\.(pdf|doc|docx)$", - "excludedPaths": ".*/(temp|backup)/.*", - "numOfThread": 2, - "intervalTime": 500, + "included_paths": ".*\\.(pdf|doc|docx)$", + "excluded_paths": ".*/(temp|backup)/.*", + "num_of_thread": 2, + "interval_time": 500, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}guest" }' @@ -439,14 +439,14 @@ SMB Share Crawl Configuration -d '{ "name": "SMB Share", "paths": "smb://server/documents", - "includedPaths": ".*\\.(pdf|doc|docx)$", - "excludedPaths": ".*/(temp|private)/.*", - "maxAccessCount": 50000, - "numOfThread": 3, - "intervalTime": 200, + "included_paths": ".*\\.(pdf|doc|docx)$", + "excluded_paths": ".*/(temp|private)/.*", + "max_access_count": 50000, + "num_of_thread": 3, + "interval_time": 200, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}guest" }' diff --git a/en/15.9/api/admin/api-admin-general.rst b/en/15.9/api/admin/api-admin-general.rst index 2e69b93c2..dace769e3 100644 --- a/en/15.9/api/admin/api-admin-general.rst +++ b/en/15.9/api/admin/api-admin-general.rst @@ -66,37 +66,36 @@ values such as retention days and thread counts are expressed as numbers. "version": "15.9.0", "status": 0, "setting": { - "incrementalCrawling": "true", - "dayForCleanup": -1, - "crawlingThreadCount": 5, - "searchLog": "true", - "userInfo": "true", - "userFavorite": "false", - "webApiJson": "true", - "defaultLabelValue": "", - "defaultSortValue": "", - "appendQueryParameter": "false", - "loginRequired": "false", + "incremental_crawling": "true", + "day_for_cleanup": -1, + "crawling_thread_count": 5, + "search_log": "true", + "user_info": "true", + "user_favorite": "false", + "web_api_json": "true", + "default_label_value": "", + "default_sort_value": "", + "append_query_parameter": "false", + "login_required": "false", "thumbnail": "true", - "failureCountThreshold": -1, - "popularWord": "true", - "csvFileEncoding": "UTF-8", - "purgeSearchLogDay": 30, - "purgeJobLogDay": 30, - "purgeUserInfoDay": 30, - "purgeSuggestSearchLogDay": 30, - "notificationTo": "", - "suggestSearchLog": "true", - "suggestDocuments": "true", - "ldapProviderUrl": "ldap://localhost:389/", - "ldapBaseDn": "dc=example,dc=com", - "ldapAdminSecurityPrincipal": "cn=admin,dc=example,dc=com", - "ldapAdminSecurityCredentials": null, - "logLevel": "", - "ssoType": "none", - "storageType": "", - "notificationLogin": "", - "notificationSearchTop": "" + "failure_count_threshold": -1, + "popular_word": "true", + "csv_file_encoding": "UTF-8", + "purge_search_log_day": 30, + "purge_job_log_day": 30, + "purge_user_info_day": 30, + "purge_suggest_search_log_day": 30, + "notification_to": "", + "suggest_search_log": "true", + "suggest_documents": "true", + "ldap_provider_url": "ldap://localhost:389/", + "ldap_base_dn": "dc=example,dc=com", + "ldap_admin_security_principal": "cn=admin,dc=example,dc=com", + "log_level": "", + "sso_type": "none", + "storage_type": "", + "notification_login": "", + "notification_search_top": "" } } } @@ -113,11 +112,11 @@ values such as retention days and thread counts are expressed as numbers. For security reasons, fields that contain credentials are not returned with their actual values. - - ``ldapAdminSecurityCredentials`` (LDAP admin password) is always returned as - ``null``. - - Other secrets (``storageAccessKey``, ``storageSecretKey``, ``oicClientId``, - ``oicClientSecret``, ``spnegoPreauthPassword``, ``entraidClientId``, - ``entraidClientSecret``) are returned masked as ``"**********"`` when they are + - ``ldap_admin_security_credentials`` (LDAP admin password) is never included in + the response. + - Other secrets (``storage_access_key``, ``storage_secret_key``, ``oic_client_id``, + ``oic_client_secret``, ``spnego_preauth_password``, ``entraid_client_id``, + ``entraid_client_secret``) are returned masked as ``"**********"`` when they are set, or as an empty string (``""``) when they are not set. Update General Settings @@ -144,10 +143,10 @@ existing values. The following four fields are required and MUST be included in EVERY PUT request, even for a partial update: - - ``dayForCleanup`` - - ``crawlingThreadCount`` - - ``failureCountThreshold`` - - ``csvFileEncoding`` + - ``day_for_cleanup`` + - ``crawling_thread_count`` + - ``failure_count_threshold`` + - ``csv_file_encoding`` If any of them is missing, the request fails validation and the API returns HTTP 400 with ``status: 1`` and an error ``message``. Because the value you send @@ -173,12 +172,12 @@ existing values. .. code-block:: json { - "incrementalCrawling": "true", - "dayForCleanup": -1, - "crawlingThreadCount": 10, - "failureCountThreshold": 100, - "csvFileEncoding": "UTF-8", - "popularWord": "true" + "incremental_crawling": "true", + "day_for_cleanup": -1, + "crawling_thread_count": 10, + "failure_count_threshold": 100, + "csv_file_encoding": "UTF-8", + "popular_word": "true" } Main Fields @@ -195,124 +194,124 @@ settings are specified as the strings ``"true"`` / ``"false"``. * - Field - Required - Description - * - ``incrementalCrawling`` + * - ``incremental_crawling`` - No - Enable/disable incremental crawling - * - ``dayForCleanup`` + * - ``day_for_cleanup`` - Yes - Number of days to retain crawled documents (-1 = cleanup disabled; range: -1 to 1000) - * - ``crawlingThreadCount`` + * - ``crawling_thread_count`` - Yes - Number of threads used for crawling (range: 0 to 100) - * - ``failureCountThreshold`` + * - ``failure_count_threshold`` - Yes - Failure count threshold to stop crawling a URL (-1 = disabled; range: -1 to 10000) - * - ``csvFileEncoding`` + * - ``csv_file_encoding`` - Yes - Encoding for CSV export - * - ``searchLog`` + * - ``search_log`` - No - Enable/disable search query logging - * - ``userInfo`` + * - ``user_info`` - No - Enable/disable recording of user information - * - ``userFavorite`` + * - ``user_favorite`` - No - Enable/disable the favorite feature - * - ``webApiJson`` + * - ``web_api_json`` - No - Enable/disable the JSON Web API - * - ``appValue`` + * - ``app_value`` - No - Application-specific additional configuration value - * - ``virtualHostValue`` + * - ``virtual_host_value`` - No - Virtual host configuration (for multi-tenant setups) - * - ``popularWord`` + * - ``popular_word`` - No - Enable/disable aggregation and display of popular words - * - ``defaultLabelValue`` + * - ``default_label_value`` - No - Default label value - * - ``defaultSortValue`` + * - ``default_sort_value`` - No - Default sort order - * - ``appendQueryParameter`` + * - ``append_query_parameter`` - No - Append query parameters to search result URLs - * - ``loginRequired`` + * - ``login_required`` - No - Whether login is required for search - * - ``loginLink`` + * - ``login_link`` - No - Enable or disable display of the login link on the search screen * - ``thumbnail`` - No - Enable/disable thumbnail generation - * - ``resultCollapsed`` + * - ``result_collapsed`` - No - Enable or disable collapsing of similar documents in search results - * - ``ignoreFailureType`` + * - ``ignore_failure_type`` - No - Crawl failure types to ignore - * - ``crawlingUserAgent`` + * - ``crawling_user_agent`` - No - User-Agent string sent during crawling - * - ``purgeSearchLogDay`` + * - ``purge_search_log_day`` - No - Number of days to retain search logs (-1 = disabled; range: -1 to 100000) - * - ``purgeJobLogDay`` + * - ``purge_job_log_day`` - No - Number of days to retain job logs (-1 = disabled; range: -1 to 100000) - * - ``purgeUserInfoDay`` + * - ``purge_user_info_day`` - No - Number of days to retain user information (-1 = disabled; range: -1 to 100000) - * - ``purgeSuggestSearchLogDay`` + * - ``purge_suggest_search_log_day`` - No - Number of days to retain suggest search logs (0 = disabled; range: 0 to 100000) - * - ``purgeByBots`` + * - ``purge_by_bots`` - No - Bot User-Agents whose search logs are discarded - * - ``notificationTo`` + * - ``notification_to`` - No - Email address to which system notifications are sent - * - ``notificationLogin`` + * - ``notification_login`` - No - Notification message displayed on the login page - * - ``notificationSearchTop`` + * - ``notification_search_top`` - No - Notification message displayed on the search top page - * - ``notificationAdvanceSearch`` + * - ``notification_advance_search`` - No - Notification message displayed on the advanced search page - * - ``suggestSearchLog`` + * - ``suggest_search_log`` - No - Enable/disable suggest from search logs - * - ``suggestDocuments`` + * - ``suggest_documents`` - No - Enable/disable suggest from documents - * - ``logLevel`` + * - ``log_level`` - No - Log level for system logs - * - ``logNotificationEnabled`` + * - ``log_notification_enabled`` - No - Enable/disable notifications for ERROR/WARN logs - * - ``logNotificationLevel`` + * - ``log_notification_level`` - No - Log notification level - * - ``slackWebhookUrls`` + * - ``slack_webhook_urls`` - No - Slack Webhook URL for notifications - * - ``googleChatWebhookUrls`` + * - ``google_chat_webhook_urls`` - No - Google Chat Webhook URL for notifications - * - ``searchUseBrowserLocale`` + * - ``search_use_browser_locale`` - No - Whether to use the browser locale for search - * - ``ragLlmName`` + * - ``rag_llm_name`` - No - LLM provider name used for RAG - * - ``llmLogLevel`` + * - ``llm_log_level`` - No - Log level for LLM-related packages @@ -329,29 +328,29 @@ correspond to the "General" settings in the admin UI). * - Field - Description - * - ``ldapProviderUrl`` + * - ``ldap_provider_url`` - LDAP connection URL - * - ``ldapBaseDn`` + * - ``ldap_base_dn`` - LDAP base DN - * - ``ldapSecurityPrincipal`` + * - ``ldap_security_principal`` - Security principal for LDAP binding - * - ``ldapAdminSecurityPrincipal`` + * - ``ldap_admin_security_principal`` - Security principal for LDAP administrative operations - * - ``ldapAdminSecurityCredentials`` - - LDAP administrator password (replaced with ``null`` in the response) - * - ``ldapAccountFilter`` / ``ldapGroupFilter`` + * - ``ldap_admin_security_credentials`` + - LDAP administrator password (never included in the response) + * - ``ldap_account_filter`` / ``ldap_group_filter`` - User/group search filters - * - ``ldapMemberofAttribute`` + * - ``ldap_memberof_attribute`` - LDAP attribute name indicating group membership - * - ``ssoType`` + * - ``sso_type`` - SSO type (``none`` / ``oic`` / ``saml`` / ``spnego`` / ``entraid``) - * - ``oicClientId`` / ``oicClientSecret`` / ``oicAuthServerUrl`` etc. + * - ``oic_client_id`` / ``oic_client_secret`` / ``oic_auth_server_url`` etc. - OpenID Connect settings - * - ``samlIdpEntityid`` / ``samlSpEntityid`` etc. + * - ``saml_idp_entityid`` / ``saml_sp_entityid`` etc. - SAML settings - * - ``spnegoKrb5Conf`` / ``spnegoLoginConf`` etc. + * - ``spnego_krb5_conf`` / ``spnego_login_conf`` etc. - SPNEGO settings - * - ``entraidClientId`` / ``entraidTenant`` etc. + * - ``entraid_client_id`` / ``entraid_tenant`` etc. - Microsoft Entra ID settings Storage-Related Fields @@ -365,24 +364,24 @@ Cloud storage (S3 / GCS) integration settings can also be managed. * - Field - Description - * - ``storageType`` + * - ``storage_type`` - Storage type (``auto`` / ``s3`` / ``gcs``) - * - ``storageEndpoint`` + * - ``storage_endpoint`` - Storage endpoint URL - * - ``storageAccessKey`` / ``storageSecretKey`` + * - ``storage_access_key`` / ``storage_secret_key`` - Access key / secret key for authentication - * - ``storageBucket`` + * - ``storage_bucket`` - Bucket name - * - ``storageRegion`` + * - ``storage_region`` - S3 region - * - ``storageProjectId`` / ``storageCredentialsPath`` + * - ``storage_project_id`` / ``storage_credentials_path`` - GCS project ID / credentials file path .. note:: - Secret fields such as ``ldapAdminSecurityCredentials``, - ``storageAccessKey`` / ``storageSecretKey``, ``oicClientId`` / ``oicClientSecret``, - ``entraidClientId`` / ``entraidClientSecret``, and ``spnegoPreauthPassword`` keep + Secret fields such as ``ldap_admin_security_credentials``, + ``storage_access_key`` / ``storage_secret_key``, ``oic_client_id`` / ``oic_client_secret``, + ``entraid_client_id`` / ``entraid_client_secret``, and ``spnego_preauth_password`` keep their stored value (are not updated) when the mask value ``"**********"`` is sent as-is. Send the actual value only when you want to change it. @@ -416,8 +415,8 @@ Usage Examples .. note:: - The examples below include the required fields (``dayForCleanup``, - ``crawlingThreadCount``, ``failureCountThreshold``, ``csvFileEncoding``). Because + The examples below include the required fields (``day_for_cleanup``, + ``crawling_thread_count``, ``failure_count_threshold``, ``csv_file_encoding``). Because these must always be sent regardless of what you are changing, retrieve the current values with ``GET`` and include them in actual operation (the examples below use default values). @@ -431,11 +430,11 @@ Update Crawl Settings -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "incrementalCrawling": "true", - "crawlingThreadCount": 10, - "failureCountThreshold": 100, - "dayForCleanup": -1, - "csvFileEncoding": "UTF-8" + "incremental_crawling": "true", + "crawling_thread_count": 10, + "failure_count_threshold": 100, + "day_for_cleanup": -1, + "csv_file_encoding": "UTF-8" }' Update Log Retention Period @@ -447,13 +446,13 @@ Update Log Retention Period -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "dayForCleanup": -1, - "crawlingThreadCount": 5, - "failureCountThreshold": -1, - "csvFileEncoding": "UTF-8", - "purgeSearchLogDay": 90, - "purgeJobLogDay": 90, - "purgeUserInfoDay": 90 + "day_for_cleanup": -1, + "crawling_thread_count": 5, + "failure_count_threshold": -1, + "csv_file_encoding": "UTF-8", + "purge_search_log_day": 90, + "purge_job_log_day": 90, + "purge_user_info_day": 90 }' Update Suggest Settings @@ -465,12 +464,12 @@ Update Suggest Settings -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "dayForCleanup": -1, - "crawlingThreadCount": 5, - "failureCountThreshold": -1, - "csvFileEncoding": "UTF-8", - "suggestSearchLog": "true", - "suggestDocuments": "true" + "day_for_cleanup": -1, + "crawling_thread_count": 5, + "failure_count_threshold": -1, + "csv_file_encoding": "UTF-8", + "suggest_search_log": "true", + "suggest_documents": "true" }' See Also diff --git a/en/15.9/api/admin/api-admin-group.rst b/en/15.9/api/admin/api-admin-group.rst index 7b4266f12..329a26c0c 100644 --- a/en/15.9/api/admin/api-admin-group.rst +++ b/en/15.9/api/admin/api-admin-group.rst @@ -90,7 +90,7 @@ Response "attributes": { "gidNumber": "1000" }, - "versionNo": 1 + "version_no": 1 }, { "id": "group_id_2", @@ -98,7 +98,7 @@ Response "attributes": { "gidNumber": "1001" }, - "versionNo": 1 + "version_no": 1 } ], "total": 5 @@ -129,7 +129,7 @@ Response "attributes": { "gidNumber": "1000" }, - "versionNo": 1 + "version_no": 1 } } } @@ -209,7 +209,7 @@ Request Body "attributes": { "gidNumber": "1002" }, - "versionNo": 1 + "version_no": 1 } Field Description @@ -231,9 +231,9 @@ Field Description * - ``attributes`` - No - Map of attributes (includes LDAP attributes such as ``gidNumber``). Values are specified as strings - * - ``versionNo`` + * - ``version_no`` - Yes - - Version number for optimistic locking. Specify the ``versionNo`` value obtained from Get Group + - Version number for optimistic locking. Specify the ``version_no`` value obtained from Get Group Response -------- diff --git a/en/15.9/api/admin/api-admin-joblog.rst b/en/15.9/api/admin/api-admin-joblog.rst index 61b52986c..091794c87 100644 --- a/en/15.9/api/admin/api-admin-joblog.rst +++ b/en/15.9/api/admin/api-admin-joblog.rst @@ -81,25 +81,25 @@ Response "logs": [ { "id": "joblog_id_1", - "jobName": "Default Crawler", - "jobStatus": "ok", + "job_name": "Default Crawler", + "job_status": "ok", "target": "all", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "scriptResult": "Job completed successfully", - "startTime": "1738116000000", - "endTime": "1738118723000" + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "script_result": "Job completed successfully", + "start_time": "1738116000000", + "end_time": "1738118723000" }, { "id": "joblog_id_2", - "jobName": "Default Crawler", - "jobStatus": "fail", + "job_name": "Default Crawler", + "job_status": "fail", "target": "all", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "scriptResult": "Error: Connection timeout", - "startTime": "1738029600000", - "endTime": "1738030215000" + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "script_result": "Error: Connection timeout", + "start_time": "1738029600000", + "end_time": "1738030215000" } ], "total": 100 @@ -117,26 +117,26 @@ Response Fields - Description * - ``id`` - Job log ID - * - ``jobName`` + * - ``job_name`` - Job name - * - ``jobStatus`` + * - ``job_status`` - Job status (``ok``: success, ``fail``: failure, ``running``: in progress) * - ``target`` - Execution target (scheduler target name; default is ``all``) - * - ``scriptType`` + * - ``script_type`` - Script type (e.g., ``javascript``) - * - ``scriptData`` + * - ``script_data`` - Execution script - * - ``scriptResult`` + * - ``script_result`` - Execution result - * - ``startTime`` + * - ``start_time`` - Start time (epoch milliseconds; returned as a string) - * - ``endTime`` + * - ``end_time`` - End time (epoch milliseconds; returned as a string). Not returned for running jobs. .. note:: - Each log object in the response also includes an internal ``crudMode`` field + Each log object in the response also includes an internal ``crud_mode`` field (an integer indicating the CRUD operation mode, always ``0`` for read operations). Clients can safely ignore it. @@ -160,14 +160,14 @@ Response "status": 0, "log": { "id": "joblog_id_1", - "jobName": "Default Crawler", - "jobStatus": "ok", + "job_name": "Default Crawler", + "job_status": "ok", "target": "all", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "scriptResult": "Crawl completed successfully.\nDocuments indexed: 1234\nDocuments updated: 567\nDocuments deleted: 12\nErrors: 0", - "startTime": "1738116000000", - "endTime": "1738118723000" + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "script_result": "Crawl completed successfully.\nDocuments indexed: 1234\nDocuments updated: 567\nDocuments deleted: 12\nErrors: 0", + "start_time": "1738116000000", + "end_time": "1738118723000" } } } diff --git a/en/15.9/api/admin/api-admin-keymatch.rst b/en/15.9/api/admin/api-admin-keymatch.rst index c16f646d1..73bc20711 100644 --- a/en/15.9/api/admin/api-admin-keymatch.rst +++ b/en/15.9/api/admin/api-admin-keymatch.rst @@ -92,9 +92,9 @@ Response "id": "keymatch_id_1", "term": "download", "query": "title:download OR content:download", - "maxSize": 10, + "max_size": 10, "boost": 10.0, - "versionNo": 1 + "version_no": 1 } ], "total": 5 @@ -104,8 +104,8 @@ Response .. note:: ``total`` contains the total number of records matching the filter conditions (not the count of items on the current page). - In addition to the fields above, each settings object may include ``virtualHost``, - ``createdBy``, ``createdTime``, ``updatedBy``, and ``updatedTime`` when values are set. + In addition to the fields above, each settings object may include ``virtual_host``, + ``created_by``, ``created_time``, ``updated_by``, and ``updated_time`` when values are set. Get Key Match ============= @@ -129,21 +129,21 @@ Response "id": "keymatch_id_1", "term": "download", "query": "title:download OR content:download", - "maxSize": 10, + "max_size": 10, "boost": 10.0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } .. note:: - ``versionNo`` is the version number used for optimistic locking. When updating a key match, include the - ``versionNo`` obtained from this response in the request body. An error is returned if the specified ID does not exist. + ``version_no`` is the version number used for optimistic locking. When updating a key match, include the + ``version_no`` obtained from this response in the request body. An error is returned if the specified ID does not exist. Create Key Match ================ @@ -164,7 +164,7 @@ Request Body { "term": "pricing", "query": "url:*/pricing* OR title:pricing", - "maxSize": 5, + "max_size": 5, "boost": 20.0 } @@ -187,7 +187,7 @@ Field Description - String - Yes - Match condition query (maximum length follows the value of ``form.admin.max.input.size``) - * - ``maxSize`` + * - ``max_size`` - Integer - Yes - Maximum display count (integer of 0 or greater; form initial value: 10) @@ -195,16 +195,16 @@ Field Description - Float - Yes - Boost value (form initial value: 100.0) - * - ``virtualHost`` + * - ``virtual_host`` - String - No - Virtual host name (maximum 1000 characters; specify when switching key matches per virtual host) .. note:: - ``maxSize`` and ``boost`` are required when using the API. The initial values are those shown in the admin console form and + ``max_size`` and ``boost`` are required when using the API. The initial values are those shown in the admin console form and are not applied via the API. Omitting them results in a validation error. - Note that ``createdBy`` and ``createdTime`` are overwritten by the server even if specified in the request. + Note that ``created_by`` and ``created_time`` are overwritten by the server even if specified in the request. Response -------- @@ -239,15 +239,15 @@ Request Body "id": "existing_keymatch_id", "term": "pricing", "query": "url:*/pricing* OR title:pricing OR content:price", - "maxSize": 10, + "max_size": 10, "boost": 15.0, - "versionNo": 1 + "version_no": 1 } Field Description ~~~~~~~~~~~~~~~~~ -In addition to the fields used for creation (``term``, ``query``, ``maxSize``, ``boost``, ``virtualHost``), +In addition to the fields used for creation (``term``, ``query``, ``max_size``, ``boost``, ``virtual_host``), specify the following fields. .. list-table:: @@ -262,7 +262,7 @@ specify the following fields. - String - Yes - ID of the key match to update (maximum 1000 characters) - * - ``versionNo`` + * - ``version_no`` - Integer - Yes - Version number for optimistic locking; specify the value obtained when retrieving the record @@ -315,7 +315,7 @@ Create Product Page Key Match -d '{ "term": "product features", "query": "url:*/products/* AND (title:features OR content:features)", - "maxSize": 10, + "max_size": 10, "boost": 15.0 }' @@ -330,7 +330,7 @@ Support Page Key Match -d '{ "term": "help", "query": "url:*/support/* OR url:*/help/* OR url:*/faq/*", - "maxSize": 5, + "max_size": 5, "boost": 20.0 }' diff --git a/en/15.9/api/admin/api-admin-labeltype.rst b/en/15.9/api/admin/api-admin-labeltype.rst index d1b1e576d..293b2e6f0 100644 --- a/en/15.9/api/admin/api-admin-labeltype.rst +++ b/en/15.9/api/admin/api-admin-labeltype.rst @@ -99,16 +99,16 @@ Response "id": "label_id_1", "name": "Documentation", "value": "docs", - "includedPaths": ".*docs\\.example\\.com.*", - "excludedPaths": "", + "included_paths": ".*docs\\.example\\.com.*", + "excluded_paths": "", "permissions": "{role}admin", - "virtualHost": "", - "sortOrder": 0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_host": "", + "sort_order": 0, + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } ], "total": 5 @@ -117,8 +117,8 @@ Response .. note:: - Each settings object also includes ``createdBy`` / ``createdTime`` / ``updatedBy`` / - ``updatedTime`` for auditing, and ``versionNo`` for optimistic locking (fields with a + Each settings object also includes ``created_by`` / ``created_time`` / ``updated_by`` / + ``updated_time`` for auditing, and ``version_no`` for optimistic locking (fields with a ``null`` value are omitted). The ``response`` object always includes ``version`` indicating the product version, but it may be omitted in subsequent examples for brevity. @@ -144,16 +144,16 @@ Response "id": "label_id_1", "name": "Documentation", "value": "docs", - "includedPaths": ".*docs\\.example\\.com.*", - "excludedPaths": "", + "included_paths": ".*docs\\.example\\.com.*", + "excluded_paths": "", "permissions": "{role}admin", - "virtualHost": "", - "sortOrder": 0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_host": "", + "sort_order": 0, + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } @@ -177,9 +177,9 @@ Request Body { "name": "News", "value": "news", - "includedPaths": ".*news\\.example\\.com.*\n.*example\\.com/news/.*", - "excludedPaths": ".*/(archive|old)/.*", - "sortOrder": 1, + "included_paths": ".*news\\.example\\.com.*\n.*example\\.com/news/.*", + "excluded_paths": ".*/(archive|old)/.*", + "sort_order": 1, "permissions": "{role}guest" } @@ -202,11 +202,11 @@ Field Descriptions - String - Yes - Label value (used with the ``label`` parameter in searches). Only alphanumeric characters and underscores (``_``) are allowed; must match the regex ``^[a-zA-Z0-9_]+$`` (max 100 characters). - * - ``includedPaths`` + * - ``included_paths`` - String - No - Regular expressions for paths to be labelled. Separate multiple entries with a newline (``\n``). - * - ``excludedPaths`` + * - ``excluded_paths`` - String - No - Regular expressions for paths to exclude from labelling. Separate multiple entries with a newline (``\n``). @@ -214,18 +214,18 @@ Field Descriptions - String - No - Roles/groups/users permitted to access (e.g. ``{role}admin``). Separate multiple entries with a newline (``\n``). - * - ``sortOrder`` + * - ``sort_order`` - Integer - No - Display order (non-negative integer). Defaults to ``0`` if not specified. - * - ``virtualHost`` + * - ``virtual_host`` - String - No - Virtual host (max 1000 characters). .. note:: - Audit fields such as ``createdBy`` / ``createdTime`` are set automatically on the server side + Audit fields such as ``created_by`` / ``created_time`` are set automatically on the server side and do not need to be specified in the request. Response @@ -263,11 +263,11 @@ Request Body "id": "existing_label_id", "name": "News Articles", "value": "news", - "includedPaths": ".*news\\.example\\.com.*\n.*example\\.com/(news|articles)/.*", - "excludedPaths": ".*/(archive|old|draft)/.*", - "sortOrder": 1, + "included_paths": ".*news\\.example\\.com.*\n.*example\\.com/(news|articles)/.*", + "excluded_paths": ".*/(archive|old|draft)/.*", + "sort_order": 1, "permissions": "{role}guest", - "versionNo": 1 + "version_no": 1 } When updating, the following fields are required in addition to the fields used at creation time. @@ -284,10 +284,10 @@ When updating, the following fields are required in addition to the fields used - String - Yes - The ID of the label type to update. - * - ``versionNo`` + * - ``version_no`` - Integer - Yes - - Version number for optimistic locking. Specify the ``versionNo`` included in the response when the setting was retrieved. If the specified version does not match the current one, the update will fail. + - Version number for optimistic locking. Specify the ``version_no`` included in the response when the setting was retrieved. If the specified version does not match the current one, the update will fail. Response -------- @@ -339,8 +339,8 @@ Create Documentation Label -d '{ "name": "Technical Documentation", "value": "tech_docs", - "includedPaths": ".*docs\\.example\\.com.*\n.*example\\.com/documentation/.*", - "sortOrder": 0, + "included_paths": ".*docs\\.example\\.com.*\n.*example\\.com/documentation/.*", + "sort_order": 0, "permissions": "{role}guest" }' diff --git a/en/15.9/api/admin/api-admin-overview.rst b/en/15.9/api/admin/api-admin-overview.rst index f3ce7629f..fe6158b58 100644 --- a/en/15.9/api/admin/api-admin-overview.rst +++ b/en/15.9/api/admin/api-admin-overview.rst @@ -517,22 +517,22 @@ Create Web Crawl Configuration -d '{ "name": "Example Site", "urls": "https://example.com/", - "includedUrls": ".*example.com.*", - "excludedUrls": "", - "userAgent": "Mozilla/5.0 (compatible; Fess)", - "numOfThread": 1, - "intervalTime": 1000, + "included_urls": ".*example.com.*", + "excluded_urls": "", + "user_agent": "Mozilla/5.0 (compatible; Fess)", + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, - "maxAccessCount": 1000, + "max_access_count": 1000, "depth": 3, - "sortOrder": 1, + "sort_order": 1, "available": "true" }' .. note:: - When creating a Web crawl configuration, ``name``, ``urls``, ``userAgent``, ``numOfThread``, - ``intervalTime``, ``boost``, ``available``, and ``sortOrder`` are required. Omitting any of + When creating a Web crawl configuration, ``name``, ``urls``, ``user_agent``, ``num_of_thread``, + ``interval_time``, ``boost``, ``available``, and ``sort_order`` are required. Omitting any of these results in a validation error (``status: 1``). Specify ``available`` as a string, setting it to ``"true"`` or ``"false"``. diff --git a/en/15.9/api/admin/api-admin-relatedcontent.rst b/en/15.9/api/admin/api-admin-relatedcontent.rst index b96d48d9b..01c2c83c6 100644 --- a/en/15.9/api/admin/api-admin-relatedcontent.rst +++ b/en/15.9/api/admin/api-admin-relatedcontent.rst @@ -93,13 +93,13 @@ Response "id": "content_id_1", "term": "fess", "content": "
Fess is an open source search server.
", - "virtualHost": "", - "sortOrder": 0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_host": "", + "sort_order": 0, + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } ], "total": 5 @@ -110,10 +110,10 @@ Response Each element of ``settings`` and the ``setting`` object returned by the get endpoint contain the fields of the stored entity as-is. In addition to - ``term``, ``content``, ``sortOrder``, and ``virtualHost``, the audit fields - ``createdBy``, ``createdTime``, ``updatedBy``, ``updatedTime`` and the - optimistic-locking field ``versionNo`` are also returned. ``createdTime`` and - ``updatedTime`` are expressed as milliseconds since the epoch (numbers). Fields + ``term``, ``content``, ``sort_order``, and ``virtual_host``, the audit fields + ``created_by``, ``created_time``, ``updated_by``, ``updated_time`` and the + optimistic-locking field ``version_no`` are also returned. ``created_time`` and + ``updated_time`` are expressed as milliseconds since the epoch (numbers). Fields that are not set (null) are omitted from the response. In addition, the ``response`` object of every response always includes ``version``, which indicates the product version (see :doc:`api-admin-overview` for details). @@ -141,20 +141,20 @@ Response "id": "content_id_1", "term": "fess", "content": "
Fess is an open source search server.
", - "virtualHost": "", - "sortOrder": 0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_host": "", + "sort_order": 0, + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } .. note:: - The ``versionNo`` required when updating (PUT) is the value included in this + The ``version_no`` required when updating (PUT) is the value included in this get response. Create Related Content @@ -176,8 +176,8 @@ Request Body { "term": "search", "content": "

About Search

Learn more about search features...

", - "sortOrder": 0, - "virtualHost": "" + "sort_order": 0, + "virtual_host": "" } Field Description @@ -196,10 +196,10 @@ Field Description * - ``content`` - Yes - HTML content to display (max 10000 characters) - * - ``sortOrder`` + * - ``sort_order`` - No - Display order (integer between 0 and 2147483647) - * - ``virtualHost`` + * - ``virtual_host`` - No - Virtual host (max 1000 characters) @@ -237,9 +237,9 @@ Request Body "id": "existing_content_id", "term": "search", "content": "

About Search

Updated information...

", - "sortOrder": 0, - "virtualHost": "", - "versionNo": 1 + "sort_order": 0, + "virtual_host": "", + "version_no": 1 } Field Description @@ -261,13 +261,13 @@ Field Description * - ``content`` - Yes - HTML content to display (max 10000 characters) - * - ``sortOrder`` + * - ``sort_order`` - No - Display order (integer between 0 and 2147483647) - * - ``virtualHost`` + * - ``virtual_host`` - No - Virtual host (max 1000 characters) - * - ``versionNo`` + * - ``version_no`` - Yes - Version number for optimistic locking. Specify the value included in the response of ``setting/{id}``. @@ -287,8 +287,8 @@ Response .. note:: - Audit fields such as ``createdBy``, ``createdTime``, ``updatedBy``, - ``updatedTime`` and ``crudMode`` are ignored even if included in the request + Audit fields such as ``created_by``, ``created_time``, ``updated_by``, + ``updated_time`` and ``crud_mode`` are ignored even if included in the request body, because they are set automatically on the server side. You do not need to specify them when creating or updating. @@ -328,7 +328,7 @@ Product Information Related Content -d '{ "term": "product", "content": "

Our Products

", - "sortOrder": 0 + "sort_order": 0 }' Support Information Related Content @@ -342,7 +342,7 @@ Support Information Related Content -d '{ "term": "support", "content": "

Need help? Contact: support@example.com

", - "sortOrder": 0 + "sort_order": 0 }' Reference diff --git a/en/15.9/api/admin/api-admin-relatedquery.rst b/en/15.9/api/admin/api-admin-relatedquery.rst index d0776d917..adfef9a3a 100644 --- a/en/15.9/api/admin/api-admin-relatedquery.rst +++ b/en/15.9/api/admin/api-admin-relatedquery.rst @@ -90,7 +90,7 @@ Response "id": "query_id_1", "term": "fess", "queries": "fess tutorial\nfess installation\nfess configuration", - "versionNo": 1 + "version_no": 1 } ], "total": 5 @@ -99,9 +99,9 @@ Response .. note:: - Each setting includes ``versionNo`` (a version number for optimistic locking). ``virtualHost`` - and audit fields (``createdBy``, ``createdTime``, ``updatedBy``, ``updatedTime``) are included - only when a value is set. A ``virtualHost`` with an empty value is not included in the response. + Each setting includes ``version_no`` (a version number for optimistic locking). ``virtual_host`` + and audit fields (``created_by``, ``created_time``, ``updated_by``, ``updated_time``) are included + only when a value is set. A ``virtual_host`` with an empty value is not included in the response. Get Related Query ================= @@ -126,8 +126,8 @@ Response "id": "query_id_1", "term": "fess", "queries": "fess tutorial\nfess installation\nfess configuration", - "virtualHost": "site1.example.com", - "versionNo": 1 + "virtual_host": "site1.example.com", + "version_no": 1 } } } @@ -151,7 +151,7 @@ Request Body { "term": "search", "queries": "search tutorial\nsearch syntax\nadvanced search", - "virtualHost": "" + "virtual_host": "" } Field Description @@ -170,13 +170,13 @@ Field Description * - ``queries`` - Yes - Related queries. A newline-separated string with one entry per line (empty lines are ignored. Maximum 10,000 characters) - * - ``virtualHost`` + * - ``virtual_host`` - No - Virtual host (maximum 1,000 characters) .. note:: - ``crudMode`` is set automatically on the API side and does not need to be included in the request body. + ``crud_mode`` is set automatically on the API side and does not need to be included in the request body. Response -------- @@ -212,8 +212,8 @@ Request Body "id": "existing_query_id", "term": "search", "queries": "search tutorial\nsearch syntax\nadvanced search\nsearch tips", - "virtualHost": "", - "versionNo": 1 + "virtual_host": "", + "version_no": 1 } Field Description @@ -235,10 +235,10 @@ Field Description * - ``queries`` - Yes - Related queries. A newline-separated string with one entry per line (empty lines are ignored. Maximum 10,000 characters) - * - ``virtualHost`` + * - ``virtual_host`` - No - Virtual host (maximum 1,000 characters) - * - ``versionNo`` + * - ``version_no`` - Yes - Version number for optimistic locking. Specify the value included in the response when the setting was retrieved. diff --git a/en/15.9/api/admin/api-admin-role.rst b/en/15.9/api/admin/api-admin-role.rst index fed840f18..6cbae35dd 100644 --- a/en/15.9/api/admin/api-admin-role.rst +++ b/en/15.9/api/admin/api-admin-role.rst @@ -87,12 +87,12 @@ Response { "id": "role_id_1", "name": "admin", - "versionNo": 1 + "version_no": 1 }, { "id": "role_id_2", "name": "user", - "versionNo": 1 + "version_no": 1 } ], "total": 5 @@ -120,7 +120,7 @@ Response "setting": { "id": "role_id_1", "name": "admin", - "versionNo": 1 + "version_no": 1 } } } @@ -194,7 +194,7 @@ Request Body { "id": "existing_role_id", "name": "editor_updated", - "versionNo": 1 + "version_no": 1 } Field Description @@ -216,9 +216,9 @@ Field Description * - ``attributes`` - No - Map of attributes. Values are specified as strings - * - ``versionNo`` + * - ``version_no`` - Yes - - Version number for optimistic locking. Specify the ``versionNo`` value obtained from Get Role + - Version number for optimistic locking. Specify the ``version_no`` value obtained from Get Role Response -------- diff --git a/en/15.9/api/admin/api-admin-scheduler.rst b/en/15.9/api/admin/api-admin-scheduler.rst index f2c4696d9..9dba40c2e 100644 --- a/en/15.9/api/admin/api-admin-scheduler.rst +++ b/en/15.9/api/admin/api-admin-scheduler.rst @@ -91,14 +91,14 @@ Response "id": "job_id_1", "name": "Default Crawler", "target": "all", - "cronExpression": "0 0 0 * * ?", - "scriptType": "javascript", - "scriptData": "...", - "jobLogging": "true", + "cron_expression": "0 0 0 * * ?", + "script_type": "javascript", + "script_data": "...", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 0, - "versionNo": 1, + "sort_order": 0, + "version_no": 1, "running": false } ], @@ -112,7 +112,7 @@ Response .. note:: - In responses, ``jobLogging`` / ``crawler`` / ``available`` are returned as strings (``"true"`` / ``"false"``). ``running`` is a boolean, response-only field indicating whether the job is currently running (it cannot be set in requests). ``total`` is the total number of jobs matching the query. + In responses, ``job_logging`` / ``crawler`` / ``available`` are returned as strings (``"true"`` / ``"false"``). ``running`` is a boolean, response-only field indicating whether the job is currently running (it cannot be set in requests). ``total`` is the total number of jobs matching the query. Get Scheduled Job ================= @@ -136,14 +136,14 @@ Response "id": "job_id_1", "name": "Default Crawler", "target": "all", - "cronExpression": "0 0 0 * * ?", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "jobLogging": "true", + "cron_expression": "0 0 0 * * ?", + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 0, - "versionNo": 1, + "sort_order": 0, + "version_no": 1, "running": false } } @@ -168,13 +168,13 @@ Request Body { "name": "Daily Crawler", "target": "all", - "cronExpression": "0 0 2 * * ?", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "jobLogging": "true", + "cron_expression": "0 0 2 * * ?", + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 1 + "sort_order": 1 } Field Description @@ -193,16 +193,16 @@ Field Description * - ``target`` - Yes - Execution target (max 100 characters). Specify ``all`` or a specific target name - * - ``cronExpression`` + * - ``cron_expression`` - No - Cron expression (second minute hour day month day-of-week). Max 100 characters, validated as a cron expression. If empty, the job is not scheduled and can only be started manually - * - ``scriptType`` + * - ``script_type`` - Yes - Script type (max 100 characters). Either ``javascript`` (the default for new jobs, determined by the ``job.default.script`` property) or ``groovy`` (requires the ``fess-script-groovy`` plugin) - * - ``scriptData`` + * - ``script_data`` - No - Execution script. The maximum size follows ``form.admin.max.input.size`` in ``fess_config.properties`` - * - ``jobLogging`` + * - ``job_logging`` - No - Enable job logging (string) * - ``crawler`` @@ -211,17 +211,17 @@ Field Description * - ``available`` - No - Enabled/disabled (string) - * - ``sortOrder`` + * - ``sort_order`` - Yes - Display order (integer between 0 and 2147483647) .. note:: - ``jobLogging`` / ``crawler`` / ``available`` are string fields. In requests, specifying ``"on"`` or ``"true"`` (case-insensitive) enables them; any other value (``"false"``, empty string, or unset) is treated as disabled. In responses they are returned as ``"true"`` / ``"false"``. + ``job_logging`` / ``crawler`` / ``available`` are string fields. In requests, specifying ``"on"`` or ``"true"`` (case-insensitive) enables them; any other value (``"false"``, empty string, or unset) is treated as disabled. In responses they are returned as ``"true"`` / ``"false"``. .. note:: - ``crudMode`` is set automatically on the server side and does not need to be specified in requests. Audit fields such as ``createdBy`` / ``createdTime`` are also set on the server side. + ``crud_mode`` is set automatically on the server side and does not need to be specified in requests. Audit fields such as ``created_by`` / ``created_time`` are also set on the server side. Response -------- @@ -274,19 +274,19 @@ Request Body "id": "existing_job_id", "name": "Updated Crawler", "target": "all", - "cronExpression": "0 0 3 * * ?", - "scriptType": "javascript", - "scriptData": "...", - "jobLogging": "true", + "cron_expression": "0 0 3 * * ?", + "script_type": "javascript", + "script_data": "...", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 1, - "versionNo": 1 + "sort_order": 1, + "version_no": 1 } .. note:: - For updates, ``id`` (max 1000 characters) and ``versionNo`` are required. ``versionNo`` is used for optimistic locking; specify the value returned in the get response. If the value does not match, the update fails. Other required fields (``name`` / ``target`` / ``scriptType`` / ``sortOrder``) are the same as for creation. + For updates, ``id`` (max 1000 characters) and ``version_no`` are required. ``version_no`` is used for optimistic locking; specify the value returned in the get response. If the value does not match, the update fails. Other required fields (``name`` / ``target`` / ``script_type`` / ``sort_order``) are the same as for creation. Response -------- @@ -344,7 +344,7 @@ Response { "response": { "status": 0, - "jobLogId": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6" + "job_log_id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6" } } @@ -357,15 +357,15 @@ Response Fields * - Field - Description - * - ``jobLogId`` - - Job log ID of the started job. Issued when job logging is enabled. If job logging is disabled, it becomes ``null``. + * - ``job_log_id`` + - Job log ID of the started job. Issued when job logging is enabled. If job logging is disabled, it is omitted from the response. Notes ----- - If the job is already running, the start fails and an error is returned (``status`` other than ``0``). - If the job is disabled (``available`` is not enabled), the start likewise fails with an error. -- ``jobLogId`` is issued only when job logging is enabled (``jobLogging`` is enabled). +- ``job_log_id`` is issued only when job logging is enabled (``job_logging`` is enabled). Stop Job ======== @@ -405,13 +405,13 @@ Create and Run a Crawl Job -d '{ "name": "Hourly Crawler", "target": "all", - "cronExpression": "0 0 * * * ?", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "jobLogging": "true", + "cron_expression": "0 0 * * * ?", + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 1 + "sort_order": 1 }' # Run job immediately diff --git a/en/15.9/api/admin/api-admin-suggest.rst b/en/15.9/api/admin/api-admin-suggest.rst index 4709a6a83..9059d31eb 100644 --- a/en/15.9/api/admin/api-admin-suggest.rst +++ b/en/15.9/api/admin/api-admin-suggest.rst @@ -77,9 +77,9 @@ Response "version": "15.9.0", "status": 0, "setting": { - "totalWordsNum": 1500, - "documentWordsNum": 1200, - "queryWordsNum": 450 + "total_words_num": 1500, + "document_words_num": 1200, + "query_words_num": 450 } } } @@ -93,18 +93,18 @@ Response Fields * - Field - Description - * - ``setting.totalWordsNum`` + * - ``setting.total_words_num`` - Total number of suggest words (the number of suggest words registered in the suggest index) - * - ``setting.documentWordsNum`` + * - ``setting.document_words_num`` - Number of document-derived suggest words (the number of suggest words with a document frequency of 1 or more) - * - ``setting.queryWordsNum`` + * - ``setting.query_words_num`` - Number of search-query-derived suggest words (the number of suggest words with a query frequency of 1 or more) .. note:: - ``documentWordsNum`` and ``queryWordsNum`` are not mutually exclusive. If a single suggest word + ``document_words_num`` and ``query_words_num`` are not mutually exclusive. If a single suggest word is derived from both a document and a search query, it is included in both counts. Therefore, - the sum of ``documentWordsNum`` and ``queryWordsNum`` may not equal ``totalWordsNum``. + the sum of ``document_words_num`` and ``query_words_num`` may not equal ``total_words_num``. Delete All Suggest Words ======================== diff --git a/en/15.9/api/admin/api-admin-systeminfo.rst b/en/15.9/api/admin/api-admin-systeminfo.rst index 89c3a4c65..973f8e938 100644 --- a/en/15.9/api/admin/api-admin-systeminfo.rst +++ b/en/15.9/api/admin/api-admin-systeminfo.rst @@ -57,22 +57,22 @@ objects that have ``label`` and ``value``. "response": { "version": "15.9.0", "status": 0, - "envProps": [ + "env_props": [ {"label": "JAVA_HOME", "value": "/usr/lib/jvm/java-21"}, {"label": "FESS_DICTIONARY_PATH", "value": "/var/lib/fess/dict"} ], - "systemProps": [ + "system_props": [ {"label": "java.version", "value": "21.0.1"}, {"label": "java.vendor", "value": "Oracle Corporation"}, {"label": "os.name", "value": "Linux"}, {"label": "user.dir", "value": "/opt/fess"} ], - "fessProps": [ + "fess_props": [ {"label": "crawler.document.max.site.length", "value": "100"}, {"label": "indexer.thread.dump.enabled", "value": "true"}, {"label": "app.cipher.key", "value": "XXXXXXXX"} ], - "bugReportProps": [ + "bug_report_props": [ {"label": "os.name", "value": "Linux"}, {"label": "java.vm.version", "value": "21.0.1+12"} ] @@ -92,24 +92,24 @@ Response Fields - |Fess| product version (e.g. ``15.9.0``). * - ``status`` - Result code indicating the processing outcome. ``0`` means success. - * - ``envProps`` + * - ``env_props`` - List of OS environment variables (array of ``label`` / ``value``). Values are returned verbatim via ``System.getenv()``. - * - ``systemProps`` + * - ``system_props`` - List of Java system properties (array of ``label`` / ``value``). Values are returned verbatim via ``System.getProperties()``. - * - ``fessProps`` + * - ``fess_props`` - List of |Fess| configuration properties (array of ``label`` / ``value``). Includes values from ``fess_config.properties`` and system properties set via the admin UI. Sensitive items are masked (see note below). - * - ``bugReportProps`` + * - ``bug_report_props`` - List of information collected for bug reports (array of ``label`` / ``value``). Includes key OS and Java runtime system properties (``os.name``, ``os.version``, ``java.vm.version``, etc.) and |Fess| system property values. .. note:: - In ``fessProps``, the following sensitive configuration values are masked and returned as ``XXXXXXXX``: + In ``fess_props``, the following sensitive configuration values are masked and returned as ``XXXXXXXX``: ``http.proxy.password``, ``ldap.admin.security.credentials``, ``spnego.preauth.password``, ``app.cipher.key``, ``oic.client.id``, ``oic.client.secret``. .. warning:: - ``envProps`` (environment variables) and ``systemProps`` (Java system properties) are NOT masked — + ``env_props`` (environment variables) and ``system_props`` (Java system properties) are NOT masked — values are returned as-is. If secrets such as credentials are stored in environment variables or system properties, they will appear in the response. diff --git a/en/15.9/api/admin/api-admin-user.rst b/en/15.9/api/admin/api-admin-user.rst index 57a755ac4..0ed49aeee 100644 --- a/en/15.9/api/admin/api-admin-user.rst +++ b/en/15.9/api/admin/api-admin-user.rst @@ -105,7 +105,7 @@ Response }, "roles": ["admin"], "groups": [], - "versionNo": 1 + "version_no": 1 } ], "total": 10 @@ -150,7 +150,7 @@ Response }, "roles": ["admin"], "groups": [], - "versionNo": 1 + "version_no": 1 } } } @@ -179,7 +179,7 @@ Request Body { "name": "testuser", "password": "securepassword", - "confirmPassword": "securepassword", + "confirm_password": "securepassword", "attributes": { "surname": "Test", "givenName": "User", @@ -205,7 +205,7 @@ Field Description * - ``password`` - No - Password - * - ``confirmPassword`` + * - ``confirm_password`` - No - Confirmation password * - ``attributes`` @@ -220,8 +220,8 @@ Field Description .. note:: - The REST API does not perform a password-required check, a match check between ``password`` and ``confirmPassword``, or password policy validation (these are applied only in the admin UI). - In practice, it is recommended to specify a valid ``password`` whose value matches ``confirmPassword``. + The REST API does not perform a password-required check, a match check between ``password`` and ``confirm_password``, or password policy validation (these are applied only in the admin UI). + In practice, it is recommended to specify a valid ``password`` whose value matches ``confirm_password``. The keys of ``attributes`` are the user entity attribute names (the schema item names derived from LDAP). The most common keys are: @@ -276,7 +276,7 @@ Request Body "id": "existing_user_id", "name": "testuser", "password": "newpassword", - "confirmPassword": "newpassword", + "confirm_password": "newpassword", "attributes": { "surname": "Test", "givenName": "User Updated", @@ -284,7 +284,7 @@ Request Body }, "roles": ["user", "editor"], "groups": ["group_id_1", "group_id_2"], - "versionNo": 1 + "version_no": 1 } Field Description @@ -303,13 +303,13 @@ Field Description * - ``name`` - Yes - Username (login ID) - * - ``versionNo`` + * - ``version_no`` - Yes - Version number (for optimistic locking) * - ``password`` - No - New password (updated only when specified) - * - ``confirmPassword`` + * - ``confirm_password`` - No - Confirmation password * - ``attributes`` @@ -324,8 +324,8 @@ Field Description .. note:: - On update, ``id``, ``name``, and ``versionNo`` are required. - ``versionNo`` is the value returned when getting the target user (GET), and it corresponds to the OpenSearch document version. + On update, ``id``, ``name``, and ``version_no`` are required. + ``version_no`` is the value returned when getting the target user (GET), and it corresponds to the OpenSearch document version. If it does not match the current version, the request is treated as a conflict and the update is rejected. Response @@ -390,7 +390,7 @@ Create New User -d '{ "name": "john.doe", "password": "SecureP@ss123", - "confirmPassword": "SecureP@ss123", + "confirm_password": "SecureP@ss123", "attributes": { "surname": "Doe", "givenName": "John", @@ -412,7 +412,7 @@ Change User Roles "id": "user_id_123", "name": "john.doe", "roles": ["user", "editor", "admin"], - "versionNo": 1 + "version_no": 1 }' Reference diff --git a/en/15.9/api/admin/api-admin-webconfig.rst b/en/15.9/api/admin/api-admin-webconfig.rst index 921470821..42fbc22c2 100644 --- a/en/15.9/api/admin/api-admin-webconfig.rst +++ b/en/15.9/api/admin/api-admin-webconfig.rst @@ -106,21 +106,21 @@ Response "name": "Example Site", "description": "Sample site", "urls": "https://example.com/", - "includedUrls": ".*example\\.com.*", - "excludedUrls": ".*\\.(pdf|zip)$", - "includedDocUrls": "", - "excludedDocUrls": "", - "configParameter": "", + "included_urls": ".*example\\.com.*", + "excluded_urls": ".*\\.(pdf|zip)$", + "included_doc_urls": "", + "excluded_doc_urls": "", + "config_parameter": "", "depth": 3, - "maxAccessCount": 1000, - "userAgent": "Mozilla/5.0", - "numOfThread": 1, - "intervalTime": 1000, + "max_access_count": 1000, + "user_agent": "Mozilla/5.0", + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, "available": "true", "permissions": "{role}admin", - "virtualHosts": "", - "sortOrder": 0 + "virtual_hosts": "", + "sort_order": 0 } ], "total": 5 @@ -152,35 +152,35 @@ Response "name": "Example Site", "description": "Sample site", "urls": "https://example.com/", - "includedUrls": ".*example\\.com.*", - "excludedUrls": ".*\\.(pdf|zip)$", - "includedDocUrls": "", - "excludedDocUrls": "", - "configParameter": "", + "included_urls": ".*example\\.com.*", + "excluded_urls": ".*\\.(pdf|zip)$", + "included_doc_urls": "", + "excluded_doc_urls": "", + "config_parameter": "", "depth": 3, - "maxAccessCount": 1000, - "userAgent": "Mozilla/5.0", - "numOfThread": 1, - "intervalTime": 1000, + "max_access_count": 1000, + "user_agent": "Mozilla/5.0", + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin", - "virtualHosts": "", - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_hosts": "", + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } .. note:: - The response includes ``createdBy``, ``createdTime``, ``updatedBy``, ``updatedTime``, and ``versionNo``, + The response includes ``created_by``, ``created_time``, ``updated_by``, ``updated_time``, and ``version_no``, which are automatically populated by the server when a configuration is created or updated. - ``versionNo`` is required when updating a configuration (see "Update Web Crawl Configuration" below). + ``version_no`` is required when updating a configuration (see "Update Web Crawl Configuration" below). Create Web Crawl Configuration =============================== @@ -201,14 +201,14 @@ Request Body { "name": "Corporate Site", "urls": "https://www.example.com/", - "includedUrls": ".*www\\.example\\.com.*", - "excludedUrls": ".*\\.(pdf|zip|exe)$", - "userAgent": "Mozilla/5.0", - "numOfThread": 3, - "intervalTime": 500, + "included_urls": ".*www\\.example\\.com.*", + "excluded_urls": ".*\\.(pdf|zip|exe)$", + "user_agent": "Mozilla/5.0", + "num_of_thread": 3, + "interval_time": 500, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin\n{role}user" } @@ -231,34 +231,34 @@ Field Description * - ``urls`` - Yes - Crawl start URLs (newline-separated for multiple URLs). Specify using ``http:`` or ``https:`` - * - ``includedUrls`` + * - ``included_urls`` - No - Regex pattern for URLs to include in crawling - * - ``excludedUrls`` + * - ``excluded_urls`` - No - Regex pattern for URLs to exclude from crawling - * - ``includedDocUrls`` + * - ``included_doc_urls`` - No - Regex pattern for URLs to include in indexing - * - ``excludedDocUrls`` + * - ``excluded_doc_urls`` - No - Regex pattern for URLs to exclude from indexing - * - ``configParameter`` + * - ``config_parameter`` - No - Additional configuration parameters (``key=value`` format, one entry per line) * - ``depth`` - No - Crawl depth (0 or greater) - * - ``maxAccessCount`` + * - ``max_access_count`` - No - Maximum access count (0 or greater) - * - ``userAgent`` + * - ``user_agent`` - Yes - User-Agent string (up to 200 characters) - * - ``numOfThread`` + * - ``num_of_thread`` - Yes - Number of parallel threads (1 or greater) - * - ``intervalTime`` + * - ``interval_time`` - Yes - Access interval in milliseconds (0 or greater) * - ``boost`` @@ -267,19 +267,19 @@ Field Description * - ``available`` - Yes - Enable/disable (string ``"true"`` / ``"false"``) - * - ``sortOrder`` + * - ``sort_order`` - Yes - Display order (0 or greater) * - ``permissions`` - No - Access permission roles (newline-separated for multiple values) - * - ``virtualHosts`` + * - ``virtual_hosts`` - No - Virtual hosts (newline-separated for multiple values) .. note:: - Audit fields such as ``createdBy``, ``createdTime``, ``updatedBy``, and ``updatedTime`` are + Audit fields such as ``created_by``, ``created_time``, ``updated_by``, and ``updated_time`` are automatically set by the server and do not need to be included in the request body. Response @@ -309,8 +309,8 @@ Request Request Body ~~~~~~~~~~~~ -When updating, ``id`` to identify the target configuration and ``versionNo`` are required in addition to the fields used at creation time. -Specify the current value of ``versionNo`` as returned in the GET response. +When updating, ``id`` to identify the target configuration and ``version_no`` are required in addition to the fields used at creation time. +Specify the current value of ``version_no`` as returned in the GET response. .. code-block:: json @@ -318,17 +318,17 @@ Specify the current value of ``versionNo`` as returned in the GET response. "id": "existing_webconfig_id", "name": "Updated Corporate Site", "urls": "https://www.example.com/", - "includedUrls": ".*www\\.example\\.com.*", - "excludedUrls": ".*\\.(pdf|zip|exe|dmg)$", - "userAgent": "Mozilla/5.0", + "included_urls": ".*www\\.example\\.com.*", + "excluded_urls": ".*\\.(pdf|zip|exe|dmg)$", + "user_agent": "Mozilla/5.0", "depth": 10, - "maxAccessCount": 10000, - "numOfThread": 5, - "intervalTime": 300, + "max_access_count": 10000, + "num_of_thread": 5, + "interval_time": 300, "boost": 1.2, "available": "true", - "sortOrder": 0, - "versionNo": 1 + "sort_order": 0, + "version_no": 1 } Additional Fields for Update @@ -344,9 +344,9 @@ Additional Fields for Update * - ``id`` - Yes - ID of the configuration to update (up to 1000 characters) - * - ``versionNo`` + * - ``version_no`` - Yes - - Current version number of the configuration to update. Use the ``versionNo`` value from the GET response. + - Current version number of the configuration to update. Use the ``version_no`` value from the GET response. Response -------- @@ -385,7 +385,7 @@ Response URL Pattern Examples ==================== -``includedUrls`` / ``excludedUrls`` / ``includedDocUrls`` / ``excludedDocUrls`` accept regular expressions. +``included_urls`` / ``excluded_urls`` / ``included_doc_urls`` / ``excluded_doc_urls`` accept regular expressions. .. list-table:: :header-rows: 1 @@ -418,16 +418,16 @@ Corporate Site Crawl Configuration -d '{ "name": "Corporate Website", "urls": "https://www.example.com/", - "includedUrls": ".*www\\.example\\.com.*", - "excludedUrls": ".*/(login|admin|api)/.*", - "userAgent": "Mozilla/5.0", + "included_urls": ".*www\\.example\\.com.*", + "excluded_urls": ".*/(login|admin|api)/.*", + "user_agent": "Mozilla/5.0", "depth": 5, - "maxAccessCount": 10000, - "numOfThread": 3, - "intervalTime": 500, + "max_access_count": 10000, + "num_of_thread": 3, + "interval_time": 500, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}guest" }' @@ -442,15 +442,15 @@ Documentation Site Crawl Configuration -d '{ "name": "Documentation Site", "urls": "https://docs.example.com/", - "includedUrls": ".*docs\\.example\\.com.*", - "includedDocUrls": ".*\\.(html|htm)$", - "userAgent": "Mozilla/5.0", - "maxAccessCount": 50000, - "numOfThread": 5, - "intervalTime": 200, + "included_urls": ".*docs\\.example\\.com.*", + "included_doc_urls": ".*\\.(html|htm)$", + "user_agent": "Mozilla/5.0", + "max_access_count": 50000, + "num_of_thread": 5, + "interval_time": 200, "boost": 1.5, "available": "true", - "sortOrder": 0 + "sort_order": 0 }' Reference diff --git a/es/15.9/api/admin/api-admin-accesstoken.rst b/es/15.9/api/admin/api-admin-accesstoken.rst index 621141b46..39c6c60df 100644 --- a/es/15.9/api/admin/api-admin-accesstoken.rst +++ b/es/15.9/api/admin/api-admin-accesstoken.rst @@ -101,14 +101,14 @@ Respuesta "id": "token_id_1", "name": "API Token 1", "token": "abcd1234efgh5678", - "parameterName": "permission", + "parameter_name": "permission", "permissions": "{role}admin-api", "expires": "2026-01-01T00:00:00", - "createdBy": "admin", - "createdTime": 1735689600000, - "updatedBy": "admin", - "updatedTime": 1735689600000, - "versionNo": 1 + "created_by": "admin", + "created_time": 1735689600000, + "updated_by": "admin", + "updated_time": 1735689600000, + "version_no": 1 } ], "total": 5 @@ -118,8 +118,8 @@ Respuesta .. note:: Cada objeto de token incluye también información de auditoría y versión: - ``createdBy``, ``createdTime``, ``updatedBy``, ``updatedTime`` y ``versionNo``. - ``createdTime`` y ``updatedTime`` se expresan en milisegundos desde la época (valor numérico). + ``created_by``, ``created_time``, ``updated_by``, ``updated_time`` y ``version_no``. + ``created_time`` y ``updated_time`` se expresan en milisegundos desde la época (valor numérico). Los campos con valor ``null`` se excluyen de la respuesta. ``permissions`` se devuelve como una cadena separada por saltos de línea (``\n``). @@ -145,14 +145,14 @@ Respuesta "id": "token_id_1", "name": "API Token 1", "token": "abcd1234efgh5678", - "parameterName": "permission", + "parameter_name": "permission", "permissions": "{role}admin-api", "expires": "2026-01-01T00:00:00", - "createdBy": "admin", - "createdTime": 1735689600000, - "updatedBy": "admin", - "updatedTime": 1735689600000, - "versionNo": 1 + "created_by": "admin", + "created_time": 1735689600000, + "updated_by": "admin", + "updated_time": 1735689600000, + "version_no": 1 } } } @@ -195,7 +195,7 @@ Descripción de Campos * - ``permissions`` - No - Permisos otorgados a este token. Se pueden especificar múltiples valores separados por saltos de línea (``\n``) (ejemplo: ``{role}admin-api``). Los tokens que invocan la Admin API deben tener un permiso que coincida con ``api.admin.access.permissions`` (valor predeterminado: ``{role}admin-api``). - * - ``parameterName`` + * - ``parameter_name`` - No - Nombre del parámetro de solicitud para pasar permisos adicionales. Si una solicitud autenticada con este token incluye un parámetro con el nombre aquí especificado, su valor se agrega a ``permissions``. Si se omite, no se configura. * - ``expires`` @@ -243,7 +243,7 @@ Cuerpo de la Solicitud "name": "Updated API Token", "permissions": "{role}admin-api\n{role}user", "expires": "2026-01-01T00:00:00", - "versionNo": 1 + "version_no": 1 } Descripción de Campos @@ -261,9 +261,9 @@ En la actualización se utilizan los mismos campos que en la creación, más los * - ``id`` - Sí - ID del token a actualizar - * - ``versionNo`` + * - ``version_no`` - Sí - - Número de versión para el bloqueo optimista. Especifique el ``versionNo`` del token obtenido previamente. + - Número de versión para el bloqueo optimista. Especifique el ``version_no`` del token obtenido previamente. .. note:: diff --git a/es/15.9/api/admin/api-admin-badword.rst b/es/15.9/api/admin/api-admin-badword.rst index c61f99c1a..930a84f75 100644 --- a/es/15.9/api/admin/api-admin-badword.rst +++ b/es/15.9/api/admin/api-admin-badword.rst @@ -92,7 +92,7 @@ Respuesta "settings": [ { "id": "badword_id_1", - "suggestWord": "inappropriate_word" + "suggest_word": "inappropriate_word" } ], "total": 5 @@ -119,7 +119,7 @@ Respuesta "status": 0, "setting": { "id": "badword_id_1", - "suggestWord": "inappropriate_word" + "suggest_word": "inappropriate_word" } } } @@ -141,7 +141,7 @@ Cuerpo de la Solicitud .. code-block:: json { - "suggestWord": "spam_keyword" + "suggest_word": "spam_keyword" } Descripción de Campos @@ -154,7 +154,7 @@ Descripción de Campos * - Campo - Requerido - Descripción - * - ``suggestWord`` + * - ``suggest_word`` - Sí - Palabra clave a excluir (no puede contener espacios en blanco) @@ -189,8 +189,8 @@ Cuerpo de la Solicitud { "id": "existing_badword_id", - "suggestWord": "updated_spam_keyword", - "versionNo": 1 + "suggest_word": "updated_spam_keyword", + "version_no": 1 } Respuesta @@ -260,7 +260,7 @@ Formato CSV ~~~~~~~~~~~ - La primera línea se omite como fila de encabezado (el nombre de la columna es arbitrario; al descargar se escribe ``BadWord``). -- A partir de la segunda línea, escriba una palabra prohibida por línea como ``suggestWord``. +- A partir de la segunda línea, escriba una palabra prohibida por línea como ``suggest_word``. - Las líneas cuyo valor está en blanco se ignoran. - Anteponga ``--`` a una palabra para eliminarla (por ejemplo, ``--spam`` elimina ``spam``). - Especificar una palabra ya registrada se trata como una actualización (se restablecen el usuario y la fecha de actualización). @@ -306,7 +306,7 @@ Excluir Palabra Clave de Spam -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "suggestWord": "spam" + "suggest_word": "spam" }' Subir Archivo CSV diff --git a/es/15.9/api/admin/api-admin-boostdoc.rst b/es/15.9/api/admin/api-admin-boostdoc.rst index 1a0a5e09b..5097aae7c 100644 --- a/es/15.9/api/admin/api-admin-boostdoc.rst +++ b/es/15.9/api/admin/api-admin-boostdoc.rst @@ -11,21 +11,21 @@ coincidan con ciertas condiciones y hacer que aparezcan con mayor facilidad en l superiores de los resultados de búsqueda. El impulso se aplica a cada documento en el momento de la indexación (durante el rastreo). -La condición (``urlExpr``) y el valor de impulso (``boostExpr``) se evalúan con el motor de scripting -especificado en el campo ``scriptType``. En ``scriptType`` puede indicarse ``javascript`` o ``groovy`` +La condición (``url_expr``) y el valor de impulso (``boost_expr``) se evalúan con el motor de scripting +especificado en el campo ``script_type``. En ``script_type`` puede indicarse ``javascript`` o ``groovy`` (este último requiere el plugin ``fess-script-groovy``). La pantalla de creación del panel de administración -rellena ``scriptType`` con ``javascript``, pero si esta API omite ``scriptType`` en el cuerpo de la solicitud, +rellena ``script_type`` con ``javascript``, pero si esta API omite ``script_type`` en el cuerpo de la solicitud, no se rellena automáticamente y las expresiones se evalúan como Groovy. -Las reglas múltiples se evalúan en orden ascendente según ``sortOrder``, y solo se aplica el valor de +Las reglas múltiples se evalúan en orden ascendente según ``sort_order``, y solo se aplica el valor de impulso de la primera regla cuya condición coincida (una vez encontrada una regla que coincida, las reglas siguientes no se evalúan). .. note:: - En el panel de administración, ``urlExpr`` se muestra como "Condición", ``boostExpr`` como "Expresión de valor - de impulso" y ``scriptType`` como "Tipo de Script". ``scriptType`` solo aparece en los cuerpos de solicitud y + En el panel de administración, ``url_expr`` se muestra como "Condición", ``boost_expr`` como "Expresión de valor + de impulso" y ``script_type`` como "Tipo de Script". ``script_type`` solo aparece en los cuerpos de solicitud y respuestas de creación/actualización/obtención (lista y detalle), no en los parámetros de filtro de la lista - (``urlExpr``, ``boostExpr``). + (``url_expr``, ``boost_expr``). Para más detalles sobre los elementos de configuración, consulte :doc:`../../admin/boostdoc-guide`. URL Base @@ -96,11 +96,11 @@ Parámetros - Integer - No - Número de página (comienza en 1. Predeterminado: 1) - * - ``urlExpr`` + * - ``url_expr`` - String - No - Filtrado por expresión de condición (coincidencia parcial) - * - ``boostExpr`` + * - ``boost_expr`` - String - No - Filtrado por expresión de valor de impulso (coincidencia parcial) @@ -116,11 +116,11 @@ Respuesta "settings": [ { "id": "boostdoc_id_1", - "urlExpr": "url.startsWith(\"https://docs.example.com/\")", - "boostExpr": "3.0", - "scriptType": "javascript", - "sortOrder": 1, - "versionNo": 1 + "url_expr": "url.startsWith(\"https://docs.example.com/\")", + "boost_expr": "3.0", + "script_type": "javascript", + "sort_order": 1, + "version_no": 1 } ], "total": 5 @@ -129,8 +129,8 @@ Respuesta .. note:: - Además de los campos mostrados anteriormente, cada objeto de configuración en la respuesta incluye también metadatos de creación/actualización (``createdBy``, ``createdTime``, ``updatedBy``, ``updatedTime``). - ``versionNo`` es obligatorio al actualizar (PUT), por lo que debe obtener su valor actual mediante la API de obtención individual o de lista antes de actualizar. + Además de los campos mostrados anteriormente, cada objeto de configuración en la respuesta incluye también metadatos de creación/actualización (``created_by``, ``created_time``, ``updated_by``, ``updated_time``). + ``version_no`` es obligatorio al actualizar (PUT), por lo que debe obtener su valor actual mediante la API de obtención individual o de lista antes de actualizar. Obtener Impulso de Documento ============================= @@ -152,11 +152,11 @@ Respuesta "status": 0, "setting": { "id": "boostdoc_id_1", - "urlExpr": "url.startsWith(\"https://docs.example.com/\")", - "boostExpr": "3.0", - "scriptType": "javascript", - "sortOrder": 1, - "versionNo": 1 + "url_expr": "url.startsWith(\"https://docs.example.com/\")", + "boost_expr": "3.0", + "script_type": "javascript", + "sort_order": 1, + "version_no": 1 } } } @@ -178,10 +178,10 @@ Cuerpo de la Solicitud .. code-block:: json { - "urlExpr": "url.startsWith(\"https://important.example.com/\")", - "boostExpr": "5.0", - "scriptType": "javascript", - "sortOrder": 0 + "url_expr": "url.startsWith(\"https://important.example.com/\")", + "boost_expr": "5.0", + "script_type": "javascript", + "sort_order": 0 } Descripción de Campos @@ -194,16 +194,16 @@ Descripción de Campos * - Campo - Requerido - Descripción - * - ``urlExpr`` + * - ``url_expr`` - Sí - Expresión de condición. Expresión de script que determina los documentos objetivo del impulso y devuelve ``Boolean``. Corresponde a "Condición" en el panel de administración (máximo 10000 caracteres). - * - ``boostExpr`` + * - ``boost_expr`` - Sí - Expresión de valor de impulso. Expresión de script que devuelve el valor de impulso (numérico). También se puede especificar un valor fijo como ``3.0``. Corresponde a "Expresión de valor de impulso" en el panel de administración (máximo 10000 caracteres). - * - ``scriptType`` + * - ``script_type`` - No - - Motor de scripting utilizado para evaluar ``urlExpr`` y ``boostExpr``. Puede ser ``javascript`` o ``groovy`` (requiere el plugin ``fess-script-groovy``). Corresponde a "Tipo de Script" en el panel de administración (máximo 100 caracteres). Si se omite, las expresiones se evalúan como Groovy. - * - ``sortOrder`` + - Motor de scripting utilizado para evaluar ``url_expr`` y ``boost_expr``. Puede ser ``javascript`` o ``groovy`` (requiere el plugin ``fess-script-groovy``). Corresponde a "Tipo de Script" en el panel de administración (máximo 100 caracteres). Si se omite, las expresiones se evalúan como Groovy. + * - ``sort_order`` - Sí - Orden de aplicación. Las reglas se evalúan en orden ascendente y se aplica el valor de impulso de la primera regla cuya condición coincida (valor inicial del formulario: 0; entero mayor o igual a 0). @@ -238,14 +238,14 @@ Cuerpo de la Solicitud { "id": "existing_boostdoc_id", - "urlExpr": "url.startsWith(\"https://important.example.com/\")", - "boostExpr": "10.0", - "scriptType": "javascript", - "sortOrder": 0, - "versionNo": 1 + "url_expr": "url.startsWith(\"https://important.example.com/\")", + "boost_expr": "10.0", + "script_type": "javascript", + "sort_order": 0, + "version_no": 1 } -Al actualizar, además de los campos utilizados al crear, ``id`` (el identificador de la regla objetivo, hasta 1000 caracteres) y ``versionNo`` (el número de versión para bloqueo optimista) son obligatorios. Especifique el número de versión actual obtenido desde la respuesta de la API de obtención individual o de lista para ``versionNo``. La actualización falla si el número de versión no coincide. +Al actualizar, además de los campos utilizados al crear, ``id`` (el identificador de la regla objetivo, hasta 1000 caracteres) y ``version_no`` (el número de versión para bloqueo optimista) son obligatorios. Especifique el número de versión actual obtenido desde la respuesta de la API de obtención individual o de lista para ``version_no``. La actualización falla si el número de versión no coincide. Respuesta --------- @@ -284,13 +284,13 @@ Respuesta Acerca de las Expresiones de Condición y de Valor de Impulso ============================================================= -``urlExpr`` (condición) y ``boostExpr`` (expresión de valor de impulso) se evalúan con el motor de scripting -especificado en ``scriptType`` (valor predeterminado: Groovy; solo la pantalla de creación del panel de +``url_expr`` (condición) y ``boost_expr`` (expresión de valor de impulso) se evalúan con el motor de scripting +especificado en ``script_type`` (valor predeterminado: Groovy; solo la pantalla de creación del panel de administración rellena ``javascript``). Dentro de la expresión, se pueden referenciar los valores de campo del documento a indexar como variables con el nombre del campo. -- ``urlExpr`` debe devolver ``Boolean`` (ejemplo: ``url.startsWith("https://docs.example.com/")``). Una simple cadena de expresión regular (ejemplo: ``.*docs\.example\.com.*``) no devuelve ``Boolean`` como expresión de script y por lo tanto no funciona como condición. Para usar expresiones regulares, utilice ``String#matches`` (disponible con la misma notación tanto en Groovy como en JavaScript). -- ``boostExpr`` debe devolver un valor numérico. El resultado se convierte a ``float`` y el impulso se aplica solo si es mayor que 0. +- ``url_expr`` debe devolver ``Boolean`` (ejemplo: ``url.startsWith("https://docs.example.com/")``). Una simple cadena de expresión regular (ejemplo: ``.*docs\.example\.com.*``) no devuelve ``Boolean`` como expresión de script y por lo tanto no funciona como condición. Para usar expresiones regulares, utilice ``String#matches`` (disponible con la misma notación tanto en Groovy como en JavaScript). +- ``boost_expr`` debe devolver un valor numérico. El resultado se convierte a ``float`` y el impulso se aplica solo si es mayor que 0. .. note:: @@ -299,7 +299,7 @@ Dentro de la expresión, se pueden referenciar los valores de campo del document ``indexer.favorite.count.enabled`` están habilitados (ambos habilitados por defecto). La sintaxis de cálculo de fechas de OpenSearch como ``now - 7d`` no se puede usar ni en Groovy ni en JavaScript. -Ejemplos de Expresión de Condición (``urlExpr``) +Ejemplos de Expresión de Condición (``url_expr``) ------------------------------------------------- .. list-table:: @@ -315,7 +315,7 @@ Ejemplos de Expresión de Condición (``urlExpr``) * - ``title.contains("Notas de la version")`` - Aplica a documentos que contienen una palabra específica en el título -Ejemplos de Expresión de Valor de Impulso (``boostExpr``) +Ejemplos de Expresión de Valor de Impulso (``boost_expr``) ---------------------------------------------------------- .. list-table:: @@ -343,9 +343,9 @@ Impulso de Sitio de Documentación -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "urlExpr": "url.startsWith(\"https://docs.example.com/\")", - "boostExpr": "5.0", - "sortOrder": 0 + "url_expr": "url.startsWith(\"https://docs.example.com/\")", + "boost_expr": "5.0", + "sort_order": 0 }' Impulso de Contenido con Muchos Clics @@ -357,9 +357,9 @@ Impulso de Contenido con Muchos Clics -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "urlExpr": "url.startsWith(\"https://www.example.com/\")", - "boostExpr": "click_count * 0.1 + 1", - "sortOrder": 10 + "url_expr": "url.startsWith(\"https://www.example.com/\")", + "boost_expr": "click_count * 0.1 + 1", + "sort_order": 10 }' Información de Referencia diff --git a/es/15.9/api/admin/api-admin-crawlinginfo.rst b/es/15.9/api/admin/api-admin-crawlinginfo.rst index 5e0d28157..d90e8c63e 100644 --- a/es/15.9/api/admin/api-admin-crawlinginfo.rst +++ b/es/15.9/api/admin/api-admin-crawlinginfo.rst @@ -67,7 +67,7 @@ Parámetros - Integer - No - Número de página (basado en 1, predeterminado: 1) - * - ``sessionId`` + * - ``session_id`` - String - No - Filtro por ID de sesión (coincidencia parcial) @@ -83,17 +83,17 @@ Respuesta "logs": [ { "id": "crawling_info_id_1", - "sessionId": "20250129100000", + "session_id": "20250129100000", "name": "Default Crawler", - "expiredTime": "1738200000000", - "createdTime": 1738108800000 + "expired_time": "1738200000000", + "created_time": 1738108800000 }, { "id": "crawling_info_id_2", - "sessionId": "20250128100000", + "session_id": "20250128100000", "name": "Default Crawler", - "expiredTime": "1738113600000", - "createdTime": 1738022400000 + "expired_time": "1738113600000", + "created_time": 1738022400000 } ], "total": 10 @@ -111,18 +111,18 @@ Campos de Respuesta - Descripción * - ``id`` - ID de información de rastreo - * - ``sessionId`` + * - ``session_id`` - ID de sesión * - ``name`` - Nombre de sesión - * - ``expiredTime`` + * - ``expired_time`` - Fecha de expiración (milisegundos epoch; devuelto como cadena de texto) - * - ``createdTime`` + * - ``created_time`` - Hora de creación (milisegundos epoch; devuelto como número) .. note:: - Cada objeto de registro en la respuesta incluye también un campo interno ``crudMode`` + Cada objeto de registro en la respuesta incluye también un campo interno ``crud_mode`` (un entero que indica el modo de operación CRUD, siempre ``0`` para operaciones de lectura). Los clientes pueden ignorarlo sin problema. @@ -146,10 +146,10 @@ Respuesta "status": 0, "log": { "id": "crawling_info_id_1", - "sessionId": "20250129100000", + "session_id": "20250129100000", "name": "Default Crawler", - "expiredTime": "1738200000000", - "createdTime": 1738108800000 + "expired_time": "1738200000000", + "created_time": 1738108800000 } } } diff --git a/es/15.9/api/admin/api-admin-dataconfig.rst b/es/15.9/api/admin/api-admin-dataconfig.rst index 4d69330f0..afaac7b88 100644 --- a/es/15.9/api/admin/api-admin-dataconfig.rst +++ b/es/15.9/api/admin/api-admin-dataconfig.rst @@ -74,7 +74,7 @@ Parámetros - String - No - Filtrar por nombre de configuración - * - ``handlerName`` + * - ``handler_name`` - String - No - Filtrar por nombre de manejador @@ -96,14 +96,14 @@ Respuesta "id": "dataconfig_id_1", "name": "Database Crawler", "description": "Rastreador de base de datos", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/mydb", - "handlerScript": "...", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/mydb", + "handler_script": "...", "boost": 1.0, "available": "true", "permissions": "{role}admin", - "virtualHosts": "", - "sortOrder": 0 + "virtual_hosts": "", + "sort_order": 0 } ], "total": 5 @@ -132,14 +132,14 @@ Respuesta "id": "dataconfig_id_1", "name": "Database Crawler", "description": "Rastreador de base de datos", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/mydb\nusername=dbuser\npassword=dbpass", - "handlerScript": "...", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/mydb\nusername=dbuser\npassword=dbpass", + "handler_script": "...", "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin", - "virtualHosts": "" + "virtual_hosts": "" } } } @@ -162,12 +162,12 @@ Cuerpo de la Solicitud { "name": "Product Database", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/products\nusername=user\npassword=pass", - "handlerScript": "url=\"https://example.com/product/\" + product_id\ntitle=product_name\ncontent=description", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/products\nusername=user\npassword=pass", + "handler_script": "url=\"https://example.com/product/\" + product_id\ntitle=product_name\ncontent=description", "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin\n{role}user" } @@ -187,13 +187,13 @@ Descripción de Campos * - ``description`` - No - Descripción de la configuración - * - ``handlerName`` + * - ``handler_name`` - Sí - Nombre del manejador de almacén de datos - * - ``handlerParameter`` + * - ``handler_parameter`` - No - Parámetros del manejador (información de conexión, etc.) - * - ``handlerScript`` + * - ``handler_script`` - No - Script de transformación de datos * - ``boost`` @@ -202,13 +202,13 @@ Descripción de Campos * - ``available`` - Sí - Habilitado/Deshabilitado (cadena ``"true"`` / ``"false"``) - * - ``sortOrder`` + * - ``sort_order`` - Sí - Orden de visualización * - ``permissions`` - No - Roles con permiso de acceso (separados por saltos de línea si son varios) - * - ``virtualHosts`` + * - ``virtual_hosts`` - No - Hosts virtuales (separados por saltos de línea si son varios) @@ -244,16 +244,16 @@ Cuerpo de la Solicitud { "id": "existing_dataconfig_id", "name": "Updated Product Database", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/products\nusername=user\npassword=newpass", - "handlerScript": "url=\"https://example.com/product/\" + product_id\ntitle=product_name\ncontent=description + \" \" + features", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/products\nusername=user\npassword=newpass", + "handler_script": "url=\"https://example.com/product/\" + product_id\ntitle=product_name\ncontent=description + \" \" + features", "boost": 1.5, "available": "true", - "sortOrder": 0, - "versionNo": 1 + "sort_order": 0, + "version_no": 1 } -Las solicitudes de actualización requieren los mismos campos obligatorios que la creación (``name``, ``handlerName``, ``boost``, ``available``, ``sortOrder``), además de los siguientes campos: +Las solicitudes de actualización requieren los mismos campos obligatorios que la creación (``name``, ``handler_name``, ``boost``, ``available``, ``sort_order``), además de los siguientes campos: .. list-table:: :header-rows: 1 @@ -265,7 +265,7 @@ Las solicitudes de actualización requieren los mismos campos obligatorios que l * - ``id`` - Sí - ID de la configuración a actualizar - * - ``versionNo`` + * - ``version_no`` - Sí - Número de versión para el bloqueo optimista (especifique el valor obtenido al recuperar la configuración) @@ -341,12 +341,12 @@ Configuración de Rastreo de Base de Datos -H "Content-Type: application/json" \ -d '{ "name": "User Database", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/userdb\nusername=dbuser\npassword=dbpass\nsql=SELECT * FROM users WHERE active=true", - "handlerScript": "url=\"https://example.com/user/\" + user_id\ntitle=username\ncontent=profile", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/userdb\nusername=dbuser\npassword=dbpass\nsql=SELECT * FROM users WHERE active=true", + "handler_script": "url=\"https://example.com/user/\" + user_id\ntitle=username\ncontent=profile", "boost": 1.0, "available": "true", - "sortOrder": 0 + "sort_order": 0 }' Información de Referencia diff --git a/es/15.9/api/admin/api-admin-dict.rst b/es/15.9/api/admin/api-admin-dict.rst index 5548dd0e9..ca292ade3 100644 --- a/es/15.9/api/admin/api-admin-dict.rst +++ b/es/15.9/api/admin/api-admin-dict.rst @@ -178,7 +178,7 @@ Los campos de cada elemento del arreglo ``settings`` de la respuesta varían seg "settings": [ { "id": 1, - "dictId": "ZjA5...synonym.txt", + "dict_id": "ZjA5...synonym.txt", "inputs": "busqueda,buscar", "outputs": "busqueda,buscar,investigar" } @@ -232,7 +232,7 @@ Respuesta "status": 0, "setting": { "id": 1, - "dictId": "ZjA5...synonym.txt", + "dict_id": "ZjA5...synonym.txt", "inputs": "busqueda,buscar", "outputs": "busqueda,buscar,investigar" } @@ -405,7 +405,7 @@ Campos de Elementos por Tipo de Diccionario =========================================== Los campos del cuerpo de la solicitud de creación y actualización de elementos del diccionario, así como los de la respuesta, varían según el tipo de diccionario. -``id`` (ID del elemento) y ``dictId`` (ID del diccionario) se incluyen en común en la respuesta. +``id`` (ID del elemento) y ``dict_id`` (ID del diccionario) se incluyen en común en la respuesta. .. list-table:: :header-rows: 1 diff --git a/es/15.9/api/admin/api-admin-elevateword.rst b/es/15.9/api/admin/api-admin-elevateword.rst index f4dc86370..de340ea6a 100644 --- a/es/15.9/api/admin/api-admin-elevateword.rst +++ b/es/15.9/api/admin/api-admin-elevateword.rst @@ -92,11 +92,11 @@ Respuesta "settings": [ { "id": "elevate_id_1", - "suggestWord": "fess", + "suggest_word": "fess", "reading": "", "permissions": "{role}guest", "boost": 100.0, - "labelTypeIds": [] + "label_type_ids": [] } ], "total": 5 @@ -123,11 +123,11 @@ Respuesta "status": 0, "setting": { "id": "elevate_id_1", - "suggestWord": "fess", + "suggest_word": "fess", "reading": "", "permissions": "{role}guest", "boost": 100.0, - "labelTypeIds": [] + "label_type_ids": [] } } } @@ -149,11 +149,11 @@ Cuerpo de la Solicitud .. code-block:: json { - "suggestWord": "documentation", + "suggest_word": "documentation", "reading": "", "permissions": "{role}guest", "boost": 100.0, - "labelTypeIds": ["label1"] + "label_type_ids": ["label1"] } Descripción de Campos @@ -166,7 +166,7 @@ Descripción de Campos * - Campo - Requerido - Descripción - * - ``suggestWord`` + * - ``suggest_word`` - Sí - Palabra clave a elevar * - ``reading`` @@ -178,7 +178,7 @@ Descripción de Campos * - ``boost`` - Sí - Valor de impulso (valor inicial del formulario: 100.0) - * - ``labelTypeIds`` + * - ``label_type_ids`` - No - IDs de etiqueta objetivo (arreglo de cadenas) @@ -213,12 +213,12 @@ Cuerpo de la Solicitud { "id": "existing_elevate_id", - "suggestWord": "documentation", + "suggest_word": "documentation", "reading": "", "permissions": "{role}guest\n{role}user", "boost": 100.0, - "labelTypeIds": ["label1"], - "versionNo": 1 + "label_type_ids": ["label1"], + "version_no": 1 } .. note:: @@ -226,7 +226,7 @@ Cuerpo de la Solicitud Al actualizar, los siguientes campos son obligatorios además de los campos utilizados para la creación: - ``id`` - ID de la palabra elevada a actualizar - - ``versionNo`` - Número de versión para el bloqueo optimista. Especifique el valor obtenido de ``GET /setting/{id}``. + - ``version_no`` - Número de versión para el bloqueo optimista. Especifique el valor obtenido de ``GET /setting/{id}``. Respuesta --------- @@ -326,7 +326,7 @@ Elevar Nombre de Producto -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "suggestWord": "Product X", + "suggest_word": "Product X", "boost": 100.0, "permissions": "{role}guest" }' @@ -340,9 +340,9 @@ Elevar a Etiqueta Específica -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "suggestWord": "API reference", + "suggest_word": "API reference", "boost": 100.0, - "labelTypeIds": ["technical_docs"], + "label_type_ids": ["technical_docs"], "permissions": "{role}guest" }' diff --git a/es/15.9/api/admin/api-admin-failureurl.rst b/es/15.9/api/admin/api-admin-failureurl.rst index 03893ca55..d47de00f3 100644 --- a/es/15.9/api/admin/api-admin-failureurl.rst +++ b/es/15.9/api/admin/api-admin-failureurl.rst @@ -71,15 +71,15 @@ Parámetros - String - No - Filtro por URL (se admiten comodines ``*`` ``?``) - * - ``errorCountMin`` + * - ``error_count_min`` - Integer - No - Límite inferior del número de errores (mayor o igual al valor especificado) - * - ``errorCountMax`` + * - ``error_count_max`` - Integer - No - Límite superior del número de errores (menor o igual al valor especificado) - * - ``errorName`` + * - ``error_name`` - String - No - Filtro por nombre de error (coincidencia con comodín sobre el nombre de clase completamente calificado almacenado; se admiten ``*`` ``?``) @@ -96,22 +96,22 @@ Respuesta { "id": "failure_id_1", "url": "https://example.com/broken-page", - "threadName": "Crawler-1", - "errorName": "java.net.ConnectException", - "errorLog": "Connection refused: connect", - "errorCount": "3", - "lastAccessTime": "1738144800000", - "configId": "webConfig_id_1" + "thread_name": "Crawler-1", + "error_name": "java.net.ConnectException", + "error_log": "Connection refused: connect", + "error_count": "3", + "last_access_time": "1738144800000", + "config_id": "webConfig_id_1" }, { "id": "failure_id_2", "url": "https://example.com/not-found", - "threadName": "Crawler-2", - "errorName": "org.codelibs.fess.exception.ContentNotFoundException", - "errorLog": "Not found: https://example.com/not-found", - "errorCount": "1", - "lastAccessTime": "1738143000000", - "configId": "webConfig_id_1" + "thread_name": "Crawler-2", + "error_name": "org.codelibs.fess.exception.ContentNotFoundException", + "error_log": "Not found: https://example.com/not-found", + "error_count": "1", + "last_access_time": "1738143000000", + "config_id": "webConfig_id_1" } ], "total": 45 @@ -131,22 +131,22 @@ Campos de Respuesta - ID de URL fallida * - ``url`` - URL que falló - * - ``threadName`` + * - ``thread_name`` - Nombre del hilo - * - ``errorName`` + * - ``error_name`` - Nombre del error (nombre de clase completamente calificado de la excepción ocurrida; por ejemplo, ``java.net.ConnectException``) - * - ``errorLog`` + * - ``error_log`` - Registro de error (mensaje de la excepción o traza de pila) - * - ``errorCount`` + * - ``error_count`` - Número de ocurrencias del error (valor numérico representado como cadena) - * - ``lastAccessTime`` + * - ``last_access_time`` - Hora del último acceso (milisegundos epoch representados como cadena) - * - ``configId`` + * - ``config_id`` - ID de configuración de rastreo .. note:: - Todos los campos de respuesta se devuelven como cadenas (JSON string). ``errorCount`` es un valor numérico representado como cadena y ``lastAccessTime`` son milisegundos epoch representados como cadena. + Todos los campos de respuesta se devuelven como cadenas (JSON string). ``error_count`` es un valor numérico representado como cadena y ``last_access_time`` son milisegundos epoch representados como cadena. Obtener URL Fallida =================== @@ -169,12 +169,12 @@ Respuesta "log": { "id": "failure_id_1", "url": "https://example.com/broken-page", - "threadName": "Crawler-1", - "errorName": "java.net.ConnectException", - "errorLog": "Connection refused: connect", - "errorCount": "3", - "lastAccessTime": "1738144800000", - "configId": "webConfig_id_1" + "thread_name": "Crawler-1", + "error_name": "java.net.ConnectException", + "error_log": "Connection refused: connect", + "error_count": "3", + "last_access_time": "1738144800000", + "config_id": "webConfig_id_1" } } } @@ -226,7 +226,7 @@ Respuesta Tipos de Error ============== -``errorName`` almacena el nombre de clase completamente calificado de la excepción ocurrida durante el rastreo, tal como fue capturado. No es una enumeración fija; puede aparecer cualquier nombre de clase dependiendo de la excepción que se haya producido. A continuación se muestran ejemplos representativos. +``error_name`` almacena el nombre de clase completamente calificado de la excepción ocurrida durante el rastreo, tal como fue capturado. No es una enumeración fija; puede aparecer cualquier nombre de clase dependiendo de la excepción que se haya producido. A continuación se muestran ejemplos representativos. .. list-table:: :header-rows: 1 @@ -310,7 +310,7 @@ Agregación por Tipo de Error # Contar por tipo de error curl -X GET "http://localhost:8080/api/admin/failureurl/logs?size=1000" \ -H "Authorization: Bearer YOUR_TOKEN" | \ - jq '[.response.logs[].errorName] | group_by(.) | map({error: .[0], count: length})' + 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-fileconfig.rst b/es/15.9/api/admin/api-admin-fileconfig.rst index 476e8ffcb..10adf0bdc 100644 --- a/es/15.9/api/admin/api-admin-fileconfig.rst +++ b/es/15.9/api/admin/api-admin-fileconfig.rst @@ -106,20 +106,20 @@ Respuesta "name": "Shared Documents", "description": "Documentos compartidos", "paths": "smb://server/share/documents", - "includedPaths": ".*\\.pdf$", - "excludedPaths": ".*/(temp|cache)/.*", - "includedDocPaths": "", - "excludedDocPaths": "", - "configParameter": "", + "included_paths": ".*\\.pdf$", + "excluded_paths": ".*/(temp|cache)/.*", + "included_doc_paths": "", + "excluded_doc_paths": "", + "config_parameter": "", "depth": 10, - "maxAccessCount": 1000, - "numOfThread": 1, - "intervalTime": 1000, + "max_access_count": 1000, + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, "available": "true", "permissions": "{role}admin", - "virtualHosts": "", - "sortOrder": 0 + "virtual_hosts": "", + "sort_order": 0 } ], "total": 5 @@ -151,35 +151,35 @@ Respuesta "name": "Shared Documents", "description": "Documentos compartidos", "paths": "smb://server/share/documents", - "includedPaths": ".*\\.pdf$", - "excludedPaths": ".*/(temp|cache)/.*", - "includedDocPaths": "", - "excludedDocPaths": "", - "configParameter": "", + "included_paths": ".*\\.pdf$", + "excluded_paths": ".*/(temp|cache)/.*", + "included_doc_paths": "", + "excluded_doc_paths": "", + "config_parameter": "", "depth": 10, - "maxAccessCount": 1000, - "numOfThread": 1, - "intervalTime": 1000, + "max_access_count": 1000, + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin", - "virtualHosts": "", - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_hosts": "", + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } .. note:: - La respuesta incluye los campos de auditoría ``createdBy``, ``createdTime``, - ``updatedBy``, ``updatedTime`` y ``versionNo``, que son asignados automáticamente + La respuesta incluye los campos de auditoría ``created_by``, ``created_time``, + ``updated_by``, ``updated_time`` y ``version_no``, que son asignados automáticamente en el momento del registro o la actualización. - ``versionNo`` es obligatorio al actualizar (consulte la sección "Actualizar configuración de rastreo de archivos" a continuación). + ``version_no`` es obligatorio al actualizar (consulte la sección "Actualizar configuración de rastreo de archivos" a continuación). Crear Configuración de Rastreo de Archivos ========================================== @@ -200,13 +200,13 @@ Cuerpo de la Solicitud { "name": "Local Files", "paths": "file:///data/documents", - "includedPaths": ".*\\.(pdf|doc|docx|xls|xlsx)$", - "excludedPaths": ".*/(temp|backup)/.*", - "numOfThread": 2, - "intervalTime": 500, + "included_paths": ".*\\.(pdf|doc|docx|xls|xlsx)$", + "excluded_paths": ".*/(temp|backup)/.*", + "num_of_thread": 2, + "interval_time": 500, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin\n{role}user" } @@ -229,31 +229,31 @@ Descripción de Campos * - ``paths`` - Sí - Ruta de inicio de rastreo (separadas por salto de línea si son múltiples). Se especifica con uno de los protocolos: ``file:``, ``smb:``, ``smb1:``, ``ftp:``, ``s3:`` o ``gcs:`` - * - ``includedPaths`` + * - ``included_paths`` - No - Patrón de expresión regular para rutas a rastrear - * - ``excludedPaths`` + * - ``excluded_paths`` - No - Patrón de expresión regular para rutas a excluir del rastreo - * - ``includedDocPaths`` + * - ``included_doc_paths`` - No - Patrón de expresión regular para rutas a indexar - * - ``excludedDocPaths`` + * - ``excluded_doc_paths`` - No - Patrón de expresión regular para rutas a excluir del índice - * - ``configParameter`` + * - ``config_parameter`` - No - Parámetros de configuración adicionales (formato ``key=value``, un elemento por línea) * - ``depth`` - No - Profundidad de rastreo (0 o más) - * - ``maxAccessCount`` + * - ``max_access_count`` - No - Número máximo de accesos (0 o más) - * - ``numOfThread`` + * - ``num_of_thread`` - Sí - Número de hilos paralelos (1 o más) - * - ``intervalTime`` + * - ``interval_time`` - Sí - Intervalo de acceso (milisegundos, 0 o más) * - ``boost`` @@ -262,19 +262,19 @@ Descripción de Campos * - ``available`` - Sí - Habilitado/Deshabilitado (cadena ``"true"`` / ``"false"``) - * - ``sortOrder`` + * - ``sort_order`` - Sí - Orden de visualización (0 o más) * - ``permissions`` - No - Roles con permiso de acceso (separados por saltos de línea si son varios) - * - ``virtualHosts`` + * - ``virtual_hosts`` - No - Hosts virtuales (separados por saltos de línea si son varios) .. note:: - Los campos de auditoría como ``createdBy``, ``createdTime``, ``updatedBy`` y ``updatedTime`` + Los campos de auditoría como ``created_by``, ``created_time``, ``updated_by`` y ``updated_time`` son asignados automáticamente por el servidor, por lo que no es necesario incluirlos en el cuerpo de la solicitud. Respuesta @@ -305,8 +305,8 @@ Cuerpo de la Solicitud ~~~~~~~~~~~~~~~~~~~~~~ Al actualizar, además de los campos de creación, son obligatorios ``id`` para identificar -el registro a actualizar y ``versionNo`` como número de versión. -En ``versionNo`` se debe especificar el valor actual incluido en la respuesta de la API de consulta (GET). +el registro a actualizar y ``version_no`` como número de versión. +En ``version_no`` se debe especificar el valor actual incluido en la respuesta de la API de consulta (GET). .. code-block:: json @@ -314,16 +314,16 @@ En ``versionNo`` se debe especificar el valor actual incluido en la respuesta de "id": "existing_fileconfig_id", "name": "Updated Local Files", "paths": "file:///data/documents", - "includedPaths": ".*\\.(pdf|doc|docx|xls|xlsx|ppt|pptx)$", - "excludedPaths": ".*/(temp|backup|archive)/.*", + "included_paths": ".*\\.(pdf|doc|docx|xls|xlsx|ppt|pptx)$", + "excluded_paths": ".*/(temp|backup|archive)/.*", "depth": 10, - "maxAccessCount": 10000, - "numOfThread": 3, - "intervalTime": 300, + "max_access_count": 10000, + "num_of_thread": 3, + "interval_time": 300, "boost": 1.2, "available": "true", - "sortOrder": 0, - "versionNo": 1 + "sort_order": 0, + "version_no": 1 } Campos Adicionales para la Actualización @@ -339,9 +339,9 @@ Campos Adicionales para la Actualización * - ``id`` - Sí - ID de la configuración a actualizar (máximo 1000 caracteres) - * - ``versionNo`` + * - ``version_no`` - Sí - - Número de versión actual del registro a actualizar. Se especifica el valor de ``versionNo`` incluido en la respuesta de la API de consulta (GET) + - Número de versión actual del registro a actualizar. Se especifica el valor de ``version_no`` incluido en la respuesta de la API de consulta (GET) Respuesta --------- @@ -421,13 +421,13 @@ Configuración de Rastreo de Archivos Locales -d '{ "name": "Local Files", "paths": "file:///data/documents", - "includedPaths": ".*\\.(pdf|doc|docx)$", - "excludedPaths": ".*/(temp|backup)/.*", - "numOfThread": 2, - "intervalTime": 500, + "included_paths": ".*\\.(pdf|doc|docx)$", + "excluded_paths": ".*/(temp|backup)/.*", + "num_of_thread": 2, + "interval_time": 500, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}guest" }' @@ -442,14 +442,14 @@ Configuración de Rastreo de Recurso Compartido SMB -d '{ "name": "SMB Share", "paths": "smb://server/documents", - "includedPaths": ".*\\.(pdf|doc|docx)$", - "excludedPaths": ".*/(temp|private)/.*", - "maxAccessCount": 50000, - "numOfThread": 3, - "intervalTime": 200, + "included_paths": ".*\\.(pdf|doc|docx)$", + "excluded_paths": ".*/(temp|private)/.*", + "max_access_count": 50000, + "num_of_thread": 3, + "interval_time": 200, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}guest" }' diff --git a/es/15.9/api/admin/api-admin-general.rst b/es/15.9/api/admin/api-admin-general.rst index a0bea5304..0e54e8dba 100644 --- a/es/15.9/api/admin/api-admin-general.rst +++ b/es/15.9/api/admin/api-admin-general.rst @@ -70,37 +70,36 @@ hilos se expresan como números. "version": "15.9.0", "status": 0, "setting": { - "incrementalCrawling": "true", - "dayForCleanup": -1, - "crawlingThreadCount": 5, - "searchLog": "true", - "userInfo": "true", - "userFavorite": "false", - "webApiJson": "true", - "defaultLabelValue": "", - "defaultSortValue": "", - "appendQueryParameter": "false", - "loginRequired": "false", + "incremental_crawling": "true", + "day_for_cleanup": -1, + "crawling_thread_count": 5, + "search_log": "true", + "user_info": "true", + "user_favorite": "false", + "web_api_json": "true", + "default_label_value": "", + "default_sort_value": "", + "append_query_parameter": "false", + "login_required": "false", "thumbnail": "true", - "failureCountThreshold": -1, - "popularWord": "true", - "csvFileEncoding": "UTF-8", - "purgeSearchLogDay": 30, - "purgeJobLogDay": 30, - "purgeUserInfoDay": 30, - "purgeSuggestSearchLogDay": 30, - "notificationTo": "", - "suggestSearchLog": "true", - "suggestDocuments": "true", - "ldapProviderUrl": "ldap://localhost:389/", - "ldapBaseDn": "dc=example,dc=com", - "ldapAdminSecurityPrincipal": "cn=admin,dc=example,dc=com", - "ldapAdminSecurityCredentials": null, - "logLevel": "", - "ssoType": "none", - "storageType": "", - "notificationLogin": "", - "notificationSearchTop": "" + "failure_count_threshold": -1, + "popular_word": "true", + "csv_file_encoding": "UTF-8", + "purge_search_log_day": 30, + "purge_job_log_day": 30, + "purge_user_info_day": 30, + "purge_suggest_search_log_day": 30, + "notification_to": "", + "suggest_search_log": "true", + "suggest_documents": "true", + "ldap_provider_url": "ldap://localhost:389/", + "ldap_base_dn": "dc=example,dc=com", + "ldap_admin_security_principal": "cn=admin,dc=example,dc=com", + "log_level": "", + "sso_type": "none", + "storage_type": "", + "notification_login": "", + "notification_search_top": "" } } } @@ -117,11 +116,11 @@ hilos se expresan como números. Por razones de seguridad, los campos que contienen credenciales no se devuelven con sus valores reales. - - La contraseña del administrador LDAP ``ldapAdminSecurityCredentials`` siempre se - devuelve como ``null``. - - Otros secretos (``storageAccessKey`` / ``storageSecretKey`` / - ``oicClientId`` / ``oicClientSecret`` / ``spnegoPreauthPassword`` / - ``entraidClientId`` / ``entraidClientSecret``) se devuelven enmascarados como + - La contraseña del administrador LDAP ``ldap_admin_security_credentials`` nunca se + incluye en la respuesta. + - Otros secretos (``storage_access_key`` / ``storage_secret_key`` / + ``oic_client_id`` / ``oic_client_secret`` / ``spnego_preauth_password`` / + ``entraid_client_id`` / ``entraid_client_secret``) se devuelven enmascarados como ``"**********"`` cuando están configurados, o como una cadena vacía (``""``) cuando no lo están. @@ -150,10 +149,10 @@ sus valores existentes. Los siguientes cuatro campos son requeridos y DEBEN incluirse en CADA solicitud PUT, incluso en una actualización parcial: - - ``dayForCleanup`` - - ``crawlingThreadCount`` - - ``failureCountThreshold`` - - ``csvFileEncoding`` + - ``day_for_cleanup`` + - ``crawling_thread_count`` + - ``failure_count_threshold`` + - ``csv_file_encoding`` Si falta alguno de ellos, la solicitud falla la validación y la API devuelve HTTP 400 con ``status: 1`` y un ``message`` de error. Dado que el valor enviado sobreescribe la @@ -180,12 +179,12 @@ sus valores existentes. .. code-block:: json { - "incrementalCrawling": "true", - "dayForCleanup": -1, - "crawlingThreadCount": 10, - "failureCountThreshold": 100, - "csvFileEncoding": "UTF-8", - "popularWord": "true" + "incremental_crawling": "true", + "day_for_cleanup": -1, + "crawling_thread_count": 10, + "failure_count_threshold": 100, + "csv_file_encoding": "UTF-8", + "popular_word": "true" } Campos Principales @@ -204,124 +203,124 @@ activación/desactivación se especifican como las cadenas ``"true"`` / * - Campo - Requerido - Descripción - * - ``incrementalCrawling`` + * - ``incremental_crawling`` - No - Habilitar/deshabilitar el rastreo incremental - * - ``dayForCleanup`` + * - ``day_for_cleanup`` - Sí - Número de días que se conservan los documentos rastreados (-1=limpieza deshabilitada; rango: -1 a 1000) - * - ``crawlingThreadCount`` + * - ``crawling_thread_count`` - Sí - Número de hilos usados para el rastreo (rango: 0 a 100) - * - ``failureCountThreshold`` + * - ``failure_count_threshold`` - Sí - Umbral del número de fallos para detener el rastreo de una URL (-1=deshabilitado; rango: -1 a 10000) - * - ``csvFileEncoding`` + * - ``csv_file_encoding`` - Sí - Codificación de la exportación CSV - * - ``searchLog`` + * - ``search_log`` - No - Habilitar/deshabilitar el registro de consultas de búsqueda - * - ``userInfo`` + * - ``user_info`` - No - Habilitar/deshabilitar el registro de información de usuario - * - ``userFavorite`` + * - ``user_favorite`` - No - Habilitar/deshabilitar la función de favoritos - * - ``webApiJson`` + * - ``web_api_json`` - No - Habilitar/deshabilitar la Web API JSON - * - ``appValue`` + * - ``app_value`` - No - Valor de configuración adicional específico de la aplicación - * - ``virtualHostValue`` + * - ``virtual_host_value`` - No - Configuración de host virtual (para entornos multi-tenant) - * - ``popularWord`` + * - ``popular_word`` - No - Habilitar/deshabilitar la agregación y visualización de palabras populares - * - ``defaultLabelValue`` + * - ``default_label_value`` - No - Valor de etiqueta predeterminado - * - ``defaultSortValue`` + * - ``default_sort_value`` - No - Orden de clasificación predeterminado - * - ``appendQueryParameter`` + * - ``append_query_parameter`` - No - Agregar parámetros de consulta a la URL de los resultados de búsqueda - * - ``loginRequired`` + * - ``login_required`` - No - Si se requiere inicio de sesión para buscar - * - ``loginLink`` + * - ``login_link`` - No - Habilitar o deshabilitar la visualización del enlace de inicio de sesión en la pantalla de búsqueda * - ``thumbnail`` - No - Habilitar/deshabilitar la generación de miniaturas - * - ``resultCollapsed`` + * - ``result_collapsed`` - No - Habilitar o deshabilitar el colapso de documentos similares en los resultados de búsqueda - * - ``ignoreFailureType`` + * - ``ignore_failure_type`` - No - Tipos de fallo de rastreo a ignorar - * - ``crawlingUserAgent`` + * - ``crawling_user_agent`` - No - Cadena User-Agent enviada durante el rastreo - * - ``purgeSearchLogDay`` + * - ``purge_search_log_day`` - No - Número de días que se conservan los registros de búsqueda (-1=deshabilitado; rango: -1 a 100000) - * - ``purgeJobLogDay`` + * - ``purge_job_log_day`` - No - Número de días que se conservan los registros de trabajos (-1=deshabilitado; rango: -1 a 100000) - * - ``purgeUserInfoDay`` + * - ``purge_user_info_day`` - No - Número de días que se conserva la información de usuario (-1=deshabilitado; rango: -1 a 100000) - * - ``purgeSuggestSearchLogDay`` + * - ``purge_suggest_search_log_day`` - No - Número de días que se conservan los registros de búsqueda de sugerencias (0=deshabilitado; rango: 0 a 100000) - * - ``purgeByBots`` + * - ``purge_by_bots`` - No - User-Agent de bots cuyos registros de búsqueda se descartan - * - ``notificationTo`` + * - ``notification_to`` - No - Dirección de correo electrónico de destino de las notificaciones del sistema - * - ``notificationLogin`` + * - ``notification_login`` - No - Mensaje de notificación que se muestra en la página de inicio de sesión - * - ``notificationSearchTop`` + * - ``notification_search_top`` - No - Mensaje de notificación que se muestra en la página principal de búsqueda - * - ``notificationAdvanceSearch`` + * - ``notification_advance_search`` - No - Mensaje de notificación que se muestra en la página de búsqueda avanzada - * - ``suggestSearchLog`` + * - ``suggest_search_log`` - No - Habilitar/deshabilitar las sugerencias a partir de los registros de búsqueda - * - ``suggestDocuments`` + * - ``suggest_documents`` - No - Habilitar/deshabilitar las sugerencias a partir de los documentos - * - ``logLevel`` + * - ``log_level`` - No - Nivel de registro del log del sistema - * - ``logNotificationEnabled`` + * - ``log_notification_enabled`` - No - Habilitar/deshabilitar la notificación de logs ERROR/WARN - * - ``logNotificationLevel`` + * - ``log_notification_level`` - No - Nivel de notificación de logs - * - ``slackWebhookUrls`` + * - ``slack_webhook_urls`` - No - URL de Slack Webhook para notificaciones - * - ``googleChatWebhookUrls`` + * - ``google_chat_webhook_urls`` - No - URL de Google Chat Webhook para notificaciones - * - ``searchUseBrowserLocale`` + * - ``search_use_browser_locale`` - No - Si se utiliza el idioma del navegador para la búsqueda - * - ``ragLlmName`` + * - ``rag_llm_name`` - No - Nombre del proveedor LLM utilizado para RAG - * - ``llmLogLevel`` + * - ``llm_log_level`` - No - Nivel de registro para los paquetes relacionados con LLM @@ -339,29 +338,29 @@ ajustes "General" en la interfaz de administración). * - Campo - Descripción - * - ``ldapProviderUrl`` + * - ``ldap_provider_url`` - URL de conexión LDAP - * - ``ldapBaseDn`` + * - ``ldap_base_dn`` - DN base de LDAP - * - ``ldapSecurityPrincipal`` + * - ``ldap_security_principal`` - Principal de seguridad para el enlace (bind) LDAP - * - ``ldapAdminSecurityPrincipal`` + * - ``ldap_admin_security_principal`` - Principal de seguridad para operaciones administrativas LDAP - * - ``ldapAdminSecurityCredentials`` - - Contraseña del administrador LDAP (se reemplaza por ``null`` en la respuesta) - * - ``ldapAccountFilter`` / ``ldapGroupFilter`` + * - ``ldap_admin_security_credentials`` + - Contraseña del administrador LDAP (nunca se incluye en la respuesta) + * - ``ldap_account_filter`` / ``ldap_group_filter`` - Filtros de búsqueda de usuarios/grupos - * - ``ldapMemberofAttribute`` + * - ``ldap_memberof_attribute`` - Nombre del atributo LDAP que indica la pertenencia a un grupo - * - ``ssoType`` + * - ``sso_type`` - Tipo de SSO (``none`` / ``oic`` / ``saml`` / ``spnego`` / ``entraid``) - * - ``oicClientId`` / ``oicClientSecret`` / ``oicAuthServerUrl`` y otros + * - ``oic_client_id`` / ``oic_client_secret`` / ``oic_auth_server_url`` y otros - Configuración de OpenID Connect - * - ``samlIdpEntityid`` / ``samlSpEntityid`` y otros + * - ``saml_idp_entityid`` / ``saml_sp_entityid`` y otros - Configuración de SAML - * - ``spnegoKrb5Conf`` / ``spnegoLoginConf`` y otros + * - ``spnego_krb5_conf`` / ``spnego_login_conf`` y otros - Configuración de SPNEGO - * - ``entraidClientId`` / ``entraidTenant`` y otros + * - ``entraid_client_id`` / ``entraid_tenant`` y otros - Configuración de Microsoft Entra ID Campos Relacionados con Almacenamiento @@ -376,24 +375,24 @@ en la nube (S3 / GCS). * - Campo - Descripción - * - ``storageType`` + * - ``storage_type`` - Tipo de almacenamiento (``auto`` / ``s3`` / ``gcs``) - * - ``storageEndpoint`` + * - ``storage_endpoint`` - URL del endpoint del almacenamiento - * - ``storageAccessKey`` / ``storageSecretKey`` + * - ``storage_access_key`` / ``storage_secret_key`` - Clave de acceso/clave secreta para la autenticación - * - ``storageBucket`` + * - ``storage_bucket`` - Nombre del bucket - * - ``storageRegion`` + * - ``storage_region`` - Región de S3 - * - ``storageProjectId`` / ``storageCredentialsPath`` + * - ``storage_project_id`` / ``storage_credentials_path`` - ID de proyecto de GCS / ruta del archivo de credenciales .. note:: - Los campos de tipo secreto como ``ldapAdminSecurityCredentials``, - ``storageAccessKey`` / ``storageSecretKey``, ``oicClientId`` / ``oicClientSecret``, - ``entraidClientId`` / ``entraidClientSecret`` y ``spnegoPreauthPassword`` conservan su + Los campos de tipo secreto como ``ldap_admin_security_credentials``, + ``storage_access_key`` / ``storage_secret_key``, ``oic_client_id`` / ``oic_client_secret``, + ``entraid_client_id`` / ``entraid_client_secret`` y ``spnego_preauth_password`` conservan su valor almacenado (no se actualizan) cuando se envía el valor enmascarado ``"**********"`` tal cual. Envíe el valor real solo cuando desee cambiarlo. @@ -427,8 +426,8 @@ Ejemplos de Uso .. note:: - Los ejemplos a continuación incluyen los campos requeridos (``dayForCleanup``, - ``crawlingThreadCount``, ``failureCountThreshold``, ``csvFileEncoding``). Como estos + Los ejemplos a continuación incluyen los campos requeridos (``day_for_cleanup``, + ``crawling_thread_count``, ``failure_count_threshold``, ``csv_file_encoding``). Como estos deben enviarse siempre independientemente de lo que se desee cambiar, recupere los valores actuales con ``GET`` e inclúyalos en la operación real (los ejemplos a continuación usan los valores predeterminados). @@ -442,11 +441,11 @@ Actualizar la Configuración de Rastreo -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "incrementalCrawling": "true", - "crawlingThreadCount": 10, - "failureCountThreshold": 100, - "dayForCleanup": -1, - "csvFileEncoding": "UTF-8" + "incremental_crawling": "true", + "crawling_thread_count": 10, + "failure_count_threshold": 100, + "day_for_cleanup": -1, + "csv_file_encoding": "UTF-8" }' Actualizar el Período de Retención de Registros @@ -458,13 +457,13 @@ Actualizar el Período de Retención de Registros -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "dayForCleanup": -1, - "crawlingThreadCount": 5, - "failureCountThreshold": -1, - "csvFileEncoding": "UTF-8", - "purgeSearchLogDay": 90, - "purgeJobLogDay": 90, - "purgeUserInfoDay": 90 + "day_for_cleanup": -1, + "crawling_thread_count": 5, + "failure_count_threshold": -1, + "csv_file_encoding": "UTF-8", + "purge_search_log_day": 90, + "purge_job_log_day": 90, + "purge_user_info_day": 90 }' Actualizar la Configuración de Sugerencias @@ -476,12 +475,12 @@ Actualizar la Configuración de Sugerencias -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "dayForCleanup": -1, - "crawlingThreadCount": 5, - "failureCountThreshold": -1, - "csvFileEncoding": "UTF-8", - "suggestSearchLog": "true", - "suggestDocuments": "true" + "day_for_cleanup": -1, + "crawling_thread_count": 5, + "failure_count_threshold": -1, + "csv_file_encoding": "UTF-8", + "suggest_search_log": "true", + "suggest_documents": "true" }' Información de Referencia diff --git a/es/15.9/api/admin/api-admin-group.rst b/es/15.9/api/admin/api-admin-group.rst index f40631064..9a179725f 100644 --- a/es/15.9/api/admin/api-admin-group.rst +++ b/es/15.9/api/admin/api-admin-group.rst @@ -90,7 +90,7 @@ Respuesta "attributes": { "gidNumber": "1000" }, - "versionNo": 1 + "version_no": 1 }, { "id": "group_id_2", @@ -98,7 +98,7 @@ Respuesta "attributes": { "gidNumber": "1001" }, - "versionNo": 1 + "version_no": 1 } ], "total": 5 @@ -129,7 +129,7 @@ Respuesta "attributes": { "gidNumber": "1000" }, - "versionNo": 1 + "version_no": 1 } } } @@ -209,7 +209,7 @@ Cuerpo de la Solicitud "attributes": { "gidNumber": "1002" }, - "versionNo": 1 + "version_no": 1 } Descripción de Campos @@ -231,9 +231,9 @@ Descripción de Campos * - ``attributes`` - No - Mapa de atributos (incluye atributos LDAP como ``gidNumber``). Los valores se especifican como cadenas - * - ``versionNo`` + * - ``version_no`` - Sí - - Número de versión para el bloqueo optimista. Especifique el valor de ``versionNo`` obtenido al obtener el grupo + - Número de versión para el bloqueo optimista. Especifique el valor de ``version_no`` obtenido al obtener el grupo Respuesta --------- diff --git a/es/15.9/api/admin/api-admin-joblog.rst b/es/15.9/api/admin/api-admin-joblog.rst index d23bf46b7..982c9566f 100644 --- a/es/15.9/api/admin/api-admin-joblog.rst +++ b/es/15.9/api/admin/api-admin-joblog.rst @@ -81,25 +81,25 @@ Respuesta "logs": [ { "id": "joblog_id_1", - "jobName": "Default Crawler", - "jobStatus": "ok", + "job_name": "Default Crawler", + "job_status": "ok", "target": "all", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "scriptResult": "Job completed successfully", - "startTime": "1738116000000", - "endTime": "1738118723000" + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "script_result": "Job completed successfully", + "start_time": "1738116000000", + "end_time": "1738118723000" }, { "id": "joblog_id_2", - "jobName": "Default Crawler", - "jobStatus": "fail", + "job_name": "Default Crawler", + "job_status": "fail", "target": "all", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "scriptResult": "Error: Connection timeout", - "startTime": "1738029600000", - "endTime": "1738030215000" + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "script_result": "Error: Connection timeout", + "start_time": "1738029600000", + "end_time": "1738030215000" } ], "total": 100 @@ -117,26 +117,26 @@ Campos de Respuesta - Descripción * - ``id`` - ID del registro de trabajo - * - ``jobName`` + * - ``job_name`` - Nombre del trabajo - * - ``jobStatus`` + * - ``job_status`` - Estado del trabajo (``ok``: exitoso, ``fail``: fallido, ``running``: en ejecución) * - ``target`` - Objetivo de ejecución (nombre del objetivo del programador; el valor predeterminado es ``all``) - * - ``scriptType`` + * - ``script_type`` - Tipo de script (ejemplo: ``javascript``) - * - ``scriptData`` + * - ``script_data`` - Script ejecutado - * - ``scriptResult`` + * - ``script_result`` - Resultado de la ejecución - * - ``startTime`` + * - ``start_time`` - Hora de inicio (milisegundos epoch; devuelto como cadena de texto) - * - ``endTime`` + * - ``end_time`` - Hora de finalización (milisegundos epoch; devuelto como cadena de texto). No se devuelve para trabajos en ejecución. .. note:: - Cada objeto de registro en la respuesta incluye también un campo interno ``crudMode`` + Cada objeto de registro en la respuesta incluye también un campo interno ``crud_mode`` (un entero que indica el modo de operación CRUD, siempre ``0`` para operaciones de lectura). Los clientes pueden ignorarlo sin problema. @@ -160,14 +160,14 @@ Respuesta "status": 0, "log": { "id": "joblog_id_1", - "jobName": "Default Crawler", - "jobStatus": "ok", + "job_name": "Default Crawler", + "job_status": "ok", "target": "all", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "scriptResult": "Crawl completed successfully.\nDocuments indexed: 1234\nDocuments updated: 567\nDocuments deleted: 12\nErrors: 0", - "startTime": "1738116000000", - "endTime": "1738118723000" + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "script_result": "Crawl completed successfully.\nDocuments indexed: 1234\nDocuments updated: 567\nDocuments deleted: 12\nErrors: 0", + "start_time": "1738116000000", + "end_time": "1738118723000" } } } diff --git a/es/15.9/api/admin/api-admin-keymatch.rst b/es/15.9/api/admin/api-admin-keymatch.rst index 067074600..0015b12cd 100644 --- a/es/15.9/api/admin/api-admin-keymatch.rst +++ b/es/15.9/api/admin/api-admin-keymatch.rst @@ -92,9 +92,9 @@ Respuesta "id": "keymatch_id_1", "term": "download", "query": "title:download OR content:download", - "maxSize": 10, + "max_size": 10, "boost": 10.0, - "versionNo": 1 + "version_no": 1 } ], "total": 5 @@ -104,8 +104,8 @@ Respuesta .. note:: En ``total`` se establece el número total de elementos que coinciden con los criterios de filtrado (no el número de elementos de la página actual). - Además de los campos indicados, cada objeto de configuración puede incluir ``virtualHost``, - ``createdBy``, ``createdTime``, ``updatedBy`` y ``updatedTime`` cuando dichos valores estén definidos. + Además de los campos indicados, cada objeto de configuración puede incluir ``virtual_host``, + ``created_by``, ``created_time``, ``updated_by`` y ``updated_time`` cuando dichos valores estén definidos. Obtener Coincidencia de Clave ============================= @@ -129,21 +129,21 @@ Respuesta "id": "keymatch_id_1", "term": "download", "query": "title:download OR content:download", - "maxSize": 10, + "max_size": 10, "boost": 10.0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } .. note:: - ``versionNo`` es el número de versión para el bloqueo optimista. Al actualizar una coincidencia de clave, - especifique el ``versionNo`` obtenido en la solicitud de obtención en el cuerpo de la solicitud. + ``version_no`` es el número de versión para el bloqueo optimista. Al actualizar una coincidencia de clave, + especifique el ``version_no`` obtenido en la solicitud de obtención en el cuerpo de la solicitud. Si el ID especificado no existe, se devuelve un error. Crear Coincidencia de Clave @@ -165,7 +165,7 @@ Cuerpo de la Solicitud { "term": "pricing", "query": "url:*/pricing* OR title:pricing", - "maxSize": 5, + "max_size": 5, "boost": 20.0 } @@ -188,7 +188,7 @@ Descripción de Campos - String - Sí - Consulta de condición de coincidencia (la longitud máxima sigue el valor de configuración de ``form.admin.max.input.size``) - * - ``maxSize`` + * - ``max_size`` - Integer - Sí - Número máximo de resultados mostrados (entero mayor o igual a 0; valor inicial en la pantalla de administración: 10) @@ -196,16 +196,16 @@ Descripción de Campos - Float - Sí - Valor de impulso (valor inicial en la pantalla de administración: 100.0) - * - ``virtualHost`` + * - ``virtual_host`` - String - No - Nombre del host virtual (máximo 1000 caracteres; especifíquelo cuando desee alternar las coincidencias de claves por host virtual) .. note:: - ``maxSize`` y ``boost`` son obligatorios a través de la API. Los valores iniciales son los que se muestran en el formulario + ``max_size`` y ``boost`` son obligatorios a través de la API. Los valores iniciales son los que se muestran en el formulario de la pantalla de administración y no se aplican en la API. Si se omiten, se producirá un error de validación. - Tenga en cuenta que ``createdBy`` y ``createdTime``, aunque se especifiquen en la solicitud, serán sobrescritos por el servidor. + Tenga en cuenta que ``created_by`` y ``created_time``, aunque se especifiquen en la solicitud, serán sobrescritos por el servidor. Respuesta --------- @@ -240,15 +240,15 @@ Cuerpo de la Solicitud "id": "existing_keymatch_id", "term": "pricing", "query": "url:*/pricing* OR title:pricing OR content:price", - "maxSize": 10, + "max_size": 10, "boost": 15.0, - "versionNo": 1 + "version_no": 1 } Descripción de Campos ~~~~~~~~~~~~~~~~~~~~~ -Además de los campos de creación (``term``, ``query``, ``maxSize``, ``boost``, ``virtualHost``), +Además de los campos de creación (``term``, ``query``, ``max_size``, ``boost``, ``virtual_host``), se deben especificar los siguientes campos. .. list-table:: @@ -263,7 +263,7 @@ se deben especificar los siguientes campos. - String - Sí - ID de la coincidencia de clave a actualizar (máximo 1000 caracteres) - * - ``versionNo`` + * - ``version_no`` - Integer - Sí - Número de versión para el bloqueo optimista; especifique el valor obtenido en la solicitud de obtención @@ -316,7 +316,7 @@ Crear Coincidencia de Clave para Página de Producto -d '{ "term": "product features", "query": "url:*/products/* AND (title:features OR content:features)", - "maxSize": 10, + "max_size": 10, "boost": 15.0 }' @@ -331,7 +331,7 @@ Coincidencia de Clave para Página de Soporte -d '{ "term": "help", "query": "url:*/support/* OR url:*/help/* OR url:*/faq/*", - "maxSize": 5, + "max_size": 5, "boost": 20.0 }' diff --git a/es/15.9/api/admin/api-admin-labeltype.rst b/es/15.9/api/admin/api-admin-labeltype.rst index e5b46ea52..0cd89cead 100644 --- a/es/15.9/api/admin/api-admin-labeltype.rst +++ b/es/15.9/api/admin/api-admin-labeltype.rst @@ -100,16 +100,16 @@ Respuesta "id": "label_id_1", "name": "Documentation", "value": "docs", - "includedPaths": ".*docs\\.example\\.com.*", - "excludedPaths": "", + "included_paths": ".*docs\\.example\\.com.*", + "excluded_paths": "", "permissions": "{role}admin", - "virtualHost": "", - "sortOrder": 0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_host": "", + "sort_order": 0, + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } ], "total": 5 @@ -118,8 +118,8 @@ Respuesta .. note:: - Cada objeto de configuración también incluye ``createdBy`` / ``createdTime`` / ``updatedBy`` / - ``updatedTime`` para auditoría, y ``versionNo`` para bloqueo optimista (los campos con valor + Cada objeto de configuración también incluye ``created_by`` / ``created_time`` / ``updated_by`` / + ``updated_time`` para auditoría, y ``version_no`` para bloqueo optimista (los campos con valor ``null`` se omiten). El objeto ``response`` siempre contiene ``version``, que indica la versión del producto, aunque en los ejemplos siguientes puede omitirse por brevedad. @@ -145,16 +145,16 @@ Respuesta "id": "label_id_1", "name": "Documentation", "value": "docs", - "includedPaths": ".*docs\\.example\\.com.*", - "excludedPaths": "", + "included_paths": ".*docs\\.example\\.com.*", + "excluded_paths": "", "permissions": "{role}admin", - "virtualHost": "", - "sortOrder": 0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_host": "", + "sort_order": 0, + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } @@ -178,9 +178,9 @@ Cuerpo de la solicitud { "name": "News", "value": "news", - "includedPaths": ".*news\\.example\\.com.*\n.*example\\.com/news/.*", - "excludedPaths": ".*/(archive|old)/.*", - "sortOrder": 1, + "included_paths": ".*news\\.example\\.com.*\n.*example\\.com/news/.*", + "excluded_paths": ".*/(archive|old)/.*", + "sort_order": 1, "permissions": "{role}guest" } @@ -203,11 +203,11 @@ Descripción de campos - String - Sí - Valor de la etiqueta (utilizado con el parámetro ``label`` en las búsquedas). Solo se permiten caracteres alfanuméricos ASCII y guión bajo (``_``), y debe coincidir con la expresión regular ``^[a-zA-Z0-9_]+$`` (máximo 100 caracteres). - * - ``includedPaths`` + * - ``included_paths`` - String - No - Expresión regular de las rutas a las que se aplica la etiqueta. Si se especifican varias, sepárelas con salto de línea (``\n``). - * - ``excludedPaths`` + * - ``excluded_paths`` - String - No - Expresión regular de las rutas excluidas de la etiqueta. Si se especifican varias, sepárelas con salto de línea (``\n``). @@ -215,18 +215,18 @@ Descripción de campos - String - No - Roles, grupos o usuarios con permiso de acceso (por ejemplo: ``{role}admin``). Si se especifican varios, sepárelos con salto de línea (``\n``). - * - ``sortOrder`` + * - ``sort_order`` - Integer - No - Orden de visualización (entero mayor o igual a 0). El valor predeterminado es ``0``. - * - ``virtualHost`` + * - ``virtual_host`` - String - No - Host virtual (máximo 1000 caracteres). .. note:: - Los campos de auditoría como ``createdBy`` / ``createdTime`` son establecidos automáticamente + Los campos de auditoría como ``created_by`` / ``created_time`` son establecidos automáticamente por el servidor, por lo que no es necesario especificarlos en la solicitud. Respuesta @@ -264,11 +264,11 @@ Cuerpo de la solicitud "id": "existing_label_id", "name": "News Articles", "value": "news", - "includedPaths": ".*news\\.example\\.com.*\n.*example\\.com/(news|articles)/.*", - "excludedPaths": ".*/(archive|old|draft)/.*", - "sortOrder": 1, + "included_paths": ".*news\\.example\\.com.*\n.*example\\.com/(news|articles)/.*", + "excluded_paths": ".*/(archive|old|draft)/.*", + "sort_order": 1, "permissions": "{role}guest", - "versionNo": 1 + "version_no": 1 } En la actualización, además de los campos de creación, los siguientes campos son obligatorios. @@ -285,10 +285,10 @@ En la actualización, además de los campos de creación, los siguientes campos - String - Sí - ID del tipo de etiqueta a actualizar. - * - ``versionNo`` + * - ``version_no`` - Integer - Sí - - Número de versión para bloqueo optimista. Especifique el valor de ``versionNo`` incluido en la respuesta al obtener el registro. Si la versión especificada no coincide con la actual, la actualización fallará. + - Número de versión para bloqueo optimista. Especifique el valor de ``version_no`` incluido en la respuesta al obtener el registro. Si la versión especificada no coincide con la actual, la actualización fallará. Respuesta --------- @@ -340,8 +340,8 @@ Crear etiqueta para documentación -d '{ "name": "Technical Documentation", "value": "tech_docs", - "includedPaths": ".*docs\\.example\\.com.*\n.*example\\.com/documentation/.*", - "sortOrder": 0, + "included_paths": ".*docs\\.example\\.com.*\n.*example\\.com/documentation/.*", + "sort_order": 0, "permissions": "{role}guest" }' diff --git a/es/15.9/api/admin/api-admin-overview.rst b/es/15.9/api/admin/api-admin-overview.rst index dd4374454..f17212986 100644 --- a/es/15.9/api/admin/api-admin-overview.rst +++ b/es/15.9/api/admin/api-admin-overview.rst @@ -516,22 +516,22 @@ Crear Configuración de Rastreo Web -d '{ "name": "Example Site", "urls": "https://example.com/", - "includedUrls": ".*example.com.*", - "excludedUrls": "", - "userAgent": "Mozilla/5.0 (compatible; Fess)", - "numOfThread": 1, - "intervalTime": 1000, + "included_urls": ".*example.com.*", + "excluded_urls": "", + "user_agent": "Mozilla/5.0 (compatible; Fess)", + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, - "maxAccessCount": 1000, + "max_access_count": 1000, "depth": 3, - "sortOrder": 1, + "sort_order": 1, "available": "true" }' .. note:: - Al crear una configuración de rastreo web, son obligatorios ``name``, ``urls``, ``userAgent``, ``numOfThread``, - ``intervalTime``, ``boost``, ``available`` y ``sortOrder``. Si se omiten, + Al crear una configuración de rastreo web, son obligatorios ``name``, ``urls``, ``user_agent``, ``num_of_thread``, + ``interval_time``, ``boost``, ``available`` y ``sort_order``. Si se omiten, se produce un error de validación (``status: 1``). ``available`` se especifica como una cadena de texto y se establece en ``"true"`` o ``"false"``. diff --git a/es/15.9/api/admin/api-admin-relatedcontent.rst b/es/15.9/api/admin/api-admin-relatedcontent.rst index bd08f356e..956dac328 100644 --- a/es/15.9/api/admin/api-admin-relatedcontent.rst +++ b/es/15.9/api/admin/api-admin-relatedcontent.rst @@ -93,13 +93,13 @@ Respuesta "id": "content_id_1", "term": "fess", "content": "
Fess is an open source search server.
", - "virtualHost": "", - "sortOrder": 0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_host": "", + "sort_order": 0, + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } ], "total": 5 @@ -110,9 +110,9 @@ Respuesta Cada elemento de ``settings`` y el objeto ``setting`` devuelto por el endpoint de obtención contienen los campos de la entidad almacenada tal como están. Además de - ``term``, ``content``, ``sortOrder`` y ``virtualHost``, también se devuelven los campos - de auditoría ``createdBy``, ``createdTime``, ``updatedBy``, ``updatedTime`` y el campo - de bloqueo optimista ``versionNo``. ``createdTime`` y ``updatedTime`` se expresan como + ``term``, ``content``, ``sort_order`` y ``virtual_host``, también se devuelven los campos + de auditoría ``created_by``, ``created_time``, ``updated_by``, ``updated_time`` y el campo + de bloqueo optimista ``version_no``. ``created_time`` y ``updated_time`` se expresan como milisegundos desde el epoch (números). Los campos que no están establecidos (null) se omiten de la respuesta. Además, el objeto ``response`` de todas las respuestas incluye siempre ``version``, que indica la versión del producto (consulte :doc:`api-admin-overview` @@ -141,20 +141,20 @@ Respuesta "id": "content_id_1", "term": "fess", "content": "
Fess is an open source search server.
", - "virtualHost": "", - "sortOrder": 0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_host": "", + "sort_order": 0, + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } .. note:: - El valor de ``versionNo`` necesario al actualizar (PUT) es el valor incluido en + El valor de ``version_no`` necesario al actualizar (PUT) es el valor incluido en esta respuesta de obtención. Crear Contenido Relacionado @@ -176,8 +176,8 @@ Cuerpo de la Solicitud { "term": "search", "content": "

About Search

Learn more about search features...

", - "sortOrder": 0, - "virtualHost": "" + "sort_order": 0, + "virtual_host": "" } Descripción de Campos @@ -196,10 +196,10 @@ Descripción de Campos * - ``content`` - Sí - Contenido HTML a mostrar (máx. 10000 caracteres) - * - ``sortOrder`` + * - ``sort_order`` - No - Orden de visualización (entero entre 0 y 2147483647) - * - ``virtualHost`` + * - ``virtual_host`` - No - Host virtual (máx. 1000 caracteres) @@ -237,9 +237,9 @@ Cuerpo de la Solicitud "id": "existing_content_id", "term": "search", "content": "

About Search

Updated information...

", - "sortOrder": 0, - "virtualHost": "", - "versionNo": 1 + "sort_order": 0, + "virtual_host": "", + "version_no": 1 } Descripción de Campos @@ -261,13 +261,13 @@ Descripción de Campos * - ``content`` - Sí - Contenido HTML a mostrar (máx. 10000 caracteres) - * - ``sortOrder`` + * - ``sort_order`` - No - Orden de visualización (entero entre 0 y 2147483647) - * - ``virtualHost`` + * - ``virtual_host`` - No - Host virtual (máx. 1000 caracteres) - * - ``versionNo`` + * - ``version_no`` - Sí - Número de versión para el bloqueo optimista. Especifique el valor incluido en la respuesta de ``setting/{id}``. @@ -287,8 +287,8 @@ Respuesta .. note:: - Los campos de auditoría como ``createdBy``, ``createdTime``, ``updatedBy``, - ``updatedTime`` y ``crudMode`` se ignoran aunque se incluyan en el cuerpo de la + Los campos de auditoría como ``created_by``, ``created_time``, ``updated_by``, + ``updated_time`` y ``crud_mode`` se ignoran aunque se incluyan en el cuerpo de la solicitud, ya que son establecidos automáticamente en el lado del servidor. No es necesario especificarlos al crear o actualizar. @@ -328,7 +328,7 @@ Contenido Relacionado de Información de Producto -d '{ "term": "product", "content": "

Our Products

", - "sortOrder": 0 + "sort_order": 0 }' Contenido Relacionado de Información de Soporte @@ -342,7 +342,7 @@ Contenido Relacionado de Información de Soporte -d '{ "term": "support", "content": "

Need help? Contact: support@example.com

", - "sortOrder": 0 + "sort_order": 0 }' Información de Referencia diff --git a/es/15.9/api/admin/api-admin-relatedquery.rst b/es/15.9/api/admin/api-admin-relatedquery.rst index ef064fd8e..f9ea84acb 100644 --- a/es/15.9/api/admin/api-admin-relatedquery.rst +++ b/es/15.9/api/admin/api-admin-relatedquery.rst @@ -92,7 +92,7 @@ Respuesta "id": "query_id_1", "term": "fess", "queries": "fess tutorial\nfess installation\nfess configuration", - "versionNo": 1 + "version_no": 1 } ], "total": 5 @@ -101,9 +101,9 @@ Respuesta .. note:: - Cada configuración incluye ``versionNo`` (número de versión para el bloqueo optimista). Los campos - ``virtualHost`` y los campos de auditoría (``createdBy``, ``createdTime``, ``updatedBy``, ``updatedTime``) - se incluyen únicamente cuando tienen un valor asignado. Un ``virtualHost`` vacío no se incluye + Cada configuración incluye ``version_no`` (número de versión para el bloqueo optimista). Los campos + ``virtual_host`` y los campos de auditoría (``created_by``, ``created_time``, ``updated_by``, ``updated_time``) + se incluyen únicamente cuando tienen un valor asignado. Un ``virtual_host`` vacío no se incluye en la respuesta. Obtener Consulta Relacionada @@ -129,8 +129,8 @@ Respuesta "id": "query_id_1", "term": "fess", "queries": "fess tutorial\nfess installation\nfess configuration", - "virtualHost": "site1.example.com", - "versionNo": 1 + "virtual_host": "site1.example.com", + "version_no": 1 } } } @@ -154,7 +154,7 @@ Cuerpo de la Solicitud { "term": "search", "queries": "search tutorial\nsearch syntax\nadvanced search", - "virtualHost": "" + "virtual_host": "" } Descripción de Campos @@ -173,13 +173,13 @@ Descripción de Campos * - ``queries`` - Sí - Consultas relacionadas. Cadena separada por saltos de línea, una por línea (las líneas vacías se ignoran; máximo 10000 caracteres) - * - ``virtualHost`` + * - ``virtual_host`` - No - Host virtual (máximo 1000 caracteres) .. note:: - ``crudMode`` es configurado automáticamente por la API, por lo que no es necesario incluirlo en el cuerpo de la solicitud. + ``crud_mode`` es configurado automáticamente por la API, por lo que no es necesario incluirlo en el cuerpo de la solicitud. Respuesta --------- @@ -215,8 +215,8 @@ Cuerpo de la Solicitud "id": "existing_query_id", "term": "search", "queries": "search tutorial\nsearch syntax\nadvanced search\nsearch tips", - "virtualHost": "", - "versionNo": 1 + "virtual_host": "", + "version_no": 1 } Descripción de Campos @@ -238,10 +238,10 @@ Descripción de Campos * - ``queries`` - Sí - Consultas relacionadas. Cadena separada por saltos de línea, una por línea (las líneas vacías se ignoran; máximo 10000 caracteres) - * - ``virtualHost`` + * - ``virtual_host`` - No - Host virtual (máximo 1000 caracteres) - * - ``versionNo`` + * - ``version_no`` - Sí - Número de versión para el bloqueo optimista. Debe especificarse el valor incluido en la respuesta de la consulta de obtención diff --git a/es/15.9/api/admin/api-admin-role.rst b/es/15.9/api/admin/api-admin-role.rst index 8e4a79376..c8a904214 100644 --- a/es/15.9/api/admin/api-admin-role.rst +++ b/es/15.9/api/admin/api-admin-role.rst @@ -87,12 +87,12 @@ Respuesta { "id": "role_id_1", "name": "admin", - "versionNo": 1 + "version_no": 1 }, { "id": "role_id_2", "name": "user", - "versionNo": 1 + "version_no": 1 } ], "total": 5 @@ -120,7 +120,7 @@ Respuesta "setting": { "id": "role_id_1", "name": "admin", - "versionNo": 1 + "version_no": 1 } } } @@ -194,7 +194,7 @@ Cuerpo de la Solicitud { "id": "existing_role_id", "name": "editor_updated", - "versionNo": 1 + "version_no": 1 } Descripción de Campos @@ -216,9 +216,9 @@ Descripción de Campos * - ``attributes`` - No - Mapa de atributos. Los valores se especifican como cadenas - * - ``versionNo`` + * - ``version_no`` - Sí - - Número de versión para el bloqueo optimista. Especifique el valor de ``versionNo`` obtenido al obtener el rol + - Número de versión para el bloqueo optimista. Especifique el valor de ``version_no`` obtenido al obtener el rol Respuesta --------- diff --git a/es/15.9/api/admin/api-admin-scheduler.rst b/es/15.9/api/admin/api-admin-scheduler.rst index 423c4f378..d54695f3d 100644 --- a/es/15.9/api/admin/api-admin-scheduler.rst +++ b/es/15.9/api/admin/api-admin-scheduler.rst @@ -91,14 +91,14 @@ Respuesta "id": "job_id_1", "name": "Default Crawler", "target": "all", - "cronExpression": "0 0 0 * * ?", - "scriptType": "javascript", - "scriptData": "...", - "jobLogging": "true", + "cron_expression": "0 0 0 * * ?", + "script_type": "javascript", + "script_data": "...", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 0, - "versionNo": 1, + "sort_order": 0, + "version_no": 1, "running": false } ], @@ -112,7 +112,7 @@ Respuesta .. note:: - En las respuestas, ``jobLogging`` / ``crawler`` / ``available`` se devuelven como cadenas (``"true"`` / ``"false"``). ``running`` es un campo booleano exclusivo de respuesta que indica si el trabajo se está ejecutando en ese momento (no puede especificarse en las solicitudes). ``total`` es el número total de trabajos que coinciden con la consulta. + En las respuestas, ``job_logging`` / ``crawler`` / ``available`` se devuelven como cadenas (``"true"`` / ``"false"``). ``running`` es un campo booleano exclusivo de respuesta que indica si el trabajo se está ejecutando en ese momento (no puede especificarse en las solicitudes). ``total`` es el número total de trabajos que coinciden con la consulta. Obtener Trabajo Programado ========================== @@ -136,14 +136,14 @@ Respuesta "id": "job_id_1", "name": "Default Crawler", "target": "all", - "cronExpression": "0 0 0 * * ?", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "jobLogging": "true", + "cron_expression": "0 0 0 * * ?", + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 0, - "versionNo": 1, + "sort_order": 0, + "version_no": 1, "running": false } } @@ -168,13 +168,13 @@ Cuerpo de la Solicitud { "name": "Daily Crawler", "target": "all", - "cronExpression": "0 0 2 * * ?", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "jobLogging": "true", + "cron_expression": "0 0 2 * * ?", + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 1 + "sort_order": 1 } Descripción de Campos @@ -193,16 +193,16 @@ Descripción de Campos * - ``target`` - Sí - Objetivo de ejecución (max. 100 caracteres). Especifique ``all`` o un nombre de objetivo específico - * - ``cronExpression`` + * - ``cron_expression`` - No - Expresión Cron (segundo minuto hora día mes día-semana). Max. 100 caracteres, validada como expresión cron. Si está vacía, el trabajo no se ejecuta de forma programada y solo puede iniciarse manualmente - * - ``scriptType`` + * - ``script_type`` - Sí - Tipo de script (max. 100 caracteres). ``javascript`` (valor predeterminado para trabajos nuevos, determinado por la propiedad ``job.default.script``) o ``groovy`` (requiere el plugin ``fess-script-groovy``) - * - ``scriptData`` + * - ``script_data`` - No - Script de ejecución. El tamaño máximo sigue ``form.admin.max.input.size`` en ``fess_config.properties`` - * - ``jobLogging`` + * - ``job_logging`` - No - Habilitar registro de trabajos (cadena) * - ``crawler`` @@ -211,17 +211,17 @@ Descripción de Campos * - ``available`` - No - Habilitado/Deshabilitado (cadena) - * - ``sortOrder`` + * - ``sort_order`` - Sí - Orden de visualización (entero entre 0 y 2147483647) .. note:: - ``jobLogging`` / ``crawler`` / ``available`` son campos de cadena. En las solicitudes, especificar ``"on"`` o ``"true"`` (sin distinción de mayúsculas y minúsculas) los habilita; cualquier otro valor (``"false"``, cadena vacía o no especificado) se trata como deshabilitado. En las respuestas se devuelven como ``"true"`` / ``"false"``. + ``job_logging`` / ``crawler`` / ``available`` son campos de cadena. En las solicitudes, especificar ``"on"`` o ``"true"`` (sin distinción de mayúsculas y minúsculas) los habilita; cualquier otro valor (``"false"``, cadena vacía o no especificado) se trata como deshabilitado. En las respuestas se devuelven como ``"true"`` / ``"false"``. .. note:: - ``crudMode`` se establece automáticamente en el servidor y no es necesario especificarlo en las solicitudes. Los campos de auditoría como ``createdBy`` / ``createdTime`` también se establecen en el servidor. + ``crud_mode`` se establece automáticamente en el servidor y no es necesario especificarlo en las solicitudes. Los campos de auditoría como ``created_by`` / ``created_time`` también se establecen en el servidor. Respuesta --------- @@ -274,19 +274,19 @@ Cuerpo de la Solicitud "id": "existing_job_id", "name": "Updated Crawler", "target": "all", - "cronExpression": "0 0 3 * * ?", - "scriptType": "javascript", - "scriptData": "...", - "jobLogging": "true", + "cron_expression": "0 0 3 * * ?", + "script_type": "javascript", + "script_data": "...", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 1, - "versionNo": 1 + "sort_order": 1, + "version_no": 1 } .. note:: - Para las actualizaciones, ``id`` (max. 1000 caracteres) y ``versionNo`` son obligatorios. ``versionNo`` se utiliza para el bloqueo optimista; especifique el valor devuelto en la respuesta de obtención. Si el valor no coincide, la actualización falla. Los demás campos obligatorios (``name`` / ``target`` / ``scriptType`` / ``sortOrder``) son los mismos que para la creación. + Para las actualizaciones, ``id`` (max. 1000 caracteres) y ``version_no`` son obligatorios. ``version_no`` se utiliza para el bloqueo optimista; especifique el valor devuelto en la respuesta de obtención. Si el valor no coincide, la actualización falla. Los demás campos obligatorios (``name`` / ``target`` / ``script_type`` / ``sort_order``) son los mismos que para la creación. Respuesta --------- @@ -344,7 +344,7 @@ Respuesta { "response": { "status": 0, - "jobLogId": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6" + "job_log_id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6" } } @@ -357,15 +357,15 @@ Campos de Respuesta * - Campo - Descripción - * - ``jobLogId`` - - ID del registro del trabajo iniciado. Se emite cuando el registro de trabajos está habilitado. Es ``null`` cuando el registro de trabajos está deshabilitado. + * - ``job_log_id`` + - ID del registro del trabajo iniciado. Se emite cuando el registro de trabajos está habilitado. Se omite de la respuesta cuando el registro de trabajos está deshabilitado. Notas ----- - Si el trabajo ya está en ejecución, el inicio falla y se devuelve un error (``status`` distinto de ``0``). - Si el trabajo está deshabilitado (``available`` no está habilitado), el inicio también falla con un error. -- ``jobLogId`` solo se emite cuando el registro de trabajos está habilitado (``jobLogging`` está habilitado). +- ``job_log_id`` solo se emite cuando el registro de trabajos está habilitado (``job_logging`` está habilitado). Detener Trabajo =============== @@ -405,13 +405,13 @@ Crear y Ejecutar Trabajo de Rastreo -d '{ "name": "Hourly Crawler", "target": "all", - "cronExpression": "0 0 * * * ?", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "jobLogging": "true", + "cron_expression": "0 0 * * * ?", + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 1 + "sort_order": 1 }' # Ejecutar trabajo inmediatamente diff --git a/es/15.9/api/admin/api-admin-suggest.rst b/es/15.9/api/admin/api-admin-suggest.rst index aa0917b57..f35383e2a 100644 --- a/es/15.9/api/admin/api-admin-suggest.rst +++ b/es/15.9/api/admin/api-admin-suggest.rst @@ -77,9 +77,9 @@ Respuesta "version": "15.9.0", "status": 0, "setting": { - "totalWordsNum": 1500, - "documentWordsNum": 1200, - "queryWordsNum": 450 + "total_words_num": 1500, + "document_words_num": 1200, + "query_words_num": 450 } } } @@ -93,18 +93,18 @@ Campos de Respuesta * - Campo - Descripción - * - ``setting.totalWordsNum`` + * - ``setting.total_words_num`` - Número total de palabras de sugerencia (número de palabras de sugerencia registradas en el índice de sugerencias) - * - ``setting.documentWordsNum`` + * - ``setting.document_words_num`` - Número de palabras de sugerencia derivadas de documentos (número de palabras de sugerencia con frecuencia de documento igual o superior a 1) - * - ``setting.queryWordsNum`` + * - ``setting.query_words_num`` - Número de palabras de sugerencia derivadas de consultas de búsqueda (número de palabras de sugerencia con frecuencia de consulta igual o superior a 1) .. note:: - ``documentWordsNum`` y ``queryWordsNum`` no son excluyentes entre si. Si una palabra de sugerencia tiene origen + ``document_words_num`` y ``query_words_num`` no son excluyentes entre si. Si una palabra de sugerencia tiene origen tanto en documentos como en consultas de búsqueda, se incluye en el recuento de ambos. Por este motivo, - la suma de ``documentWordsNum`` y ``queryWordsNum`` puede no coincidir con ``totalWordsNum``. + la suma de ``document_words_num`` y ``query_words_num`` puede no coincidir con ``total_words_num``. Eliminar Todas las Palabras de Sugerencia ========================================= diff --git a/es/15.9/api/admin/api-admin-systeminfo.rst b/es/15.9/api/admin/api-admin-systeminfo.rst index 6b440ec86..78d7802d0 100644 --- a/es/15.9/api/admin/api-admin-systeminfo.rst +++ b/es/15.9/api/admin/api-admin-systeminfo.rst @@ -55,22 +55,22 @@ La respuesta incluye ``version``, que indica la versión del producto, ``status` "response": { "version": "15.9.0", "status": 0, - "envProps": [ + "env_props": [ {"label": "JAVA_HOME", "value": "/usr/lib/jvm/java-21"}, {"label": "FESS_DICTIONARY_PATH", "value": "/var/lib/fess/dict"} ], - "systemProps": [ + "system_props": [ {"label": "java.version", "value": "21.0.1"}, {"label": "java.vendor", "value": "Oracle Corporation"}, {"label": "os.name", "value": "Linux"}, {"label": "user.dir", "value": "/opt/fess"} ], - "fessProps": [ + "fess_props": [ {"label": "crawler.document.max.site.length", "value": "100"}, {"label": "indexer.thread.dump.enabled", "value": "true"}, {"label": "app.cipher.key", "value": "XXXXXXXX"} ], - "bugReportProps": [ + "bug_report_props": [ {"label": "os.name", "value": "Linux"}, {"label": "java.vm.version", "value": "21.0.1+12"} ] @@ -90,24 +90,24 @@ Campos de Respuesta - Versión del producto |Fess| (ejemplo: ``15.9.0``). * - ``status`` - Código que indica el resultado del procesamiento. ``0`` significa finalización exitosa. - * - ``envProps`` + * - ``env_props`` - Lista de variables de entorno (arreglo de ``label`` / ``value``). Se devuelven los valores obtenidos mediante ``System.getenv()`` tal como están. - * - ``systemProps`` + * - ``system_props`` - Lista de propiedades del sistema de Java (arreglo de ``label`` / ``value``). Se devuelven los valores obtenidos mediante ``System.getProperties()`` tal como están. - * - ``fessProps`` + * - ``fess_props`` - Lista de propiedades de configuración de |Fess| (arreglo de ``label`` / ``value``). Incluye los valores de configuración de ``fess_config.properties`` y las propiedades del sistema establecidas desde la pantalla de administración. Los elementos sensibles son enmascarados (véase la nota a continuación). - * - ``bugReportProps`` + * - ``bug_report_props`` - Lista de información recopilada para reportes de errores (arreglo de ``label`` / ``value``). Incluye las principales propiedades del sistema relacionadas con el SO y el entorno de ejecución de Java (``os.name``, ``os.version``, ``java.vm.version``, etc.) y los valores de propiedades del sistema de |Fess|. .. note:: - En ``fessProps``, los siguientes valores de configuración sensibles son enmascarados y se devuelven como ``XXXXXXXX``: + En ``fess_props``, los siguientes valores de configuración sensibles son enmascarados y se devuelven como ``XXXXXXXX``: ``http.proxy.password``, ``ldap.admin.security.credentials``, ``spnego.preauth.password``, ``app.cipher.key``, ``oic.client.id``, ``oic.client.secret``. .. warning:: - ``envProps`` (variables de entorno) y ``systemProps`` (propiedades del sistema de Java) no son enmascarados: + ``env_props`` (variables de entorno) y ``system_props`` (propiedades del sistema de Java) no son enmascarados: los valores configurados se devuelven tal como están. Si las variables de entorno o las propiedades del sistema contienen información confidencial como credenciales, esos valores aparecerán en la respuesta. diff --git a/es/15.9/api/admin/api-admin-user.rst b/es/15.9/api/admin/api-admin-user.rst index ff58e4abf..2ce0463b3 100644 --- a/es/15.9/api/admin/api-admin-user.rst +++ b/es/15.9/api/admin/api-admin-user.rst @@ -105,7 +105,7 @@ Respuesta }, "roles": ["admin"], "groups": [], - "versionNo": 1 + "version_no": 1 } ], "total": 10 @@ -150,7 +150,7 @@ Respuesta }, "roles": ["admin"], "groups": [], - "versionNo": 1 + "version_no": 1 } } } @@ -179,7 +179,7 @@ Cuerpo de la Solicitud { "name": "testuser", "password": "securepassword", - "confirmPassword": "securepassword", + "confirm_password": "securepassword", "attributes": { "surname": "Test", "givenName": "User", @@ -205,7 +205,7 @@ Descripción de Campos * - ``password`` - No - Contraseña - * - ``confirmPassword`` + * - ``confirm_password`` - No - Contraseña de confirmación * - ``attributes`` @@ -220,8 +220,8 @@ Descripción de Campos .. note:: - La API REST no realiza la verificación de contraseña obligatoria, la verificación de coincidencia entre ``password`` y ``confirmPassword``, ni la validación de política de contraseñas (éstas se aplican únicamente en la interfaz de administración). - En la práctica, se recomienda especificar una ``password`` válida cuyo valor coincida con ``confirmPassword``. + La API REST no realiza la verificación de contraseña obligatoria, la verificación de coincidencia entre ``password`` y ``confirm_password``, ni la validación de política de contraseñas (éstas se aplican únicamente en la interfaz de administración). + En la práctica, se recomienda especificar una ``password`` válida cuyo valor coincida con ``confirm_password``. Las claves de ``attributes`` son los nombres de atributos de la entidad de usuario (los nombres de elementos derivados del esquema LDAP). Las claves más comunes son: @@ -276,7 +276,7 @@ Cuerpo de la Solicitud "id": "existing_user_id", "name": "testuser", "password": "newpassword", - "confirmPassword": "newpassword", + "confirm_password": "newpassword", "attributes": { "surname": "Test", "givenName": "User Updated", @@ -284,7 +284,7 @@ Cuerpo de la Solicitud }, "roles": ["user", "editor"], "groups": ["group_id_1", "group_id_2"], - "versionNo": 1 + "version_no": 1 } Descripción de Campos @@ -303,13 +303,13 @@ Descripción de Campos * - ``name`` - Sí - Nombre de usuario (ID de inicio de sesión) - * - ``versionNo`` + * - ``version_no`` - Sí - Número de versión (para bloqueo optimista) * - ``password`` - No - Nueva contraseña (se actualiza solo cuando se especifica) - * - ``confirmPassword`` + * - ``confirm_password`` - No - Contraseña de confirmación * - ``attributes`` @@ -324,8 +324,8 @@ Descripción de Campos .. note:: - En la actualización, ``id``, ``name`` y ``versionNo`` son obligatorios. - ``versionNo`` es el valor devuelto al obtener el usuario objetivo (GET), y corresponde a la versión del documento de OpenSearch. + En la actualización, ``id``, ``name`` y ``version_no`` son obligatorios. + ``version_no`` es el valor devuelto al obtener el usuario objetivo (GET), y corresponde a la versión del documento de OpenSearch. Si no coincide con la versión actual, la solicitud se trata como un conflicto y la actualización es rechazada. Respuesta @@ -390,7 +390,7 @@ Crear Nuevo Usuario -d '{ "name": "john.doe", "password": "SecureP@ss123", - "confirmPassword": "SecureP@ss123", + "confirm_password": "SecureP@ss123", "attributes": { "surname": "Doe", "givenName": "John", @@ -412,7 +412,7 @@ Cambiar Roles de Usuario "id": "user_id_123", "name": "john.doe", "roles": ["user", "editor", "admin"], - "versionNo": 1 + "version_no": 1 }' Referencia diff --git a/es/15.9/api/admin/api-admin-webconfig.rst b/es/15.9/api/admin/api-admin-webconfig.rst index e43014ed1..ed9d72f76 100644 --- a/es/15.9/api/admin/api-admin-webconfig.rst +++ b/es/15.9/api/admin/api-admin-webconfig.rst @@ -106,21 +106,21 @@ Respuesta "name": "Example Site", "description": "Sitio de ejemplo", "urls": "https://example.com/", - "includedUrls": ".*example\\.com.*", - "excludedUrls": ".*\\.(pdf|zip)$", - "includedDocUrls": "", - "excludedDocUrls": "", - "configParameter": "", + "included_urls": ".*example\\.com.*", + "excluded_urls": ".*\\.(pdf|zip)$", + "included_doc_urls": "", + "excluded_doc_urls": "", + "config_parameter": "", "depth": 3, - "maxAccessCount": 1000, - "userAgent": "Mozilla/5.0", - "numOfThread": 1, - "intervalTime": 1000, + "max_access_count": 1000, + "user_agent": "Mozilla/5.0", + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, "available": "true", "permissions": "{role}admin", - "virtualHosts": "", - "sortOrder": 0 + "virtual_hosts": "", + "sort_order": 0 } ], "total": 5 @@ -152,36 +152,36 @@ Respuesta "name": "Example Site", "description": "Sitio de ejemplo", "urls": "https://example.com/", - "includedUrls": ".*example\\.com.*", - "excludedUrls": ".*\\.(pdf|zip)$", - "includedDocUrls": "", - "excludedDocUrls": "", - "configParameter": "", + "included_urls": ".*example\\.com.*", + "excluded_urls": ".*\\.(pdf|zip)$", + "included_doc_urls": "", + "excluded_doc_urls": "", + "config_parameter": "", "depth": 3, - "maxAccessCount": 1000, - "userAgent": "Mozilla/5.0", - "numOfThread": 1, - "intervalTime": 1000, + "max_access_count": 1000, + "user_agent": "Mozilla/5.0", + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin", - "virtualHosts": "", - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_hosts": "", + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } .. note:: - La respuesta incluye los campos de auditoría ``createdBy``, ``createdTime``, - ``updatedBy``, ``updatedTime`` y ``versionNo``, que son asignados automáticamente + La respuesta incluye los campos de auditoría ``created_by``, ``created_time``, + ``updated_by``, ``updated_time`` y ``version_no``, que son asignados automáticamente en el momento del registro o la actualización. - ``versionNo`` es obligatorio al actualizar (consulte la sección "Actualizar configuración de rastreo web" a continuación). + ``version_no`` es obligatorio al actualizar (consulte la sección "Actualizar configuración de rastreo web" a continuación). Crear Configuración de Rastreo Web =================================== @@ -202,14 +202,14 @@ Cuerpo de la Solicitud { "name": "Corporate Site", "urls": "https://www.example.com/", - "includedUrls": ".*www\\.example\\.com.*", - "excludedUrls": ".*\\.(pdf|zip|exe)$", - "userAgent": "Mozilla/5.0", - "numOfThread": 3, - "intervalTime": 500, + "included_urls": ".*www\\.example\\.com.*", + "excluded_urls": ".*\\.(pdf|zip|exe)$", + "user_agent": "Mozilla/5.0", + "num_of_thread": 3, + "interval_time": 500, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin\n{role}user" } @@ -232,34 +232,34 @@ Descripción de Campos * - ``urls`` - Sí - URL de inicio de rastreo (separadas por salto de línea si son múltiples). Se especifica con ``http:`` o ``https:`` - * - ``includedUrls`` + * - ``included_urls`` - No - Patrón de expresión regular para URLs a rastrear - * - ``excludedUrls`` + * - ``excluded_urls`` - No - Patrón de expresión regular para URLs a excluir del rastreo - * - ``includedDocUrls`` + * - ``included_doc_urls`` - No - Patrón de expresión regular para URLs a indexar - * - ``excludedDocUrls`` + * - ``excluded_doc_urls`` - No - Patrón de expresión regular para URLs a excluir del índice - * - ``configParameter`` + * - ``config_parameter`` - No - Parámetros de configuración adicionales (formato ``key=value``, un elemento por línea) * - ``depth`` - No - Profundidad de rastreo (0 o más) - * - ``maxAccessCount`` + * - ``max_access_count`` - No - Número máximo de accesos (0 o más) - * - ``userAgent`` + * - ``user_agent`` - Sí - Cadena User-Agent (máximo 200 caracteres) - * - ``numOfThread`` + * - ``num_of_thread`` - Sí - Número de hilos paralelos (1 o más) - * - ``intervalTime`` + * - ``interval_time`` - Sí - Intervalo de acceso (milisegundos, 0 o más) * - ``boost`` @@ -268,19 +268,19 @@ Descripción de Campos * - ``available`` - Sí - Habilitado/Deshabilitado (cadena ``"true"`` / ``"false"``) - * - ``sortOrder`` + * - ``sort_order`` - Sí - Orden de visualización (0 o más) * - ``permissions`` - No - Roles con permiso de acceso (separados por saltos de línea si son varios) - * - ``virtualHosts`` + * - ``virtual_hosts`` - No - Hosts virtuales (separados por saltos de línea si son varios) .. note:: - Los campos de auditoría como ``createdBy``, ``createdTime``, ``updatedBy`` y ``updatedTime`` + Los campos de auditoría como ``created_by``, ``created_time``, ``updated_by`` y ``updated_time`` son asignados automáticamente por el servidor, por lo que no es necesario incluirlos en el cuerpo de la solicitud. Respuesta @@ -311,8 +311,8 @@ Cuerpo de la Solicitud ~~~~~~~~~~~~~~~~~~~~~~ Al actualizar, además de los campos de creación, son obligatorios ``id`` para identificar -el registro a actualizar y ``versionNo`` como número de versión. -En ``versionNo`` se debe especificar el valor actual incluido en la respuesta de la API de consulta (GET). +el registro a actualizar y ``version_no`` como número de versión. +En ``version_no`` se debe especificar el valor actual incluido en la respuesta de la API de consulta (GET). .. code-block:: json @@ -320,17 +320,17 @@ En ``versionNo`` se debe especificar el valor actual incluido en la respuesta de "id": "existing_webconfig_id", "name": "Updated Corporate Site", "urls": "https://www.example.com/", - "includedUrls": ".*www\\.example\\.com.*", - "excludedUrls": ".*\\.(pdf|zip|exe|dmg)$", - "userAgent": "Mozilla/5.0", + "included_urls": ".*www\\.example\\.com.*", + "excluded_urls": ".*\\.(pdf|zip|exe|dmg)$", + "user_agent": "Mozilla/5.0", "depth": 10, - "maxAccessCount": 10000, - "numOfThread": 5, - "intervalTime": 300, + "max_access_count": 10000, + "num_of_thread": 5, + "interval_time": 300, "boost": 1.2, "available": "true", - "sortOrder": 0, - "versionNo": 1 + "sort_order": 0, + "version_no": 1 } Campos Adicionales para la Actualización @@ -346,9 +346,9 @@ Campos Adicionales para la Actualización * - ``id`` - Sí - ID de la configuración a actualizar (máximo 1000 caracteres) - * - ``versionNo`` + * - ``version_no`` - Sí - - Número de versión actual del registro a actualizar. Se especifica el valor de ``versionNo`` incluido en la respuesta de la API de consulta (GET) + - Número de versión actual del registro a actualizar. Se especifica el valor de ``version_no`` incluido en la respuesta de la API de consulta (GET) Respuesta --------- @@ -387,7 +387,7 @@ Respuesta Ejemplos de Patrones de URL ============================ -En ``includedUrls`` / ``excludedUrls`` / ``includedDocUrls`` / ``excludedDocUrls`` se utilizan expresiones regulares. +En ``included_urls`` / ``excluded_urls`` / ``included_doc_urls`` / ``excluded_doc_urls`` se utilizan expresiones regulares. .. list-table:: :header-rows: 1 @@ -420,16 +420,16 @@ Configuración de Rastreo de Sitio Corporativo -d '{ "name": "Corporate Website", "urls": "https://www.example.com/", - "includedUrls": ".*www\\.example\\.com.*", - "excludedUrls": ".*/(login|admin|api)/.*", - "userAgent": "Mozilla/5.0", + "included_urls": ".*www\\.example\\.com.*", + "excluded_urls": ".*/(login|admin|api)/.*", + "user_agent": "Mozilla/5.0", "depth": 5, - "maxAccessCount": 10000, - "numOfThread": 3, - "intervalTime": 500, + "max_access_count": 10000, + "num_of_thread": 3, + "interval_time": 500, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}guest" }' @@ -444,15 +444,15 @@ Configuración de Rastreo de Sitio de Documentación -d '{ "name": "Documentation Site", "urls": "https://docs.example.com/", - "includedUrls": ".*docs\\.example\\.com.*", - "includedDocUrls": ".*\\.(html|htm)$", - "userAgent": "Mozilla/5.0", - "maxAccessCount": 50000, - "numOfThread": 5, - "intervalTime": 200, + "included_urls": ".*docs\\.example\\.com.*", + "included_doc_urls": ".*\\.(html|htm)$", + "user_agent": "Mozilla/5.0", + "max_access_count": 50000, + "num_of_thread": 5, + "interval_time": 200, "boost": 1.5, "available": "true", - "sortOrder": 0 + "sort_order": 0 }' Información de Referencia diff --git a/fr/15.9/api/admin/api-admin-accesstoken.rst b/fr/15.9/api/admin/api-admin-accesstoken.rst index cfc1ee2f3..f308658c5 100644 --- a/fr/15.9/api/admin/api-admin-accesstoken.rst +++ b/fr/15.9/api/admin/api-admin-accesstoken.rst @@ -99,14 +99,14 @@ Réponse "id": "token_id_1", "name": "API Token 1", "token": "abcd1234efgh5678", - "parameterName": "permission", + "parameter_name": "permission", "permissions": "{role}admin-api", "expires": "2026-01-01T00:00:00", - "createdBy": "admin", - "createdTime": 1735689600000, - "updatedBy": "admin", - "updatedTime": 1735689600000, - "versionNo": 1 + "created_by": "admin", + "created_time": 1735689600000, + "updated_by": "admin", + "updated_time": 1735689600000, + "version_no": 1 } ], "total": 5 @@ -116,9 +116,9 @@ Réponse .. note:: Chaque objet jeton contient également des informations d'audit et de version telles que - ``createdBy``, ``createdTime``, ``updatedBy``, - ``updatedTime`` et ``versionNo``. - ``createdTime`` et ``updatedTime`` sont exprimés en millisecondes depuis l'epoch (valeur numérique). + ``created_by``, ``created_time``, ``updated_by``, + ``updated_time`` et ``version_no``. + ``created_time`` et ``updated_time`` sont exprimés en millisecondes depuis l'epoch (valeur numérique). Les champs dont la valeur est ``null`` sont exclus de la réponse. ``permissions`` est retourné sous forme de chaîne séparée par des sauts de ligne (``\n``). @@ -144,14 +144,14 @@ Réponse "id": "token_id_1", "name": "API Token 1", "token": "abcd1234efgh5678", - "parameterName": "permission", + "parameter_name": "permission", "permissions": "{role}admin-api", "expires": "2026-01-01T00:00:00", - "createdBy": "admin", - "createdTime": 1735689600000, - "updatedBy": "admin", - "updatedTime": 1735689600000, - "versionNo": 1 + "created_by": "admin", + "created_time": 1735689600000, + "updated_by": "admin", + "updated_time": 1735689600000, + "version_no": 1 } } } @@ -194,7 +194,7 @@ Description des champs * - ``permissions`` - Non - Permissions accordées à ce jeton. Plusieurs permissions peuvent être spécifiées en les séparant par des sauts de ligne (``\n``) (exemple : ``{role}admin-api``). Pour les jetons appelant l'API Admin, une permission correspondant à ``api.admin.access.permissions`` (valeur par défaut : ``{role}admin-api``) est requise. - * - ``parameterName`` + * - ``parameter_name`` - Non - Nom du paramètre de requête permettant de transmettre des permissions supplémentaires. Si une requête authentifiée par ce jeton contient un paramètre portant ce nom, sa valeur est ajoutée aux ``permissions``. Si omis, aucun paramètre n'est configuré. * - ``expires`` @@ -241,7 +241,7 @@ Corps de la requête "name": "Updated API Token", "permissions": "{role}admin-api\n{role}user", "expires": "2026-01-01T00:00:00", - "versionNo": 1 + "version_no": 1 } Description des champs @@ -259,9 +259,9 @@ En plus des champs utilisés lors de la création, les champs suivants sont empl * - ``id`` - Oui - ID du jeton à mettre à jour - * - ``versionNo`` + * - ``version_no`` - Oui - - Numéro de version pour le verrouillage optimiste. Spécifiez le ``versionNo`` du jeton obtenu au préalable. + - Numéro de version pour le verrouillage optimiste. Spécifiez le ``version_no`` du jeton obtenu au préalable. .. note:: diff --git a/fr/15.9/api/admin/api-admin-badword.rst b/fr/15.9/api/admin/api-admin-badword.rst index 0b0da4cc7..a76045535 100644 --- a/fr/15.9/api/admin/api-admin-badword.rst +++ b/fr/15.9/api/admin/api-admin-badword.rst @@ -92,7 +92,7 @@ Réponse "settings": [ { "id": "badword_id_1", - "suggestWord": "inappropriate_word" + "suggest_word": "inappropriate_word" } ], "total": 5 @@ -119,7 +119,7 @@ Réponse "status": 0, "setting": { "id": "badword_id_1", - "suggestWord": "inappropriate_word" + "suggest_word": "inappropriate_word" } } } @@ -141,7 +141,7 @@ Corps de la requête .. code-block:: json { - "suggestWord": "spam_keyword" + "suggest_word": "spam_keyword" } Description des champs @@ -154,7 +154,7 @@ Description des champs * - Champ - Requis - Description - * - ``suggestWord`` + * - ``suggest_word`` - Oui - Mot-clé à exclure (ne peut pas contenir d'espaces) @@ -189,8 +189,8 @@ Corps de la requête { "id": "existing_badword_id", - "suggestWord": "updated_spam_keyword", - "versionNo": 1 + "suggest_word": "updated_spam_keyword", + "version_no": 1 } Réponse @@ -260,7 +260,7 @@ Format CSV ~~~~~~~~~~ - La première ligne est ignorée en tant que ligne d'en-tête (le nom de colonne est arbitraire ; ``BadWord`` est écrit lors du téléchargement). -- À partir de la deuxième ligne, écrivez un mot interdit par ligne en tant que ``suggestWord``. +- À partir de la deuxième ligne, écrivez un mot interdit par ligne en tant que ``suggest_word``. - Les lignes dont la valeur est vide sont ignorées. - Préfixez un mot par ``--`` pour le supprimer (par exemple, ``--spam`` supprime ``spam``). - Spécifier un mot déjà enregistré est traité comme une mise à jour (l'auteur et la date de mise à jour sont réinitialisés). @@ -306,7 +306,7 @@ Exclusion d'un mot-clé spam -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "suggestWord": "spam" + "suggest_word": "spam" }' Téléversement d'un fichier CSV diff --git a/fr/15.9/api/admin/api-admin-boostdoc.rst b/fr/15.9/api/admin/api-admin-boostdoc.rst index 16cfd448a..0a8cf6d0b 100644 --- a/fr/15.9/api/admin/api-admin-boostdoc.rst +++ b/fr/15.9/api/admin/api-admin-boostdoc.rst @@ -10,20 +10,20 @@ En configurant le boost de documents, vous pouvez augmenter le score des documen et les faire apparaître plus haut dans les résultats de recherche. Le boost est appliqué à chaque document lors de la création de l'index (au moment du crawl). -La condition (``urlExpr``) et la valeur de boost (``boostExpr``) sont toutes deux évaluées avec le moteur de -script indiqué dans le champ ``scriptType``. ``scriptType`` peut valoir ``javascript`` ou ``groovy`` (qui +La condition (``url_expr``) et la valeur de boost (``boost_expr``) sont toutes deux évaluées avec le moteur de +script indiqué dans le champ ``script_type``. ``script_type`` peut valoir ``javascript`` ou ``groovy`` (qui nécessite le plugin ``fess-script-groovy``). L'écran de création de l'interface d'administration préremplit -``scriptType`` avec ``javascript``, mais si cette API omet ``scriptType`` dans le corps de la requête, il n'est +``script_type`` avec ``javascript``, mais si cette API omet ``script_type`` dans le corps de la requête, il n'est pas prérempli automatiquement et les expressions sont évaluées en tant que Groovy. -Les règles multiples sont évaluées dans l'ordre croissant de ``sortOrder``, et seule la valeur de boost de la première règle +Les règles multiples sont évaluées dans l'ordre croissant de ``sort_order``, et seule la valeur de boost de la première règle dont la condition correspond est appliquée (une fois qu'une règle correspondante est trouvée, les règles suivantes ne sont pas évaluées). .. note:: - Dans l'interface d'administration, ``urlExpr`` est affiché sous le nom « Condition », ``boostExpr`` sous le - nom « Expression de valeur de boost » et ``scriptType`` sous le nom « Type de Script ». ``scriptType`` + Dans l'interface d'administration, ``url_expr`` est affiché sous le nom « Condition », ``boost_expr`` sous le + nom « Expression de valeur de boost » et ``script_type`` sous le nom « Type de Script ». ``script_type`` n'apparaît que dans les corps de requête et les réponses de création/mise à jour/obtention (liste et détail), - pas dans les paramètres de filtre de la liste (``urlExpr``, ``boostExpr``). + pas dans les paramètres de filtre de la liste (``url_expr``, ``boost_expr``). Pour plus de détails sur les éléments de configuration, consultez :doc:`../../admin/boostdoc-guide`. URL de base @@ -94,11 +94,11 @@ Paramètres - Integer - Non - Numéro de page (commence à 1. Par défaut : 1) - * - ``urlExpr`` + * - ``url_expr`` - String - Non - Filtrage par expression de condition (correspondance partielle) - * - ``boostExpr`` + * - ``boost_expr`` - String - Non - Filtrage par expression de valeur de boost (correspondance partielle) @@ -114,11 +114,11 @@ Réponse "settings": [ { "id": "boostdoc_id_1", - "urlExpr": "url.startsWith(\"https://docs.example.com/\")", - "boostExpr": "3.0", - "scriptType": "javascript", - "sortOrder": 1, - "versionNo": 1 + "url_expr": "url.startsWith(\"https://docs.example.com/\")", + "boost_expr": "3.0", + "script_type": "javascript", + "sort_order": 1, + "version_no": 1 } ], "total": 5 @@ -127,8 +127,8 @@ Réponse .. note:: - En plus des champs présentés ci-dessus, chaque objet de configuration dans la réponse inclut également des métadonnées de création/mise à jour (``createdBy``, ``createdTime``, ``updatedBy``, ``updatedTime``). - ``versionNo`` est obligatoire lors d'une mise à jour (PUT) ; récupérez sa valeur actuelle via l'API d'obtention ou de liste avant de procéder à la mise à jour. + En plus des champs présentés ci-dessus, chaque objet de configuration dans la réponse inclut également des métadonnées de création/mise à jour (``created_by``, ``created_time``, ``updated_by``, ``updated_time``). + ``version_no`` est obligatoire lors d'une mise à jour (PUT) ; récupérez sa valeur actuelle via l'API d'obtention ou de liste avant de procéder à la mise à jour. Obtention d'un boost de document ================================== @@ -150,11 +150,11 @@ Réponse "status": 0, "setting": { "id": "boostdoc_id_1", - "urlExpr": "url.startsWith(\"https://docs.example.com/\")", - "boostExpr": "3.0", - "scriptType": "javascript", - "sortOrder": 1, - "versionNo": 1 + "url_expr": "url.startsWith(\"https://docs.example.com/\")", + "boost_expr": "3.0", + "script_type": "javascript", + "sort_order": 1, + "version_no": 1 } } } @@ -176,10 +176,10 @@ Corps de la requête .. code-block:: json { - "urlExpr": "url.startsWith(\"https://important.example.com/\")", - "boostExpr": "5.0", - "scriptType": "javascript", - "sortOrder": 0 + "url_expr": "url.startsWith(\"https://important.example.com/\")", + "boost_expr": "5.0", + "script_type": "javascript", + "sort_order": 0 } Description des champs @@ -192,16 +192,16 @@ Description des champs * - Champ - Requis - Description - * - ``urlExpr`` + * - ``url_expr`` - Oui - Expression de condition. Expression de script retournant un ``Boolean`` permettant de déterminer les documents à booster. Correspond au champ « Condition » de l'interface d'administration (maximum 10000 caractères). - * - ``boostExpr`` + * - ``boost_expr`` - Oui - Expression de valeur de boost. Expression de script retournant la valeur de boost (numérique). Une valeur fixe telle que ``3.0`` peut également être spécifiée. Correspond au champ « Expression de valeur de boost » de l'interface d'administration (maximum 10000 caractères). - * - ``scriptType`` + * - ``script_type`` - Non - - Moteur de script utilisé pour évaluer ``urlExpr`` et ``boostExpr``. ``javascript`` ou ``groovy`` (nécessite le plugin ``fess-script-groovy``). Correspond au champ « Type de Script » de l'interface d'administration (maximum 100 caractères). Si omis, les expressions sont évaluées en tant que Groovy. - * - ``sortOrder`` + - Moteur de script utilisé pour évaluer ``url_expr`` et ``boost_expr``. ``javascript`` ou ``groovy`` (nécessite le plugin ``fess-script-groovy``). Correspond au champ « Type de Script » de l'interface d'administration (maximum 100 caractères). Si omis, les expressions sont évaluées en tant que Groovy. + * - ``sort_order`` - Oui - Ordre d'application. Les règles sont évaluées dans l'ordre croissant et la valeur de boost de la première règle correspondante est appliquée (valeur initiale du formulaire : 0, entier supérieur ou égal à 0). @@ -236,14 +236,14 @@ Corps de la requête { "id": "existing_boostdoc_id", - "urlExpr": "url.startsWith(\"https://important.example.com/\")", - "boostExpr": "10.0", - "scriptType": "javascript", - "sortOrder": 0, - "versionNo": 1 + "url_expr": "url.startsWith(\"https://important.example.com/\")", + "boost_expr": "10.0", + "script_type": "javascript", + "sort_order": 0, + "version_no": 1 } -Lors de la mise à jour, en plus des champs utilisés lors de la création, ``id`` (l'identifiant de la règle cible, 1000 caractères maximum) et ``versionNo`` (le numéro de version pour le verrouillage optimiste) sont obligatoires. Spécifiez pour ``versionNo`` la valeur actuelle obtenue depuis la réponse de l'API d'obtention ou de liste. La mise à jour échoue si le numéro de version ne correspond pas. +Lors de la mise à jour, en plus des champs utilisés lors de la création, ``id`` (l'identifiant de la règle cible, 1000 caractères maximum) et ``version_no`` (le numéro de version pour le verrouillage optimiste) sont obligatoires. Spécifiez pour ``version_no`` la valeur actuelle obtenue depuis la réponse de l'API d'obtention ou de liste. La mise à jour échoue si le numéro de version ne correspond pas. Réponse ------- @@ -282,13 +282,13 @@ Réponse Expressions de condition et de valeur de boost =============================================== -``urlExpr`` (condition) et ``boostExpr`` (expression de valeur de boost) sont toutes deux évaluées avec le -moteur de script indiqué par ``scriptType`` (valeur par défaut : Groovy ; seul l'écran de création de +``url_expr`` (condition) et ``boost_expr`` (expression de valeur de boost) sont toutes deux évaluées avec le +moteur de script indiqué par ``script_type`` (valeur par défaut : Groovy ; seul l'écran de création de l'interface d'administration préremplit ``javascript``). Dans les expressions, les valeurs des champs du document cible de l'indexation peuvent être référencées comme des variables portant le nom du champ. -- ``urlExpr`` doit retourner un ``Boolean`` (exemple : ``url.startsWith("https://docs.example.com/")``). Une simple chaîne d'expression régulière (exemple : ``.*docs\.example\.com.*``) ne retourne pas un ``Boolean`` en tant qu'expression de script et ne fonctionne donc pas comme condition. Pour utiliser des expressions régulières, utilisez ``String#matches`` (disponible avec la même notation en Groovy comme en JavaScript). -- ``boostExpr`` doit retourner une valeur numérique. Le résultat est converti en ``float`` et le boost n'est appliqué que si la valeur est supérieure à 0. +- ``url_expr`` doit retourner un ``Boolean`` (exemple : ``url.startsWith("https://docs.example.com/")``). Une simple chaîne d'expression régulière (exemple : ``.*docs\.example\.com.*``) ne retourne pas un ``Boolean`` en tant qu'expression de script et ne fonctionne donc pas comme condition. Pour utiliser des expressions régulières, utilisez ``String#matches`` (disponible avec la même notation en Groovy comme en JavaScript). +- ``boost_expr`` doit retourner une valeur numérique. Le résultat est converti en ``float`` et le boost n'est appliqué que si la valeur est supérieure à 0. .. note:: @@ -297,7 +297,7 @@ Dans les expressions, les valeurs des champs du document cible de l'indexation p ``indexer.favorite.count.enabled`` sont activés (toutes deux activées par défaut). La syntaxe de calcul de date OpenSearch telle que ``now - 7d`` ne peut être utilisée ni en Groovy ni en JavaScript. -Exemples d'expressions de condition (``urlExpr``) +Exemples d'expressions de condition (``url_expr``) -------------------------------------------------- .. list-table:: @@ -313,7 +313,7 @@ Exemples d'expressions de condition (``urlExpr``) * - ``title.contains("Notes de version")`` - Cible les documents dont le titre contient un mot spécifique -Exemples d'expressions de valeur de boost (``boostExpr``) +Exemples d'expressions de valeur de boost (``boost_expr``) ---------------------------------------------------------- .. list-table:: @@ -341,9 +341,9 @@ Boost d'un site de documentation -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "urlExpr": "url.startsWith(\"https://docs.example.com/\")", - "boostExpr": "5.0", - "sortOrder": 0 + "url_expr": "url.startsWith(\"https://docs.example.com/\")", + "boost_expr": "5.0", + "sort_order": 0 }' Boost de contenu populaire @@ -355,9 +355,9 @@ Boost de contenu populaire -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "urlExpr": "url.startsWith(\"https://www.example.com/\")", - "boostExpr": "click_count * 0.1 + 1", - "sortOrder": 10 + "url_expr": "url.startsWith(\"https://www.example.com/\")", + "boost_expr": "click_count * 0.1 + 1", + "sort_order": 10 }' Informations complémentaires diff --git a/fr/15.9/api/admin/api-admin-crawlinginfo.rst b/fr/15.9/api/admin/api-admin-crawlinginfo.rst index 499cb6d2f..a4ee51794 100644 --- a/fr/15.9/api/admin/api-admin-crawlinginfo.rst +++ b/fr/15.9/api/admin/api-admin-crawlinginfo.rst @@ -67,7 +67,7 @@ Paramètres - Integer - Non - Numéro de page (base 1, défaut : 1) - * - ``sessionId`` + * - ``session_id`` - String - Non - Filtre par ID de session (correspondance partielle) @@ -83,17 +83,17 @@ Réponse "logs": [ { "id": "crawling_info_id_1", - "sessionId": "20250129100000", + "session_id": "20250129100000", "name": "Default Crawler", - "expiredTime": "1738200000000", - "createdTime": 1738108800000 + "expired_time": "1738200000000", + "created_time": 1738108800000 }, { "id": "crawling_info_id_2", - "sessionId": "20250128100000", + "session_id": "20250128100000", "name": "Default Crawler", - "expiredTime": "1738113600000", - "createdTime": 1738022400000 + "expired_time": "1738113600000", + "created_time": 1738022400000 } ], "total": 10 @@ -111,18 +111,18 @@ Champs de la réponse - Description * - ``id`` - ID de l'information de crawl - * - ``sessionId`` + * - ``session_id`` - ID de la session * - ``name`` - Nom de la session - * - ``expiredTime`` + * - ``expired_time`` - Date d'expiration (millisecondes epoch ; retournée sous forme de chaîne) - * - ``createdTime`` + * - ``created_time`` - Heure de création (millisecondes epoch ; retournée sous forme de nombre) .. note:: - Chaque objet de journal dans la réponse inclut également un champ interne ``crudMode`` + Chaque objet de journal dans la réponse inclut également un champ interne ``crud_mode`` (un entier indiquant le mode d'opération CRUD, toujours ``0`` pour les opérations de lecture). Les clients peuvent l'ignorer en toute sécurité. @@ -146,10 +146,10 @@ Réponse "status": 0, "log": { "id": "crawling_info_id_1", - "sessionId": "20250129100000", + "session_id": "20250129100000", "name": "Default Crawler", - "expiredTime": "1738200000000", - "createdTime": 1738108800000 + "expired_time": "1738200000000", + "created_time": 1738108800000 } } } diff --git a/fr/15.9/api/admin/api-admin-dataconfig.rst b/fr/15.9/api/admin/api-admin-dataconfig.rst index 282a29a8d..a2a7f42c7 100644 --- a/fr/15.9/api/admin/api-admin-dataconfig.rst +++ b/fr/15.9/api/admin/api-admin-dataconfig.rst @@ -74,7 +74,7 @@ Paramètres - String - Non - Filtrer par nom de configuration - * - ``handlerName`` + * - ``handler_name`` - String - Non - Filtrer par nom de gestionnaire @@ -96,14 +96,14 @@ Réponse "id": "dataconfig_id_1", "name": "Database Crawler", "description": "Crawler de base de données", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/mydb", - "handlerScript": "...", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/mydb", + "handler_script": "...", "boost": 1.0, "available": "true", "permissions": "{role}admin", - "virtualHosts": "", - "sortOrder": 0 + "virtual_hosts": "", + "sort_order": 0 } ], "total": 5 @@ -132,14 +132,14 @@ Réponse "id": "dataconfig_id_1", "name": "Database Crawler", "description": "Crawler de base de données", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/mydb\nusername=dbuser\npassword=dbpass", - "handlerScript": "...", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/mydb\nusername=dbuser\npassword=dbpass", + "handler_script": "...", "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin", - "virtualHosts": "" + "virtual_hosts": "" } } } @@ -162,12 +162,12 @@ Corps de la requête { "name": "Product Database", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/products\nusername=user\npassword=pass", - "handlerScript": "url=\"https://example.com/product/\" + product_id\ntitle=product_name\ncontent=description", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/products\nusername=user\npassword=pass", + "handler_script": "url=\"https://example.com/product/\" + product_id\ntitle=product_name\ncontent=description", "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin\n{role}user" } @@ -187,13 +187,13 @@ Description des champs * - ``description`` - Non - Description de la configuration - * - ``handlerName`` + * - ``handler_name`` - Oui - Nom du gestionnaire de datastore - * - ``handlerParameter`` + * - ``handler_parameter`` - Non - Paramètres du gestionnaire (informations de connexion, etc.) - * - ``handlerScript`` + * - ``handler_script`` - Non - Script de transformation des données * - ``boost`` @@ -202,13 +202,13 @@ Description des champs * - ``available`` - Oui - Activé/Désactivé (chaîne ``"true"`` / ``"false"``) - * - ``sortOrder`` + * - ``sort_order`` - Oui - Ordre d'affichage * - ``permissions`` - Non - Rôles autorisés (séparés par des sauts de ligne si plusieurs) - * - ``virtualHosts`` + * - ``virtual_hosts`` - Non - Hôtes virtuels (séparés par des sauts de ligne si plusieurs) @@ -244,16 +244,16 @@ Corps de la requête { "id": "existing_dataconfig_id", "name": "Updated Product Database", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/products\nusername=user\npassword=newpass", - "handlerScript": "url=\"https://example.com/product/\" + product_id\ntitle=product_name\ncontent=description + \" \" + features", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/products\nusername=user\npassword=newpass", + "handler_script": "url=\"https://example.com/product/\" + product_id\ntitle=product_name\ncontent=description + \" \" + features", "boost": 1.5, "available": "true", - "sortOrder": 0, - "versionNo": 1 + "sort_order": 0, + "version_no": 1 } -Les requêtes de mise a jour nécessitent les mêmes champs obligatoires que la création (``name``, ``handlerName``, ``boost``, ``available``, ``sortOrder``), ainsi que les champs suivants : +Les requêtes de mise a jour nécessitent les mêmes champs obligatoires que la création (``name``, ``handler_name``, ``boost``, ``available``, ``sort_order``), ainsi que les champs suivants : .. list-table:: :header-rows: 1 @@ -265,7 +265,7 @@ Les requêtes de mise a jour nécessitent les mêmes champs obligatoires que la * - ``id`` - Oui - ID de la configuration à mettre à jour - * - ``versionNo`` + * - ``version_no`` - Oui - Numéro de version pour le verrouillage optimiste (indiquer la valeur obtenue lors de la récupération du paramètre) @@ -340,12 +340,12 @@ Configuration de crawl de base de données -H "Content-Type: application/json" \ -d '{ "name": "User Database", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/userdb\nusername=dbuser\npassword=dbpass\nsql=SELECT * FROM users WHERE active=true", - "handlerScript": "url=\"https://example.com/user/\" + user_id\ntitle=username\ncontent=profile", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/userdb\nusername=dbuser\npassword=dbpass\nsql=SELECT * FROM users WHERE active=true", + "handler_script": "url=\"https://example.com/user/\" + user_id\ntitle=username\ncontent=profile", "boost": 1.0, "available": "true", - "sortOrder": 0 + "sort_order": 0 }' Informations complémentaires diff --git a/fr/15.9/api/admin/api-admin-dict.rst b/fr/15.9/api/admin/api-admin-dict.rst index c2ef4638d..07a4aec60 100644 --- a/fr/15.9/api/admin/api-admin-dict.rst +++ b/fr/15.9/api/admin/api-admin-dict.rst @@ -178,7 +178,7 @@ Les champs de chaque élément du tableau ``settings`` de la réponse varient se "settings": [ { "id": 1, - "dictId": "ZjA5...synonym.txt", + "dict_id": "ZjA5...synonym.txt", "inputs": "検索,サーチ", "outputs": "検索,サーチ,リサーチ" } @@ -232,7 +232,7 @@ Réponse "status": 0, "setting": { "id": 1, - "dictId": "ZjA5...synonym.txt", + "dict_id": "ZjA5...synonym.txt", "inputs": "検索,サーチ", "outputs": "検索,サーチ,リサーチ" } @@ -405,7 +405,7 @@ Champs des entrées par type de dictionnaire =========================================== Les champs du corps de requête de création/mise à jour d'une entrée de dictionnaire ainsi que ceux de la réponse varient selon le type de dictionnaire. -``id`` (ID de l'entrée) et ``dictId`` (ID du dictionnaire) sont inclus de manière commune dans la réponse. +``id`` (ID de l'entrée) et ``dict_id`` (ID du dictionnaire) sont inclus de manière commune dans la réponse. .. list-table:: :header-rows: 1 diff --git a/fr/15.9/api/admin/api-admin-elevateword.rst b/fr/15.9/api/admin/api-admin-elevateword.rst index 393d35ebb..759001e61 100644 --- a/fr/15.9/api/admin/api-admin-elevateword.rst +++ b/fr/15.9/api/admin/api-admin-elevateword.rst @@ -92,11 +92,11 @@ Réponse "settings": [ { "id": "elevate_id_1", - "suggestWord": "fess", + "suggest_word": "fess", "reading": "", "permissions": "{role}guest", "boost": 100.0, - "labelTypeIds": [] + "label_type_ids": [] } ], "total": 5 @@ -123,11 +123,11 @@ Réponse "status": 0, "setting": { "id": "elevate_id_1", - "suggestWord": "fess", + "suggest_word": "fess", "reading": "", "permissions": "{role}guest", "boost": 100.0, - "labelTypeIds": [] + "label_type_ids": [] } } } @@ -149,11 +149,11 @@ Corps de la requête .. code-block:: json { - "suggestWord": "documentation", + "suggest_word": "documentation", "reading": "", "permissions": "{role}guest", "boost": 100.0, - "labelTypeIds": ["label1"] + "label_type_ids": ["label1"] } Description des champs @@ -166,7 +166,7 @@ Description des champs * - Champ - Requis - Description - * - ``suggestWord`` + * - ``suggest_word`` - Oui - Mot-clé à élever * - ``reading`` @@ -178,7 +178,7 @@ Description des champs * - ``boost`` - Oui - Valeur de boost (valeur initiale du formulaire : 100.0) - * - ``labelTypeIds`` + * - ``label_type_ids`` - Non - ID des labels cibles (tableau de chaînes) @@ -213,12 +213,12 @@ Corps de la requête { "id": "existing_elevate_id", - "suggestWord": "documentation", + "suggest_word": "documentation", "reading": "", "permissions": "{role}guest\n{role}user", "boost": 100.0, - "labelTypeIds": ["label1"], - "versionNo": 1 + "label_type_ids": ["label1"], + "version_no": 1 } .. note:: @@ -226,7 +226,7 @@ Corps de la requête Lors de la mise à jour, les champs suivants sont requis en plus des champs utilisés pour la création : - ``id`` - ID du mot élevé à mettre à jour - - ``versionNo`` - Numéro de version pour le verrouillage optimiste. Indiquez la valeur obtenue via ``GET /setting/{id}``. + - ``version_no`` - Numéro de version pour le verrouillage optimiste. Indiquez la valeur obtenue via ``GET /setting/{id}``. Réponse ------- @@ -326,7 +326,7 @@ Exemples d'utilisation -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "suggestWord": "Product X", + "suggest_word": "Product X", "boost": 100.0, "permissions": "{role}guest" }' @@ -340,9 +340,9 @@ Exemples d'utilisation -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "suggestWord": "API reference", + "suggest_word": "API reference", "boost": 100.0, - "labelTypeIds": ["technical_docs"], + "label_type_ids": ["technical_docs"], "permissions": "{role}guest" }' diff --git a/fr/15.9/api/admin/api-admin-failureurl.rst b/fr/15.9/api/admin/api-admin-failureurl.rst index 8f224d130..de15855cd 100644 --- a/fr/15.9/api/admin/api-admin-failureurl.rst +++ b/fr/15.9/api/admin/api-admin-failureurl.rst @@ -71,15 +71,15 @@ Paramètres - String - Non - Filtre par URL (les caractères génériques ``*`` ``?`` sont supportés) - * - ``errorCountMin`` + * - ``error_count_min`` - Integer - Non - Borne inférieure du nombre d'erreurs (supérieur ou égal à la valeur spécifiée) - * - ``errorCountMax`` + * - ``error_count_max`` - Integer - Non - Borne supérieure du nombre d'erreurs (inférieur ou égal à la valeur spécifiée) - * - ``errorName`` + * - ``error_name`` - String - Non - Filtre par nom d'erreur (correspondance avec caractères génériques sur le nom de classe complet stocké ; ``*`` ``?`` supportés) @@ -96,22 +96,22 @@ Réponse { "id": "failure_id_1", "url": "https://example.com/broken-page", - "threadName": "Crawler-1", - "errorName": "java.net.ConnectException", - "errorLog": "Connection refused: connect", - "errorCount": "3", - "lastAccessTime": "1738144800000", - "configId": "webConfig_id_1" + "thread_name": "Crawler-1", + "error_name": "java.net.ConnectException", + "error_log": "Connection refused: connect", + "error_count": "3", + "last_access_time": "1738144800000", + "config_id": "webConfig_id_1" }, { "id": "failure_id_2", "url": "https://example.com/not-found", - "threadName": "Crawler-2", - "errorName": "org.codelibs.fess.exception.ContentNotFoundException", - "errorLog": "Not found: https://example.com/not-found", - "errorCount": "1", - "lastAccessTime": "1738143000000", - "configId": "webConfig_id_1" + "thread_name": "Crawler-2", + "error_name": "org.codelibs.fess.exception.ContentNotFoundException", + "error_log": "Not found: https://example.com/not-found", + "error_count": "1", + "last_access_time": "1738143000000", + "config_id": "webConfig_id_1" } ], "total": 45 @@ -131,22 +131,22 @@ Champs de la réponse - ID de l'URL en échec * - ``url`` - URL en échec - * - ``threadName`` + * - ``thread_name`` - Nom du thread - * - ``errorName`` + * - ``error_name`` - Nom de l'erreur (nom de classe complet de l'exception survenue ; ex. ``java.net.ConnectException``) - * - ``errorLog`` + * - ``error_log`` - Journal d'erreur (message de l'exception ou trace de la pile) - * - ``errorCount`` + * - ``error_count`` - Nombre d'occurrences de l'erreur (valeur numérique sous forme de chaîne) - * - ``lastAccessTime`` + * - ``last_access_time`` - Heure du dernier accès (millisecondes epoch sous forme de chaîne) - * - ``configId`` + * - ``config_id`` - ID de la configuration de crawl .. note:: - Tous les champs de la réponse sont retournés sous forme de chaînes (JSON string). ``errorCount`` est une valeur numérique représentée sous forme de chaîne, et ``lastAccessTime`` est le nombre de millisecondes epoch représenté sous forme de chaîne. + Tous les champs de la réponse sont retournés sous forme de chaînes (JSON string). ``error_count`` est une valeur numérique représentée sous forme de chaîne, et ``last_access_time`` est le nombre de millisecondes epoch représenté sous forme de chaîne. Obtention d'une URL en échec ============================ @@ -169,12 +169,12 @@ Réponse "log": { "id": "failure_id_1", "url": "https://example.com/broken-page", - "threadName": "Crawler-1", - "errorName": "java.net.ConnectException", - "errorLog": "Connection refused: connect", - "errorCount": "3", - "lastAccessTime": "1738144800000", - "configId": "webConfig_id_1" + "thread_name": "Crawler-1", + "error_name": "java.net.ConnectException", + "error_log": "Connection refused: connect", + "error_count": "3", + "last_access_time": "1738144800000", + "config_id": "webConfig_id_1" } } } @@ -226,7 +226,7 @@ Réponse Types d'erreurs =============== -``errorName`` contient le nom de classe complet de l'exception survenue pendant le crawl, tel qu'il a été capturé. Il ne s'agit pas d'une énumération fixe ; tout nom de classe peut apparaître selon l'exception levée. Voici quelques exemples représentatifs. +``error_name`` contient le nom de classe complet de l'exception survenue pendant le crawl, tel qu'il a été capturé. Il ne s'agit pas d'une énumération fixe ; tout nom de classe peut apparaître selon l'exception levée. Voici quelques exemples représentatifs. .. list-table:: :header-rows: 1 @@ -310,7 +310,7 @@ Agrégation par type d'erreur # Compter par type d'erreur curl -X GET "http://localhost:8080/api/admin/failureurl/logs?size=1000" \ -H "Authorization: Bearer YOUR_TOKEN" | \ - jq '[.response.logs[].errorName] | group_by(.) | map({error: .[0], count: length})' + 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-fileconfig.rst b/fr/15.9/api/admin/api-admin-fileconfig.rst index e53d5bd8e..bacb741ca 100644 --- a/fr/15.9/api/admin/api-admin-fileconfig.rst +++ b/fr/15.9/api/admin/api-admin-fileconfig.rst @@ -106,20 +106,20 @@ Réponse "name": "Shared Documents", "description": "Documents partagés", "paths": "smb://server/share/documents", - "includedPaths": ".*\\.pdf$", - "excludedPaths": ".*/(temp|cache)/.*", - "includedDocPaths": "", - "excludedDocPaths": "", - "configParameter": "", + "included_paths": ".*\\.pdf$", + "excluded_paths": ".*/(temp|cache)/.*", + "included_doc_paths": "", + "excluded_doc_paths": "", + "config_parameter": "", "depth": 10, - "maxAccessCount": 1000, - "numOfThread": 1, - "intervalTime": 1000, + "max_access_count": 1000, + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, "available": "true", "permissions": "{role}admin", - "virtualHosts": "", - "sortOrder": 0 + "virtual_hosts": "", + "sort_order": 0 } ], "total": 5 @@ -151,35 +151,35 @@ Réponse "name": "Shared Documents", "description": "Documents partagés", "paths": "smb://server/share/documents", - "includedPaths": ".*\\.pdf$", - "excludedPaths": ".*/(temp|cache)/.*", - "includedDocPaths": "", - "excludedDocPaths": "", - "configParameter": "", + "included_paths": ".*\\.pdf$", + "excluded_paths": ".*/(temp|cache)/.*", + "included_doc_paths": "", + "excluded_doc_paths": "", + "config_parameter": "", "depth": 10, - "maxAccessCount": 1000, - "numOfThread": 1, - "intervalTime": 1000, + "max_access_count": 1000, + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin", - "virtualHosts": "", - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_hosts": "", + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } .. note:: - La réponse inclut les champs d'audit ``createdBy``, ``createdTime``, - ``updatedBy``, ``updatedTime`` et ``versionNo``, qui sont définis automatiquement + La réponse inclut les champs d'audit ``created_by``, ``created_time``, + ``updated_by``, ``updated_time`` et ``version_no``, qui sont définis automatiquement lors de la création ou de la mise à jour. - ``versionNo`` est requis lors de la mise à jour (voir la section « Mise à jour d'une configuration de crawl de fichiers » ci-dessous). + ``version_no`` est requis lors de la mise à jour (voir la section « Mise à jour d'une configuration de crawl de fichiers » ci-dessous). Création d'une configuration de crawl de fichiers ================================================= @@ -200,13 +200,13 @@ Corps de la requête { "name": "Local Files", "paths": "file:///data/documents", - "includedPaths": ".*\\.(pdf|doc|docx|xls|xlsx)$", - "excludedPaths": ".*/(temp|backup)/.*", - "numOfThread": 2, - "intervalTime": 500, + "included_paths": ".*\\.(pdf|doc|docx|xls|xlsx)$", + "excluded_paths": ".*/(temp|backup)/.*", + "num_of_thread": 2, + "interval_time": 500, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin\n{role}user" } @@ -229,31 +229,31 @@ Description des champs * - ``paths`` - Oui - Chemins de départ du crawl (séparés par des sauts de ligne si multiples). Indiquez l'un des protocoles suivants : ``file:``, ``smb:``, ``smb1:``, ``ftp:``, ``s3:``, ``gcs:`` - * - ``includedPaths`` + * - ``included_paths`` - Non - Expression régulière des chemins à crawler - * - ``excludedPaths`` + * - ``excluded_paths`` - Non - Expression régulière des chemins à exclure du crawl - * - ``includedDocPaths`` + * - ``included_doc_paths`` - Non - Expression régulière des chemins à indexer - * - ``excludedDocPaths`` + * - ``excluded_doc_paths`` - Non - Expression régulière des chemins à exclure de l'indexation - * - ``configParameter`` + * - ``config_parameter`` - Non - Paramètres de configuration supplémentaires (format ``key=value``, un par ligne) * - ``depth`` - Non - Profondeur du crawl (0 ou plus) - * - ``maxAccessCount`` + * - ``max_access_count`` - Non - Nombre maximum d'accès (0 ou plus) - * - ``numOfThread`` + * - ``num_of_thread`` - Oui - Nombre de threads parallèles (1 ou plus) - * - ``intervalTime`` + * - ``interval_time`` - Oui - Intervalle entre les accès (en millisecondes, 0 ou plus) * - ``boost`` @@ -262,19 +262,19 @@ Description des champs * - ``available`` - Oui - Activé/Désactivé (chaîne ``"true"`` / ``"false"``) - * - ``sortOrder`` + * - ``sort_order`` - Oui - Ordre d'affichage (0 ou plus) * - ``permissions`` - Non - Rôles autorisés (séparés par des sauts de ligne si plusieurs) - * - ``virtualHosts`` + * - ``virtual_hosts`` - Non - Hôtes virtuels (séparés par des sauts de ligne si plusieurs) .. note:: - Les champs d'audit tels que ``createdBy``, ``createdTime``, ``updatedBy`` et ``updatedTime`` + Les champs d'audit tels que ``created_by``, ``created_time``, ``updated_by`` et ``updated_time`` sont définis automatiquement côté serveur et n'ont pas besoin d'être fournis dans le corps de la requête. Réponse @@ -304,8 +304,8 @@ Requête Corps de la requête ~~~~~~~~~~~~~~~~~~~ -Lors d'une mise à jour, les champs de création sont complétés par ``id``, qui identifie la configuration à mettre à jour, et ``versionNo``, le numéro de version actuel. -Indiquez pour ``versionNo`` la valeur renvoyée par l'API de récupération (GET). +Lors d'une mise à jour, les champs de création sont complétés par ``id``, qui identifie la configuration à mettre à jour, et ``version_no``, le numéro de version actuel. +Indiquez pour ``version_no`` la valeur renvoyée par l'API de récupération (GET). .. code-block:: json @@ -313,16 +313,16 @@ Indiquez pour ``versionNo`` la valeur renvoyée par l'API de récupération (GET "id": "existing_fileconfig_id", "name": "Updated Local Files", "paths": "file:///data/documents", - "includedPaths": ".*\\.(pdf|doc|docx|xls|xlsx|ppt|pptx)$", - "excludedPaths": ".*/(temp|backup|archive)/.*", + "included_paths": ".*\\.(pdf|doc|docx|xls|xlsx|ppt|pptx)$", + "excluded_paths": ".*/(temp|backup|archive)/.*", "depth": 10, - "maxAccessCount": 10000, - "numOfThread": 3, - "intervalTime": 300, + "max_access_count": 10000, + "num_of_thread": 3, + "interval_time": 300, "boost": 1.2, "available": "true", - "sortOrder": 0, - "versionNo": 1 + "sort_order": 0, + "version_no": 1 } Champs supplémentaires pour la mise à jour @@ -338,9 +338,9 @@ Champs supplémentaires pour la mise à jour * - ``id`` - Oui - Identifiant de la configuration à mettre à jour (1 000 caractères maximum) - * - ``versionNo`` + * - ``version_no`` - Oui - - Numéro de version actuel de la configuration à mettre à jour. Indiquez la valeur ``versionNo`` contenue dans la réponse de l'API de récupération (GET) + - Numéro de version actuel de la configuration à mettre à jour. Indiquez la valeur ``version_no`` contenue dans la réponse de l'API de récupération (GET) Réponse ------- @@ -420,13 +420,13 @@ Configuration de crawl pour des fichiers locaux -d '{ "name": "Local Files", "paths": "file:///data/documents", - "includedPaths": ".*\\.(pdf|doc|docx)$", - "excludedPaths": ".*/(temp|backup)/.*", - "numOfThread": 2, - "intervalTime": 500, + "included_paths": ".*\\.(pdf|doc|docx)$", + "excluded_paths": ".*/(temp|backup)/.*", + "num_of_thread": 2, + "interval_time": 500, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}guest" }' @@ -441,14 +441,14 @@ Configuration de crawl pour un partage SMB -d '{ "name": "SMB Share", "paths": "smb://server/documents", - "includedPaths": ".*\\.(pdf|doc|docx)$", - "excludedPaths": ".*/(temp|private)/.*", - "maxAccessCount": 50000, - "numOfThread": 3, - "intervalTime": 200, + "included_paths": ".*\\.(pdf|doc|docx)$", + "excluded_paths": ".*/(temp|private)/.*", + "max_access_count": 50000, + "num_of_thread": 3, + "interval_time": 200, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}guest" }' diff --git a/fr/15.9/api/admin/api-admin-general.rst b/fr/15.9/api/admin/api-admin-general.rst index 0ba87b3a9..1ff17e5b5 100644 --- a/fr/15.9/api/admin/api-admin-general.rst +++ b/fr/15.9/api/admin/api-admin-general.rst @@ -69,37 +69,36 @@ nombres. "version": "15.9.0", "status": 0, "setting": { - "incrementalCrawling": "true", - "dayForCleanup": -1, - "crawlingThreadCount": 5, - "searchLog": "true", - "userInfo": "true", - "userFavorite": "false", - "webApiJson": "true", - "defaultLabelValue": "", - "defaultSortValue": "", - "appendQueryParameter": "false", - "loginRequired": "false", + "incremental_crawling": "true", + "day_for_cleanup": -1, + "crawling_thread_count": 5, + "search_log": "true", + "user_info": "true", + "user_favorite": "false", + "web_api_json": "true", + "default_label_value": "", + "default_sort_value": "", + "append_query_parameter": "false", + "login_required": "false", "thumbnail": "true", - "failureCountThreshold": -1, - "popularWord": "true", - "csvFileEncoding": "UTF-8", - "purgeSearchLogDay": 30, - "purgeJobLogDay": 30, - "purgeUserInfoDay": 30, - "purgeSuggestSearchLogDay": 30, - "notificationTo": "", - "suggestSearchLog": "true", - "suggestDocuments": "true", - "ldapProviderUrl": "ldap://localhost:389/", - "ldapBaseDn": "dc=example,dc=com", - "ldapAdminSecurityPrincipal": "cn=admin,dc=example,dc=com", - "ldapAdminSecurityCredentials": null, - "logLevel": "", - "ssoType": "none", - "storageType": "", - "notificationLogin": "", - "notificationSearchTop": "" + "failure_count_threshold": -1, + "popular_word": "true", + "csv_file_encoding": "UTF-8", + "purge_search_log_day": 30, + "purge_job_log_day": 30, + "purge_user_info_day": 30, + "purge_suggest_search_log_day": 30, + "notification_to": "", + "suggest_search_log": "true", + "suggest_documents": "true", + "ldap_provider_url": "ldap://localhost:389/", + "ldap_base_dn": "dc=example,dc=com", + "ldap_admin_security_principal": "cn=admin,dc=example,dc=com", + "log_level": "", + "sso_type": "none", + "storage_type": "", + "notification_login": "", + "notification_search_top": "" } } } @@ -116,11 +115,11 @@ nombres. Pour des raisons de sécurité, les champs contenant des informations d'authentification ne sont pas retournés avec leur valeur réelle. - - Le mot de passe de l'administrateur LDAP ``ldapAdminSecurityCredentials`` est - toujours retourné sous la forme ``null``. - - Les autres secrets (``storageAccessKey`` / ``storageSecretKey`` / - ``oicClientId`` / ``oicClientSecret`` / ``spnegoPreauthPassword`` / - ``entraidClientId`` / ``entraidClientSecret``) sont retournés masqués sous la + - Le mot de passe de l'administrateur LDAP ``ldap_admin_security_credentials`` n'est + jamais inclus dans la réponse. + - Les autres secrets (``storage_access_key`` / ``storage_secret_key`` / + ``oic_client_id`` / ``oic_client_secret`` / ``spnego_preauth_password`` / + ``entraid_client_id`` / ``entraid_client_secret``) sont retournés masqués sous la forme ``"**********"`` lorsqu'ils sont définis, ou sous forme de chaîne vide (``""``) lorsqu'ils ne sont pas définis. @@ -148,10 +147,10 @@ définis à ``null``, conservent leur valeur existante. Les quatre champs suivants sont obligatoires et **doivent** être inclus dans **chaque** requête PUT, même lors d'une mise à jour partielle : - - ``dayForCleanup`` - - ``crawlingThreadCount`` - - ``failureCountThreshold`` - - ``csvFileEncoding`` + - ``day_for_cleanup`` + - ``crawling_thread_count`` + - ``failure_count_threshold`` + - ``csv_file_encoding`` Si l'un d'eux est absent, la requête échoue à la validation et l'API retourne HTTP 400 avec ``status: 1`` et un ``message`` d'erreur. La valeur envoyée écrase @@ -179,12 +178,12 @@ définis à ``null``, conservent leur valeur existante. .. code-block:: json { - "incrementalCrawling": "true", - "dayForCleanup": -1, - "crawlingThreadCount": 10, - "failureCountThreshold": 100, - "csvFileEncoding": "UTF-8", - "popularWord": "true" + "incremental_crawling": "true", + "day_for_cleanup": -1, + "crawling_thread_count": 10, + "failure_count_threshold": 100, + "csv_file_encoding": "UTF-8", + "popular_word": "true" } Principaux champs @@ -202,124 +201,124 @@ spécifiés sous forme de chaînes ``"true"`` / ``"false"``. * - Champ - Requis - Description - * - ``incrementalCrawling`` + * - ``incremental_crawling`` - Non - Activer/désactiver le crawl incrémental - * - ``dayForCleanup`` + * - ``day_for_cleanup`` - Oui - Nombre de jours de conservation des documents crawlés (-1 = nettoyage désactivé ; plage : -1 à 1000) - * - ``crawlingThreadCount`` + * - ``crawling_thread_count`` - Oui - Nombre de threads utilisés pour le crawl (plage : 0 à 100) - * - ``failureCountThreshold`` + * - ``failure_count_threshold`` - Oui - Seuil du nombre d'échecs pour arrêter le crawl d'une URL (-1 = désactivé ; plage : -1 à 10000) - * - ``csvFileEncoding`` + * - ``csv_file_encoding`` - Oui - Encodage de l'export CSV - * - ``searchLog`` + * - ``search_log`` - Non - Activer/désactiver le journal des requêtes de recherche - * - ``userInfo`` + * - ``user_info`` - Non - Activer/désactiver l'enregistrement des informations utilisateur - * - ``userFavorite`` + * - ``user_favorite`` - Non - Activer/désactiver la fonctionnalité de favoris - * - ``webApiJson`` + * - ``web_api_json`` - Non - Activer/désactiver l'API Web JSON - * - ``appValue`` + * - ``app_value`` - Non - Valeur de configuration supplémentaire spécifique à l'application - * - ``virtualHostValue`` + * - ``virtual_host_value`` - Non - Configuration d'hôte virtuel (pour les configurations multi-locataires) - * - ``popularWord`` + * - ``popular_word`` - Non - Activer/désactiver l'agrégation et l'affichage des mots populaires - * - ``defaultLabelValue`` + * - ``default_label_value`` - Non - Valeur de label par défaut - * - ``defaultSortValue`` + * - ``default_sort_value`` - Non - Ordre de tri par défaut - * - ``appendQueryParameter`` + * - ``append_query_parameter`` - Non - Ajout de paramètres de requête aux URLs des résultats de recherche - * - ``loginRequired`` + * - ``login_required`` - Non - Exiger une connexion pour effectuer une recherche - * - ``loginLink`` + * - ``login_link`` - Non - Activer/désactiver l'affichage du lien de connexion sur l'écran de recherche * - ``thumbnail`` - Non - Activer/désactiver la génération de vignettes - * - ``resultCollapsed`` + * - ``result_collapsed`` - Non - Activer/désactiver le regroupement des documents similaires dans les résultats de recherche - * - ``ignoreFailureType`` + * - ``ignore_failure_type`` - Non - Types d'échec de crawl à ignorer - * - ``crawlingUserAgent`` + * - ``crawling_user_agent`` - Non - Chaîne User-Agent envoyée lors du crawl - * - ``purgeSearchLogDay`` + * - ``purge_search_log_day`` - Non - Nombre de jours de conservation des journaux de recherche (-1 = désactivé ; plage : -1 à 100000) - * - ``purgeJobLogDay`` + * - ``purge_job_log_day`` - Non - Nombre de jours de conservation des journaux de tâches (-1 = désactivé ; plage : -1 à 100000) - * - ``purgeUserInfoDay`` + * - ``purge_user_info_day`` - Non - Nombre de jours de conservation des informations utilisateur (-1 = désactivé ; plage : -1 à 100000) - * - ``purgeSuggestSearchLogDay`` + * - ``purge_suggest_search_log_day`` - Non - Nombre de jours de conservation des journaux de recherche de suggestion (0 = désactivé ; plage : 0 à 100000) - * - ``purgeByBots`` + * - ``purge_by_bots`` - Non - User-Agents de bots dont les journaux de recherche doivent être supprimés - * - ``notificationTo`` + * - ``notification_to`` - Non - Adresse e-mail de destination des notifications système - * - ``notificationLogin`` + * - ``notification_login`` - Non - Message de notification affiché sur la page de connexion - * - ``notificationSearchTop`` + * - ``notification_search_top`` - Non - Message de notification affiché sur la page d'accueil de recherche - * - ``notificationAdvanceSearch`` + * - ``notification_advance_search`` - Non - Message de notification affiché sur la page de recherche avancée - * - ``suggestSearchLog`` + * - ``suggest_search_log`` - Non - Activer/désactiver les suggestions basées sur les journaux de recherche - * - ``suggestDocuments`` + * - ``suggest_documents`` - Non - Activer/désactiver les suggestions basées sur les documents - * - ``logLevel`` + * - ``log_level`` - Non - Niveau de journalisation du journal système - * - ``logNotificationEnabled`` + * - ``log_notification_enabled`` - Non - Activer/désactiver les notifications de journaux ERROR/WARN - * - ``logNotificationLevel`` + * - ``log_notification_level`` - Non - Niveau de notification des journaux - * - ``slackWebhookUrls`` + * - ``slack_webhook_urls`` - Non - URL de webhook Slack pour les notifications - * - ``googleChatWebhookUrls`` + * - ``google_chat_webhook_urls`` - Non - URL de webhook Google Chat pour les notifications - * - ``searchUseBrowserLocale`` + * - ``search_use_browser_locale`` - Non - Utiliser ou non la locale du navigateur pour la recherche - * - ``ragLlmName`` + * - ``rag_llm_name`` - Non - Nom du fournisseur LLM utilisé pour le RAG - * - ``llmLogLevel`` + * - ``llm_log_level`` - Non - Niveau de journalisation des paquets liés au LLM @@ -337,29 +336,29 @@ d'administration). * - Champ - Description - * - ``ldapProviderUrl`` + * - ``ldap_provider_url`` - URL de connexion LDAP - * - ``ldapBaseDn`` + * - ``ldap_base_dn`` - DN de base LDAP - * - ``ldapSecurityPrincipal`` + * - ``ldap_security_principal`` - Principal de sécurité pour le bind LDAP - * - ``ldapAdminSecurityPrincipal`` + * - ``ldap_admin_security_principal`` - Principal de sécurité pour les opérations d'administration LDAP - * - ``ldapAdminSecurityCredentials`` - - Mot de passe de l'administrateur LDAP (remplacé par ``null`` dans la réponse) - * - ``ldapAccountFilter`` / ``ldapGroupFilter`` + * - ``ldap_admin_security_credentials`` + - Mot de passe de l'administrateur LDAP (jamais inclus dans la réponse) + * - ``ldap_account_filter`` / ``ldap_group_filter`` - Filtres de recherche d'utilisateurs/groupes - * - ``ldapMemberofAttribute`` + * - ``ldap_memberof_attribute`` - Nom de l'attribut LDAP indiquant l'appartenance à un groupe - * - ``ssoType`` + * - ``sso_type`` - Type de SSO (``none`` / ``oic`` / ``saml`` / ``spnego`` / ``entraid``) - * - ``oicClientId`` / ``oicClientSecret`` / ``oicAuthServerUrl`` etc. + * - ``oic_client_id`` / ``oic_client_secret`` / ``oic_auth_server_url`` etc. - Configuration OpenID Connect - * - ``samlIdpEntityid`` / ``samlSpEntityid`` etc. + * - ``saml_idp_entityid`` / ``saml_sp_entityid`` etc. - Configuration SAML - * - ``spnegoKrb5Conf`` / ``spnegoLoginConf`` etc. + * - ``spnego_krb5_conf`` / ``spnego_login_conf`` etc. - Configuration SPNEGO - * - ``entraidClientId`` / ``entraidTenant`` etc. + * - ``entraid_client_id`` / ``entraid_tenant`` etc. - Configuration Microsoft Entra ID Champs relatifs au stockage @@ -373,25 +372,25 @@ Les paramètres d'intégration du stockage cloud (S3 / GCS) peuvent également * - Champ - Description - * - ``storageType`` + * - ``storage_type`` - Type de stockage (``auto`` / ``s3`` / ``gcs``) - * - ``storageEndpoint`` + * - ``storage_endpoint`` - URL du point de terminaison du stockage - * - ``storageAccessKey`` / ``storageSecretKey`` + * - ``storage_access_key`` / ``storage_secret_key`` - Clé d'accès / clé secrète pour l'authentification - * - ``storageBucket`` + * - ``storage_bucket`` - Nom du bucket - * - ``storageRegion`` + * - ``storage_region`` - Région S3 - * - ``storageProjectId`` / ``storageCredentialsPath`` + * - ``storage_project_id`` / ``storage_credentials_path`` - ID de projet GCS / chemin du fichier d'informations d'authentification .. note:: - Les champs secrets tels que ``ldapAdminSecurityCredentials``, - ``storageAccessKey`` / ``storageSecretKey``, ``oicClientId`` / - ``oicClientSecret``, ``entraidClientId`` / ``entraidClientSecret``, et - ``spnegoPreauthPassword`` conservent leur valeur stockée (ne sont pas mis à + Les champs secrets tels que ``ldap_admin_security_credentials``, + ``storage_access_key`` / ``storage_secret_key``, ``oic_client_id`` / + ``oic_client_secret``, ``entraid_client_id`` / ``entraid_client_secret``, et + ``spnego_preauth_password`` conservent leur valeur stockée (ne sont pas mis à jour) lorsque la valeur masquée ``"**********"`` est envoyée telle quelle. N'envoyez la valeur réelle que lorsque vous souhaitez la modifier. @@ -425,8 +424,8 @@ Exemples d'utilisation .. note:: - Les exemples ci-dessous incluent les champs obligatoires (``dayForCleanup``, - ``crawlingThreadCount``, ``failureCountThreshold``, ``csvFileEncoding``). Étant + Les exemples ci-dessous incluent les champs obligatoires (``day_for_cleanup``, + ``crawling_thread_count``, ``failure_count_threshold``, ``csv_file_encoding``). Étant donné que ceux-ci doivent toujours être envoyés quelle que soit la modification effectuée, récupérez les valeurs actuelles avec ``GET`` et incluez-les en situation réelle (les exemples ci-dessous utilisent les valeurs par défaut). @@ -440,11 +439,11 @@ Mise à jour des paramètres de crawl -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "incrementalCrawling": "true", - "crawlingThreadCount": 10, - "failureCountThreshold": 100, - "dayForCleanup": -1, - "csvFileEncoding": "UTF-8" + "incremental_crawling": "true", + "crawling_thread_count": 10, + "failure_count_threshold": 100, + "day_for_cleanup": -1, + "csv_file_encoding": "UTF-8" }' Mise à jour des périodes de conservation des journaux @@ -456,13 +455,13 @@ Mise à jour des périodes de conservation des journaux -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "dayForCleanup": -1, - "crawlingThreadCount": 5, - "failureCountThreshold": -1, - "csvFileEncoding": "UTF-8", - "purgeSearchLogDay": 90, - "purgeJobLogDay": 90, - "purgeUserInfoDay": 90 + "day_for_cleanup": -1, + "crawling_thread_count": 5, + "failure_count_threshold": -1, + "csv_file_encoding": "UTF-8", + "purge_search_log_day": 90, + "purge_job_log_day": 90, + "purge_user_info_day": 90 }' Mise à jour des paramètres de suggestion @@ -474,12 +473,12 @@ Mise à jour des paramètres de suggestion -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "dayForCleanup": -1, - "crawlingThreadCount": 5, - "failureCountThreshold": -1, - "csvFileEncoding": "UTF-8", - "suggestSearchLog": "true", - "suggestDocuments": "true" + "day_for_cleanup": -1, + "crawling_thread_count": 5, + "failure_count_threshold": -1, + "csv_file_encoding": "UTF-8", + "suggest_search_log": "true", + "suggest_documents": "true" }' Informations complémentaires diff --git a/fr/15.9/api/admin/api-admin-group.rst b/fr/15.9/api/admin/api-admin-group.rst index 5f2a49422..cdc11c85b 100644 --- a/fr/15.9/api/admin/api-admin-group.rst +++ b/fr/15.9/api/admin/api-admin-group.rst @@ -90,7 +90,7 @@ Réponse "attributes": { "gidNumber": "1000" }, - "versionNo": 1 + "version_no": 1 }, { "id": "group_id_2", @@ -98,7 +98,7 @@ Réponse "attributes": { "gidNumber": "1001" }, - "versionNo": 1 + "version_no": 1 } ], "total": 5 @@ -129,7 +129,7 @@ Réponse "attributes": { "gidNumber": "1000" }, - "versionNo": 1 + "version_no": 1 } } } @@ -209,7 +209,7 @@ Corps de la requête "attributes": { "gidNumber": "1002" }, - "versionNo": 1 + "version_no": 1 } Description des champs @@ -231,9 +231,9 @@ Description des champs * - ``attributes`` - Non - Map d'attributs (contenant des attributs LDAP comme ``gidNumber``). Les valeurs sont spécifiées sous forme de chaînes de caractères - * - ``versionNo`` + * - ``version_no`` - Oui - - Numéro de version pour le verrouillage optimiste. Spécifiez la valeur de ``versionNo`` obtenue lors de l'obtention du groupe + - Numéro de version pour le verrouillage optimiste. Spécifiez la valeur de ``version_no`` obtenue lors de l'obtention du groupe Réponse ------- diff --git a/fr/15.9/api/admin/api-admin-joblog.rst b/fr/15.9/api/admin/api-admin-joblog.rst index efdc818ba..e77f7face 100644 --- a/fr/15.9/api/admin/api-admin-joblog.rst +++ b/fr/15.9/api/admin/api-admin-joblog.rst @@ -80,25 +80,25 @@ Réponse "logs": [ { "id": "joblog_id_1", - "jobName": "Default Crawler", - "jobStatus": "ok", + "job_name": "Default Crawler", + "job_status": "ok", "target": "all", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "scriptResult": "Job completed successfully", - "startTime": "1738116000000", - "endTime": "1738118723000" + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "script_result": "Job completed successfully", + "start_time": "1738116000000", + "end_time": "1738118723000" }, { "id": "joblog_id_2", - "jobName": "Default Crawler", - "jobStatus": "fail", + "job_name": "Default Crawler", + "job_status": "fail", "target": "all", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "scriptResult": "Error: Connection timeout", - "startTime": "1738029600000", - "endTime": "1738030215000" + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "script_result": "Error: Connection timeout", + "start_time": "1738029600000", + "end_time": "1738030215000" } ], "total": 100 @@ -116,26 +116,26 @@ Champs de la réponse - Description * - ``id`` - ID du journal de tâche - * - ``jobName`` + * - ``job_name`` - Nom de la tâche - * - ``jobStatus`` + * - ``job_status`` - Statut de la tâche (``ok`` : succès, ``fail`` : échec, ``running`` : en cours d'exécution) * - ``target`` - Cible d'exécution (nom de la cible du planificateur ; valeur par défaut : ``all``) - * - ``scriptType`` + * - ``script_type`` - Type de script (ex. : ``javascript``) - * - ``scriptData`` + * - ``script_data`` - Script exécuté - * - ``scriptResult`` + * - ``script_result`` - Résultat d'exécution - * - ``startTime`` + * - ``start_time`` - Heure de début (millisecondes epoch ; retournée sous forme de chaîne) - * - ``endTime`` + * - ``end_time`` - Heure de fin (millisecondes epoch ; retournée sous forme de chaîne). Non retournée pour les tâches en cours d'exécution. .. note:: - Chaque objet de journal dans la réponse inclut également un champ interne ``crudMode`` + Chaque objet de journal dans la réponse inclut également un champ interne ``crud_mode`` (un entier indiquant le mode d'opération CRUD, toujours ``0`` pour les opérations de lecture). Les clients peuvent l'ignorer en toute sécurité. @@ -159,14 +159,14 @@ Réponse "status": 0, "log": { "id": "joblog_id_1", - "jobName": "Default Crawler", - "jobStatus": "ok", + "job_name": "Default Crawler", + "job_status": "ok", "target": "all", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "scriptResult": "Crawl completed successfully.\nDocuments indexed: 1234\nDocuments updated: 567\nDocuments deleted: 12\nErrors: 0", - "startTime": "1738116000000", - "endTime": "1738118723000" + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "script_result": "Crawl completed successfully.\nDocuments indexed: 1234\nDocuments updated: 567\nDocuments deleted: 12\nErrors: 0", + "start_time": "1738116000000", + "end_time": "1738118723000" } } } diff --git a/fr/15.9/api/admin/api-admin-keymatch.rst b/fr/15.9/api/admin/api-admin-keymatch.rst index 3361be4e1..d0fdb8293 100644 --- a/fr/15.9/api/admin/api-admin-keymatch.rst +++ b/fr/15.9/api/admin/api-admin-keymatch.rst @@ -92,9 +92,9 @@ Réponse "id": "keymatch_id_1", "term": "download", "query": "title:download OR content:download", - "maxSize": 10, + "max_size": 10, "boost": 10.0, - "versionNo": 1 + "version_no": 1 } ], "total": 5 @@ -104,8 +104,8 @@ Réponse .. note:: ``total`` contient le nombre total d'éléments correspondant aux critères de filtrage (et non le nombre d'éléments de la page courante). - En plus des champs ci-dessus, chaque objet de configuration peut inclure ``virtualHost``, - ``createdBy``, ``createdTime``, ``updatedBy`` et ``updatedTime`` lorsque des valeurs sont définies. + En plus des champs ci-dessus, chaque objet de configuration peut inclure ``virtual_host``, + ``created_by``, ``created_time``, ``updated_by`` et ``updated_time`` lorsque des valeurs sont définies. Obtention d'un KeyMatch ======================= @@ -129,21 +129,21 @@ Réponse "id": "keymatch_id_1", "term": "download", "query": "title:download OR content:download", - "maxSize": 10, + "max_size": 10, "boost": 10.0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } .. note:: - ``versionNo`` est le numéro de version utilisé pour le verrouillage optimiste. Lors de la mise à jour d'un KeyMatch, - spécifiez la valeur de ``versionNo`` obtenue lors de la récupération dans le corps de la requête. + ``version_no`` est le numéro de version utilisé pour le verrouillage optimiste. Lors de la mise à jour d'un KeyMatch, + spécifiez la valeur de ``version_no`` obtenue lors de la récupération dans le corps de la requête. Si l'identifiant spécifié n'existe pas, une erreur est renvoyée. Création d'un KeyMatch @@ -165,7 +165,7 @@ Corps de la requête { "term": "pricing", "query": "url:*/pricing* OR title:pricing", - "maxSize": 5, + "max_size": 5, "boost": 20.0 } @@ -188,7 +188,7 @@ Description des champs - String - Oui - Requête de correspondance (longueur maximale définie par le paramètre ``form.admin.max.input.size``) - * - ``maxSize`` + * - ``max_size`` - Integer - Oui - Nombre maximum d'affichages (entier supérieur ou égal à 0 ; valeur initiale dans l'interface d'administration : 10) @@ -196,16 +196,16 @@ Description des champs - Float - Oui - Valeur de boost (valeur initiale dans l'interface d'administration : 100.0) - * - ``virtualHost`` + * - ``virtual_host`` - String - Non - Nom d'hôte virtuel (1000 caractères maximum ; à spécifier pour basculer les KeyMatch par hôte virtuel) .. note:: - ``maxSize`` et ``boost`` sont obligatoires via l'API. Les valeurs initiales affichées dans le formulaire de l'interface d'administration + ``max_size`` et ``boost`` sont obligatoires via l'API. Les valeurs initiales affichées dans le formulaire de l'interface d'administration ne s'appliquent pas via l'API. En cas d'omission, une erreur de validation est renvoyée. - Par ailleurs, ``createdBy`` et ``createdTime`` sont écrasés côté serveur même s'ils sont spécifiés dans la requête. + Par ailleurs, ``created_by`` et ``created_time`` sont écrasés côté serveur même s'ils sont spécifiés dans la requête. Réponse ------- @@ -240,15 +240,15 @@ Corps de la requête "id": "existing_keymatch_id", "term": "pricing", "query": "url:*/pricing* OR title:pricing OR content:price", - "maxSize": 10, + "max_size": 10, "boost": 15.0, - "versionNo": 1 + "version_no": 1 } Description des champs ~~~~~~~~~~~~~~~~~~~~~~ -En plus des champs de création (``term``, ``query``, ``maxSize``, ``boost``, ``virtualHost``), +En plus des champs de création (``term``, ``query``, ``max_size``, ``boost``, ``virtual_host``), les champs suivants doivent être spécifiés. .. list-table:: @@ -263,7 +263,7 @@ les champs suivants doivent être spécifiés. - String - Oui - Identifiant du KeyMatch à mettre à jour (1000 caractères maximum) - * - ``versionNo`` + * - ``version_no`` - Integer - Oui - Numéro de version pour le verrouillage optimiste ; spécifier la valeur obtenue lors de la récupération @@ -316,7 +316,7 @@ Création d'un KeyMatch pour une page produit -d '{ "term": "product features", "query": "url:*/products/* AND (title:features OR content:features)", - "maxSize": 10, + "max_size": 10, "boost": 15.0 }' @@ -331,7 +331,7 @@ KeyMatch pour les pages de support -d '{ "term": "help", "query": "url:*/support/* OR url:*/help/* OR url:*/faq/*", - "maxSize": 5, + "max_size": 5, "boost": 20.0 }' diff --git a/fr/15.9/api/admin/api-admin-labeltype.rst b/fr/15.9/api/admin/api-admin-labeltype.rst index 1d1359c74..ba4395b35 100644 --- a/fr/15.9/api/admin/api-admin-labeltype.rst +++ b/fr/15.9/api/admin/api-admin-labeltype.rst @@ -101,16 +101,16 @@ Réponse "id": "label_id_1", "name": "Documentation", "value": "docs", - "includedPaths": ".*docs\\.example\\.com.*", - "excludedPaths": "", + "included_paths": ".*docs\\.example\\.com.*", + "excluded_paths": "", "permissions": "{role}admin", - "virtualHost": "", - "sortOrder": 0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_host": "", + "sort_order": 0, + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } ], "total": 5 @@ -119,8 +119,8 @@ Réponse .. note:: - Chaque objet de configuration inclut également ``createdBy`` / ``createdTime`` / - ``updatedBy`` / ``updatedTime`` à des fins d'audit, ainsi que ``versionNo`` pour le + Chaque objet de configuration inclut également ``created_by`` / ``created_time`` / + ``updated_by`` / ``updated_time`` à des fins d'audit, ainsi que ``version_no`` pour le verrouillage optimiste (les champs dont la valeur est ``null`` sont omis). L'objet ``response`` contient toujours ``version``, indiquant la version du produit, mais celui-ci peut être omis dans les exemples suivants par souci de concision. @@ -147,16 +147,16 @@ Réponse "id": "label_id_1", "name": "Documentation", "value": "docs", - "includedPaths": ".*docs\\.example\\.com.*", - "excludedPaths": "", + "included_paths": ".*docs\\.example\\.com.*", + "excluded_paths": "", "permissions": "{role}admin", - "virtualHost": "", - "sortOrder": 0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_host": "", + "sort_order": 0, + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } @@ -180,9 +180,9 @@ Corps de la requête { "name": "News", "value": "news", - "includedPaths": ".*news\\.example\\.com.*\n.*example\\.com/news/.*", - "excludedPaths": ".*/(archive|old)/.*", - "sortOrder": 1, + "included_paths": ".*news\\.example\\.com.*\n.*example\\.com/news/.*", + "excluded_paths": ".*/(archive|old)/.*", + "sort_order": 1, "permissions": "{role}guest" } @@ -205,11 +205,11 @@ Description des champs - String - Oui - Valeur du label (utilisée avec le paramètre ``label`` lors des recherches). Seuls les caractères alphanumériques et les tirets bas (``_``) sont autorisés ; la valeur doit correspondre à l'expression régulière ``^[a-zA-Z0-9_]+$`` (100 caractères maximum). - * - ``includedPaths`` + * - ``included_paths`` - String - Non - Expression régulière des chemins cibles du label. Si plusieurs valeurs sont spécifiées, elles sont séparées par un saut de ligne (``\n``). - * - ``excludedPaths`` + * - ``excluded_paths`` - String - Non - Expression régulière des chemins à exclure du label. Si plusieurs valeurs sont spécifiées, elles sont séparées par un saut de ligne (``\n``). @@ -217,18 +217,18 @@ Description des champs - String - Non - Rôles, groupes ou utilisateurs autorisés à accéder (ex. : ``{role}admin``). Si plusieurs valeurs sont spécifiées, elles sont séparées par un saut de ligne (``\n``). - * - ``sortOrder`` + * - ``sort_order`` - Integer - Non - Ordre d'affichage (entier supérieur ou égal à 0). La valeur par défaut est ``0``. - * - ``virtualHost`` + * - ``virtual_host`` - String - Non - Hôte virtuel (1000 caractères maximum). .. note:: - Les champs d'audit tels que ``createdBy`` / ``createdTime`` sont définis + Les champs d'audit tels que ``created_by`` / ``created_time`` sont définis automatiquement côté serveur et n'ont pas besoin d'être spécifiés dans la requête. Réponse @@ -266,11 +266,11 @@ Corps de la requête "id": "existing_label_id", "name": "News Articles", "value": "news", - "includedPaths": ".*news\\.example\\.com.*\n.*example\\.com/(news|articles)/.*", - "excludedPaths": ".*/(archive|old|draft)/.*", - "sortOrder": 1, + "included_paths": ".*news\\.example\\.com.*\n.*example\\.com/(news|articles)/.*", + "excluded_paths": ".*/(archive|old|draft)/.*", + "sort_order": 1, "permissions": "{role}guest", - "versionNo": 1 + "version_no": 1 } Lors d'une mise à jour, les champs suivants sont obligatoires en plus de ceux utilisés lors de la création. @@ -287,10 +287,10 @@ Lors d'une mise à jour, les champs suivants sont obligatoires en plus de ceux u - String - Oui - ID du type de label à mettre à jour. - * - ``versionNo`` + * - ``version_no`` - Integer - Oui - - Numéro de version pour le verrouillage optimiste. Spécifiez la valeur ``versionNo`` présente dans la réponse obtenue lors de la lecture. Si la version spécifiée ne correspond pas à la version actuelle, la mise à jour échoue. + - Numéro de version pour le verrouillage optimiste. Spécifiez la valeur ``version_no`` présente dans la réponse obtenue lors de la lecture. Si la version spécifiée ne correspond pas à la version actuelle, la mise à jour échoue. Réponse ------- @@ -342,8 +342,8 @@ Création d'un label pour la documentation -d '{ "name": "Technical Documentation", "value": "tech_docs", - "includedPaths": ".*docs\\.example\\.com.*\n.*example\\.com/documentation/.*", - "sortOrder": 0, + "included_paths": ".*docs\\.example\\.com.*\n.*example\\.com/documentation/.*", + "sort_order": 0, "permissions": "{role}guest" }' diff --git a/fr/15.9/api/admin/api-admin-overview.rst b/fr/15.9/api/admin/api-admin-overview.rst index 099ad829f..9ce7b2c91 100644 --- a/fr/15.9/api/admin/api-admin-overview.rst +++ b/fr/15.9/api/admin/api-admin-overview.rst @@ -519,23 +519,23 @@ Création d'une configuration de crawl Web -d '{ "name": "Example Site", "urls": "https://example.com/", - "includedUrls": ".*example.com.*", - "excludedUrls": "", - "userAgent": "Mozilla/5.0 (compatible; Fess)", - "numOfThread": 1, - "intervalTime": 1000, + "included_urls": ".*example.com.*", + "excluded_urls": "", + "user_agent": "Mozilla/5.0 (compatible; Fess)", + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, - "maxAccessCount": 1000, + "max_access_count": 1000, "depth": 3, - "sortOrder": 1, + "sort_order": 1, "available": "true" }' .. note:: Pour la création d'une configuration de crawl Web, les champs ``name``, ``urls``, - ``userAgent``, ``numOfThread``, ``intervalTime``, ``boost``, ``available`` et - ``sortOrder`` sont obligatoires. Les omettre provoque une erreur de validation + ``user_agent``, ``num_of_thread``, ``interval_time``, ``boost``, ``available`` et + ``sort_order`` sont obligatoires. Les omettre provoque une erreur de validation (``status: 1``). ``available`` se spécifie sous forme de chaîne de caractères, en y plaçant ``"true"`` ou ``"false"``. diff --git a/fr/15.9/api/admin/api-admin-relatedcontent.rst b/fr/15.9/api/admin/api-admin-relatedcontent.rst index 1c3ac29fb..2ee5c1bff 100644 --- a/fr/15.9/api/admin/api-admin-relatedcontent.rst +++ b/fr/15.9/api/admin/api-admin-relatedcontent.rst @@ -93,13 +93,13 @@ Réponse "id": "content_id_1", "term": "fess", "content": "
Fess is an open source search server.
", - "virtualHost": "", - "sortOrder": 0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_host": "", + "sort_order": 0, + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } ], "total": 5 @@ -110,10 +110,10 @@ Réponse Chaque élément de ``settings`` ainsi que l'objet ``setting`` retourné par l'endpoint d'obtention contiennent les champs de l'entité stockée tels quels. - En plus de ``term``, ``content``, ``sortOrder`` et ``virtualHost``, les champs - d'audit ``createdBy``, ``createdTime``, ``updatedBy``, ``updatedTime`` ainsi que - le champ de verrouillage optimiste ``versionNo`` sont également retournés. - ``createdTime`` et ``updatedTime`` sont exprimés en millisecondes depuis l'époque + En plus de ``term``, ``content``, ``sort_order`` et ``virtual_host``, les champs + d'audit ``created_by``, ``created_time``, ``updated_by``, ``updated_time`` ainsi que + le champ de verrouillage optimiste ``version_no`` sont également retournés. + ``created_time`` et ``updated_time`` sont exprimés en millisecondes depuis l'époque (nombres). Les champs non renseignés (null) sont omis de la réponse. De plus, l'objet ``response`` de toutes les réponses contient toujours ``version``, qui indique la version du produit (voir :doc:`api-admin-overview` pour les détails). @@ -141,20 +141,20 @@ Réponse "id": "content_id_1", "term": "fess", "content": "
Fess is an open source search server.
", - "virtualHost": "", - "sortOrder": 0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_host": "", + "sort_order": 0, + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } .. note:: - La valeur de ``versionNo`` requise lors d'une mise à jour (PUT) est celle + La valeur de ``version_no`` requise lors d'une mise à jour (PUT) est celle incluse dans cette réponse d'obtention. Creer un contenu associé @@ -176,8 +176,8 @@ Corps de la requête { "term": "search", "content": "

About Search

Learn more about search features...

", - "sortOrder": 0, - "virtualHost": "" + "sort_order": 0, + "virtual_host": "" } Description des champs @@ -196,10 +196,10 @@ Description des champs * - ``content`` - **Oui** - Contenu HTML à afficher (maximum 10000 caractères) - * - ``sortOrder`` + * - ``sort_order`` - **Non** - Ordre d'affichage (entier compris entre 0 et 2147483647) - * - ``virtualHost`` + * - ``virtual_host`` - **Non** - Hôte virtuel (maximum 1000 caractères) @@ -237,9 +237,9 @@ Corps de la requête "id": "existing_content_id", "term": "search", "content": "

About Search

Updated information...

", - "sortOrder": 0, - "virtualHost": "", - "versionNo": 1 + "sort_order": 0, + "virtual_host": "", + "version_no": 1 } Description des champs @@ -261,13 +261,13 @@ Description des champs * - ``content`` - **Oui** - Contenu HTML à afficher (maximum 10000 caractères) - * - ``sortOrder`` + * - ``sort_order`` - **Non** - Ordre d'affichage (entier compris entre 0 et 2147483647) - * - ``virtualHost`` + * - ``virtual_host`` - **Non** - Hôte virtuel (maximum 1000 caractères) - * - ``versionNo`` + * - ``version_no`` - **Oui** - Numéro de version pour le verrouillage optimiste. Specifier la valeur incluse dans la réponse de ``setting/{id}``. @@ -287,8 +287,8 @@ Réponse .. note:: - Les champs d'audit tels que ``createdBy``, ``createdTime``, ``updatedBy``, - ``updatedTime`` et ``crudMode`` sont ignorés même s'ils sont inclus dans le + Les champs d'audit tels que ``created_by``, ``created_time``, ``updated_by``, + ``updated_time`` et ``crud_mode`` sont ignorés même s'ils sont inclus dans le corps de la requête, car ils sont définis automatiquement côté serveur. Il n'est pas nécessaire de les spécifier lors de la création ou de la mise à jour. @@ -328,7 +328,7 @@ Contenu associé pour les informations produit -d '{ "term": "product", "content": "

Our Products

", - "sortOrder": 0 + "sort_order": 0 }' Contenu associé pour les informations de support @@ -342,7 +342,7 @@ Contenu associé pour les informations de support -d '{ "term": "support", "content": "

Need help? Contact: support@example.com

", - "sortOrder": 0 + "sort_order": 0 }' Informations complémentaires diff --git a/fr/15.9/api/admin/api-admin-relatedquery.rst b/fr/15.9/api/admin/api-admin-relatedquery.rst index b4bf4e5ca..914cef83f 100644 --- a/fr/15.9/api/admin/api-admin-relatedquery.rst +++ b/fr/15.9/api/admin/api-admin-relatedquery.rst @@ -90,7 +90,7 @@ Réponse "id": "query_id_1", "term": "fess", "queries": "fess tutorial\nfess installation\nfess configuration", - "versionNo": 1 + "version_no": 1 } ], "total": 5 @@ -99,10 +99,10 @@ Réponse .. note:: - Chaque paramètre contient ``versionNo`` (numéro de version utilisé pour le verrouillage - optimiste). ``virtualHost`` et les champs d'audit (``createdBy``, ``createdTime``, - ``updatedBy``, ``updatedTime``) ne sont inclus que lorsqu'une valeur est définie. - Un ``virtualHost`` vide n'est pas inclus dans la réponse. + Chaque paramètre contient ``version_no`` (numéro de version utilisé pour le verrouillage + optimiste). ``virtual_host`` et les champs d'audit (``created_by``, ``created_time``, + ``updated_by``, ``updated_time``) ne sont inclus que lorsqu'une valeur est définie. + Un ``virtual_host`` vide n'est pas inclus dans la réponse. Obtention d'une requête associée ================================= @@ -127,8 +127,8 @@ Réponse "id": "query_id_1", "term": "fess", "queries": "fess tutorial\nfess installation\nfess configuration", - "virtualHost": "site1.example.com", - "versionNo": 1 + "virtual_host": "site1.example.com", + "version_no": 1 } } } @@ -152,7 +152,7 @@ Corps de la requête { "term": "search", "queries": "search tutorial\nsearch syntax\nadvanced search", - "virtualHost": "" + "virtual_host": "" } Description des champs @@ -171,13 +171,13 @@ Description des champs * - ``queries`` - Oui - Requêtes associées. Chaîne séparée par des sauts de ligne, une par ligne (les lignes vides sont ignorées ; 10 000 caractères maximum) - * - ``virtualHost`` + * - ``virtual_host`` - Non - Hôte virtuel (1 000 caractères maximum) .. note:: - ``crudMode`` étant défini automatiquement côté API, il n'est pas nécessaire de l'inclure dans le corps de la requête. + ``crud_mode`` étant défini automatiquement côté API, il n'est pas nécessaire de l'inclure dans le corps de la requête. Réponse ------- @@ -213,8 +213,8 @@ Corps de la requête "id": "existing_query_id", "term": "search", "queries": "search tutorial\nsearch syntax\nadvanced search\nsearch tips", - "virtualHost": "", - "versionNo": 1 + "virtual_host": "", + "version_no": 1 } Description des champs @@ -236,10 +236,10 @@ Description des champs * - ``queries`` - Oui - Requêtes associées. Chaîne séparée par des sauts de ligne, une par ligne (les lignes vides sont ignorées ; 10 000 caractères maximum) - * - ``virtualHost`` + * - ``virtual_host`` - Non - Hôte virtuel (1 000 caractères maximum) - * - ``versionNo`` + * - ``version_no`` - Oui - Numéro de version utilisé pour le verrouillage optimiste. Spécifiez la valeur incluse dans la réponse lors de l'obtention du paramètre diff --git a/fr/15.9/api/admin/api-admin-role.rst b/fr/15.9/api/admin/api-admin-role.rst index 430628cbd..23bb73eda 100644 --- a/fr/15.9/api/admin/api-admin-role.rst +++ b/fr/15.9/api/admin/api-admin-role.rst @@ -87,12 +87,12 @@ Réponse { "id": "role_id_1", "name": "admin", - "versionNo": 1 + "version_no": 1 }, { "id": "role_id_2", "name": "user", - "versionNo": 1 + "version_no": 1 } ], "total": 5 @@ -120,7 +120,7 @@ Réponse "setting": { "id": "role_id_1", "name": "admin", - "versionNo": 1 + "version_no": 1 } } } @@ -194,7 +194,7 @@ Corps de la requête { "id": "existing_role_id", "name": "editor_updated", - "versionNo": 1 + "version_no": 1 } Description des champs @@ -216,9 +216,9 @@ Description des champs * - ``attributes`` - Non - Map d'attributs. Les valeurs sont spécifiées sous forme de chaînes de caractères - * - ``versionNo`` + * - ``version_no`` - Oui - - Numéro de version pour le verrouillage optimiste. Spécifiez la valeur de ``versionNo`` obtenue lors de l'obtention du rôle + - Numéro de version pour le verrouillage optimiste. Spécifiez la valeur de ``version_no`` obtenue lors de l'obtention du rôle Réponse ------- diff --git a/fr/15.9/api/admin/api-admin-scheduler.rst b/fr/15.9/api/admin/api-admin-scheduler.rst index 4bab94b8e..8cbadc844 100644 --- a/fr/15.9/api/admin/api-admin-scheduler.rst +++ b/fr/15.9/api/admin/api-admin-scheduler.rst @@ -91,14 +91,14 @@ Réponse "id": "job_id_1", "name": "Default Crawler", "target": "all", - "cronExpression": "0 0 0 * * ?", - "scriptType": "javascript", - "scriptData": "...", - "jobLogging": "true", + "cron_expression": "0 0 0 * * ?", + "script_type": "javascript", + "script_data": "...", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 0, - "versionNo": 1, + "sort_order": 0, + "version_no": 1, "running": false } ], @@ -112,7 +112,7 @@ Réponse .. note:: - Dans les réponses, ``jobLogging`` / ``crawler`` / ``available`` sont retournés sous forme de chaînes de caractères (``"true"`` / ``"false"``). ``running`` est un champ booléen, spécifique aux réponses, indiquant si la tâche est en cours d'exécution (ne peut pas être spécifié dans les requêtes). ``total`` est le nombre total de tâches correspondant à la requête. + Dans les réponses, ``job_logging`` / ``crawler`` / ``available`` sont retournés sous forme de chaînes de caractères (``"true"`` / ``"false"``). ``running`` est un champ booléen, spécifique aux réponses, indiquant si la tâche est en cours d'exécution (ne peut pas être spécifié dans les requêtes). ``total`` est le nombre total de tâches correspondant à la requête. Obtention d'une tâche planifiée =============================== @@ -136,14 +136,14 @@ Réponse "id": "job_id_1", "name": "Default Crawler", "target": "all", - "cronExpression": "0 0 0 * * ?", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "jobLogging": "true", + "cron_expression": "0 0 0 * * ?", + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 0, - "versionNo": 1, + "sort_order": 0, + "version_no": 1, "running": false } } @@ -168,13 +168,13 @@ Corps de la requête { "name": "Daily Crawler", "target": "all", - "cronExpression": "0 0 2 * * ?", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "jobLogging": "true", + "cron_expression": "0 0 2 * * ?", + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 1 + "sort_order": 1 } Description des champs @@ -193,16 +193,16 @@ Description des champs * - ``target`` - Oui - Cible d'exécution (max 100 caractères). Spécifier ``all`` ou un nom de cible spécifique - * - ``cronExpression`` + * - ``cron_expression`` - Non - Expression Cron (seconde minute heure jour mois jour-semaine). Max 100 caractères, validée en tant qu'expression cron. Si vide, la tâche n'est pas planifiée et ne peut être démarrée que manuellement - * - ``scriptType`` + * - ``script_type`` - Oui - Type de script (max 100 caractères). ``javascript`` (valeur par défaut pour les nouvelles tâches, déterminée par la propriété ``job.default.script``) ou ``groovy`` (nécessite le plugin ``fess-script-groovy``) - * - ``scriptData`` + * - ``script_data`` - Non - Script à exécuter. La taille maximale est définie par ``form.admin.max.input.size`` dans ``fess_config.properties`` - * - ``jobLogging`` + * - ``job_logging`` - Non - Activer la journalisation des tâches (chaîne) * - ``crawler`` @@ -211,17 +211,17 @@ Description des champs * - ``available`` - Non - Activé/Désactivé (chaîne) - * - ``sortOrder`` + * - ``sort_order`` - Oui - Ordre d'affichage (entier entre 0 et 2147483647) .. note:: - ``jobLogging`` / ``crawler`` / ``available`` sont des champs de type chaîne. Dans les requêtes, spécifier ``"on"`` ou ``"true"`` (insensible à la casse) les active ; toute autre valeur (``"false"``, chaîne vide ou non spécifié) est traitée comme désactivée. Dans les réponses, ils sont retournés sous la forme ``"true"`` / ``"false"``. + ``job_logging`` / ``crawler`` / ``available`` sont des champs de type chaîne. Dans les requêtes, spécifier ``"on"`` ou ``"true"`` (insensible à la casse) les active ; toute autre valeur (``"false"``, chaîne vide ou non spécifié) est traitée comme désactivée. Dans les réponses, ils sont retournés sous la forme ``"true"`` / ``"false"``. .. note:: - ``crudMode`` est défini automatiquement côté serveur et n'a pas besoin d'être spécifié dans les requêtes. Les champs d'audit tels que ``createdBy`` / ``createdTime`` sont également définis côté serveur. + ``crud_mode`` est défini automatiquement côté serveur et n'a pas besoin d'être spécifié dans les requêtes. Les champs d'audit tels que ``created_by`` / ``created_time`` sont également définis côté serveur. Réponse ------- @@ -274,19 +274,19 @@ Corps de la requête "id": "existing_job_id", "name": "Updated Crawler", "target": "all", - "cronExpression": "0 0 3 * * ?", - "scriptType": "javascript", - "scriptData": "...", - "jobLogging": "true", + "cron_expression": "0 0 3 * * ?", + "script_type": "javascript", + "script_data": "...", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 1, - "versionNo": 1 + "sort_order": 1, + "version_no": 1 } .. note:: - Pour les mises à jour, ``id`` (max 1000 caractères) et ``versionNo`` sont obligatoires. ``versionNo`` est utilisé pour le verrouillage optimiste ; spécifiez la valeur retournée dans la réponse de récupération. Si la valeur ne correspond pas, la mise à jour échoue. Les autres champs obligatoires (``name`` / ``target`` / ``scriptType`` / ``sortOrder``) sont identiques à ceux de la création. + Pour les mises à jour, ``id`` (max 1000 caractères) et ``version_no`` sont obligatoires. ``version_no`` est utilisé pour le verrouillage optimiste ; spécifiez la valeur retournée dans la réponse de récupération. Si la valeur ne correspond pas, la mise à jour échoue. Les autres champs obligatoires (``name`` / ``target`` / ``script_type`` / ``sort_order``) sont identiques à ceux de la création. Réponse ------- @@ -344,7 +344,7 @@ Réponse { "response": { "status": 0, - "jobLogId": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6" + "job_log_id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6" } } @@ -357,15 +357,15 @@ Champs de la réponse * - Champ - Description - * - ``jobLogId`` - - ID du journal de la tâche démarrée. Émis lorsque la journalisation des tâches est activée. Vaut ``null`` lorsque la journalisation des tâches est désactivée. + * - ``job_log_id`` + - ID du journal de la tâche démarrée. Émis lorsque la journalisation des tâches est activée. Absent de la réponse lorsque la journalisation des tâches est désactivée. Notes ----- - Si la tâche est déjà en cours d'exécution, le démarrage échoue et une erreur est retournée (``status`` différent de ``0``). - Si la tâche est désactivée (``available`` n'est pas activé), le démarrage échoue également avec une erreur. -- ``jobLogId`` est émis uniquement lorsque la journalisation des tâches est activée (``jobLogging`` est activé). +- ``job_log_id`` est émis uniquement lorsque la journalisation des tâches est activée (``job_logging`` est activé). Arrêt d'une tâche ================= @@ -405,13 +405,13 @@ Création et exécution d'une tâche de crawl -d '{ "name": "Hourly Crawler", "target": "all", - "cronExpression": "0 0 * * * ?", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "jobLogging": "true", + "cron_expression": "0 0 * * * ?", + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 1 + "sort_order": 1 }' # Exécuter la tâche immédiatement diff --git a/fr/15.9/api/admin/api-admin-suggest.rst b/fr/15.9/api/admin/api-admin-suggest.rst index 5f5709097..ae1f04637 100644 --- a/fr/15.9/api/admin/api-admin-suggest.rst +++ b/fr/15.9/api/admin/api-admin-suggest.rst @@ -76,9 +76,9 @@ Réponse "version": "15.9.0", "status": 0, "setting": { - "totalWordsNum": 1500, - "documentWordsNum": 1200, - "queryWordsNum": 450 + "total_words_num": 1500, + "document_words_num": 1200, + "query_words_num": 450 } } } @@ -92,18 +92,18 @@ Champs de la réponse * - Champ - Description - * - ``setting.totalWordsNum`` + * - ``setting.total_words_num`` - Nombre total de mots de suggestion (nombre de mots de suggestion enregistrés dans l'index de suggestion) - * - ``setting.documentWordsNum`` + * - ``setting.document_words_num`` - Nombre de mots de suggestion issus des documents (nombre de mots de suggestion dont la fréquence documentaire est supérieure ou égale à 1) - * - ``setting.queryWordsNum`` + * - ``setting.query_words_num`` - Nombre de mots de suggestion issus des requêtes de recherche (nombre de mots de suggestion dont la fréquence de requête est supérieure ou égale à 1) .. note:: - ``documentWordsNum`` et ``queryWordsNum`` ne sont pas exclusifs l'un de l'autre. Si un mot de suggestion est issu + ``document_words_num`` et ``query_words_num`` ne sont pas exclusifs l'un de l'autre. Si un mot de suggestion est issu à la fois d'un document et d'une requête de recherche, il est comptabilisé dans les deux totaux. Par conséquent, - la somme de ``documentWordsNum`` et de ``queryWordsNum`` peut ne pas correspondre à ``totalWordsNum``. + la somme de ``document_words_num`` et de ``query_words_num`` peut ne pas correspondre à ``total_words_num``. Suppression de tous les mots de suggestion ========================================== diff --git a/fr/15.9/api/admin/api-admin-systeminfo.rst b/fr/15.9/api/admin/api-admin-systeminfo.rst index 34b6fa106..5f66d38d1 100644 --- a/fr/15.9/api/admin/api-admin-systeminfo.rst +++ b/fr/15.9/api/admin/api-admin-systeminfo.rst @@ -55,22 +55,22 @@ La réponse contient ``version`` indiquant la version du produit, ``status`` ind "response": { "version": "15.9.0", "status": 0, - "envProps": [ + "env_props": [ {"label": "JAVA_HOME", "value": "/usr/lib/jvm/java-21"}, {"label": "FESS_DICTIONARY_PATH", "value": "/var/lib/fess/dict"} ], - "systemProps": [ + "system_props": [ {"label": "java.version", "value": "21.0.1"}, {"label": "java.vendor", "value": "Oracle Corporation"}, {"label": "os.name", "value": "Linux"}, {"label": "user.dir", "value": "/opt/fess"} ], - "fessProps": [ + "fess_props": [ {"label": "crawler.document.max.site.length", "value": "100"}, {"label": "indexer.thread.dump.enabled", "value": "true"}, {"label": "app.cipher.key", "value": "XXXXXXXX"} ], - "bugReportProps": [ + "bug_report_props": [ {"label": "os.name", "value": "Linux"}, {"label": "java.vm.version", "value": "21.0.1+12"} ] @@ -90,24 +90,24 @@ Champs de la réponse - Version du produit |Fess| (ex. : ``15.9.0``). * - ``status`` - Code indiquant le résultat du traitement. ``0`` signifie une terminaison normale. - * - ``envProps`` + * - ``env_props`` - Liste des variables d'environnement (tableau de ``label`` / ``value``). Les valeurs retournées sont celles obtenues via ``System.getenv()``, sans modification. - * - ``systemProps`` + * - ``system_props`` - Liste des propriétés système Java (tableau de ``label`` / ``value``). Les valeurs retournées sont celles obtenues via ``System.getProperties()``, sans modification. - * - ``fessProps`` + * - ``fess_props`` - Liste des propriétés de configuration de |Fess| (tableau de ``label`` / ``value``). Inclut les valeurs de ``fess_config.properties`` ainsi que les propriétés système définies via l'interface d'administration. Les éléments sensibles sont masqués (voir la note ci-dessous). - * - ``bugReportProps`` + * - ``bug_report_props`` - Liste des informations collectées pour les rapports de bogues (tableau de ``label`` / ``value``). Inclut les principales propriétés système relatives au système d'exploitation et à l'environnement d'exécution Java (``os.name``, ``os.version``, ``java.vm.version``, etc.) ainsi que les valeurs des propriétés système de |Fess|. .. note:: - Dans ``fessProps``, les valeurs de configuration suivantes, jugées sensibles, sont masquées et retournées sous la forme ``XXXXXXXX`` : + Dans ``fess_props``, les valeurs de configuration suivantes, jugées sensibles, sont masquées et retournées sous la forme ``XXXXXXXX`` : ``http.proxy.password``, ``ldap.admin.security.credentials``, ``spnego.preauth.password``, ``app.cipher.key``, ``oic.client.id``, ``oic.client.secret``. .. warning:: - ``envProps`` (variables d'environnement) et ``systemProps`` (propriétés système Java) ne sont pas masquées : + ``env_props`` (variables d'environnement) et ``system_props`` (propriétés système Java) ne sont pas masquées : les valeurs configurées sont retournées telles quelles. Si des informations confidentielles (identifiants, mots de passe, etc.) sont stockées dans des variables d'environnement ou des propriétés système, elles apparaîtront dans la réponse. diff --git a/fr/15.9/api/admin/api-admin-user.rst b/fr/15.9/api/admin/api-admin-user.rst index a19d6c7dd..906b8e779 100644 --- a/fr/15.9/api/admin/api-admin-user.rst +++ b/fr/15.9/api/admin/api-admin-user.rst @@ -105,7 +105,7 @@ Réponse }, "roles": ["admin"], "groups": [], - "versionNo": 1 + "version_no": 1 } ], "total": 10 @@ -150,7 +150,7 @@ Réponse }, "roles": ["admin"], "groups": [], - "versionNo": 1 + "version_no": 1 } } } @@ -179,7 +179,7 @@ Corps de la requête { "name": "testuser", "password": "securepassword", - "confirmPassword": "securepassword", + "confirm_password": "securepassword", "attributes": { "surname": "Test", "givenName": "User", @@ -205,7 +205,7 @@ Description des champs * - ``password`` - Non - Mot de passe - * - ``confirmPassword`` + * - ``confirm_password`` - Non - Mot de passe de confirmation * - ``attributes`` @@ -220,8 +220,8 @@ Description des champs .. note:: - L'API REST n'effectue pas de vérification d'obligation du mot de passe, de vérification de correspondance entre ``password`` et ``confirmPassword``, ni de validation de politique de mot de passe (celles-ci ne s'appliquent que dans l'interface d'administration). - En pratique, il est recommandé de spécifier un ``password`` valide dont la valeur correspond à ``confirmPassword``. + L'API REST n'effectue pas de vérification d'obligation du mot de passe, de vérification de correspondance entre ``password`` et ``confirm_password``, ni de validation de politique de mot de passe (celles-ci ne s'appliquent que dans l'interface d'administration). + En pratique, il est recommandé de spécifier un ``password`` valide dont la valeur correspond à ``confirm_password``. Les clés de ``attributes`` sont les noms d'attributs de l'entité utilisateur (les noms d'éléments dérivés du schéma LDAP). Les clés les plus courantes sont : @@ -276,7 +276,7 @@ Corps de la requête "id": "existing_user_id", "name": "testuser", "password": "newpassword", - "confirmPassword": "newpassword", + "confirm_password": "newpassword", "attributes": { "surname": "Test", "givenName": "User Updated", @@ -284,7 +284,7 @@ Corps de la requête }, "roles": ["user", "editor"], "groups": ["group_id_1", "group_id_2"], - "versionNo": 1 + "version_no": 1 } Description des champs @@ -303,13 +303,13 @@ Description des champs * - ``name`` - Oui - Nom d'utilisateur (identifiant de connexion) - * - ``versionNo`` + * - ``version_no`` - Oui - Numéro de version (pour le verrouillage optimiste) * - ``password`` - Non - Nouveau mot de passe (mis à jour uniquement si spécifié) - * - ``confirmPassword`` + * - ``confirm_password`` - Non - Mot de passe de confirmation * - ``attributes`` @@ -324,8 +324,8 @@ Description des champs .. note:: - Lors de la mise à jour, ``id``, ``name`` et ``versionNo`` sont obligatoires. - ``versionNo`` est la valeur retournée lors de la récupération de l'utilisateur cible (GET), et correspond à la version du document OpenSearch. + Lors de la mise à jour, ``id``, ``name`` et ``version_no`` sont obligatoires. + ``version_no`` est la valeur retournée lors de la récupération de l'utilisateur cible (GET), et correspond à la version du document OpenSearch. Si elle ne correspond pas à la version actuelle, la requête est traitée comme un conflit et la mise à jour est rejetée. Réponse @@ -390,7 +390,7 @@ Créer un nouvel utilisateur -d '{ "name": "john.doe", "password": "SecureP@ss123", - "confirmPassword": "SecureP@ss123", + "confirm_password": "SecureP@ss123", "attributes": { "surname": "Doe", "givenName": "John", @@ -412,7 +412,7 @@ Modifier les rôles d'un utilisateur "id": "user_id_123", "name": "john.doe", "roles": ["user", "editor", "admin"], - "versionNo": 1 + "version_no": 1 }' Références diff --git a/fr/15.9/api/admin/api-admin-webconfig.rst b/fr/15.9/api/admin/api-admin-webconfig.rst index a99a74902..88bc18c8f 100644 --- a/fr/15.9/api/admin/api-admin-webconfig.rst +++ b/fr/15.9/api/admin/api-admin-webconfig.rst @@ -106,21 +106,21 @@ Réponse "name": "Example Site", "description": "Site d'exemple", "urls": "https://example.com/", - "includedUrls": ".*example\\.com.*", - "excludedUrls": ".*\\.(pdf|zip)$", - "includedDocUrls": "", - "excludedDocUrls": "", - "configParameter": "", + "included_urls": ".*example\\.com.*", + "excluded_urls": ".*\\.(pdf|zip)$", + "included_doc_urls": "", + "excluded_doc_urls": "", + "config_parameter": "", "depth": 3, - "maxAccessCount": 1000, - "userAgent": "Mozilla/5.0", - "numOfThread": 1, - "intervalTime": 1000, + "max_access_count": 1000, + "user_agent": "Mozilla/5.0", + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, "available": "true", "permissions": "{role}admin", - "virtualHosts": "", - "sortOrder": 0 + "virtual_hosts": "", + "sort_order": 0 } ], "total": 5 @@ -152,36 +152,36 @@ Réponse "name": "Example Site", "description": "Site d'exemple", "urls": "https://example.com/", - "includedUrls": ".*example\\.com.*", - "excludedUrls": ".*\\.(pdf|zip)$", - "includedDocUrls": "", - "excludedDocUrls": "", - "configParameter": "", + "included_urls": ".*example\\.com.*", + "excluded_urls": ".*\\.(pdf|zip)$", + "included_doc_urls": "", + "excluded_doc_urls": "", + "config_parameter": "", "depth": 3, - "maxAccessCount": 1000, - "userAgent": "Mozilla/5.0", - "numOfThread": 1, - "intervalTime": 1000, + "max_access_count": 1000, + "user_agent": "Mozilla/5.0", + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin", - "virtualHosts": "", - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_hosts": "", + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } .. note:: - La réponse inclut les champs d'audit ``createdBy``, ``createdTime``, - ``updatedBy``, ``updatedTime`` et ``versionNo``, qui sont définis automatiquement + La réponse inclut les champs d'audit ``created_by``, ``created_time``, + ``updated_by``, ``updated_time`` et ``version_no``, qui sont définis automatiquement lors de la création ou de la mise à jour. - ``versionNo`` est requis lors de la mise à jour (voir la section « Mise à jour d'une configuration de crawl Web » ci-dessous). + ``version_no`` est requis lors de la mise à jour (voir la section « Mise à jour d'une configuration de crawl Web » ci-dessous). Création d'une configuration de crawl Web ========================================= @@ -202,14 +202,14 @@ Corps de la requête { "name": "Corporate Site", "urls": "https://www.example.com/", - "includedUrls": ".*www\\.example\\.com.*", - "excludedUrls": ".*\\.(pdf|zip|exe)$", - "userAgent": "Mozilla/5.0", - "numOfThread": 3, - "intervalTime": 500, + "included_urls": ".*www\\.example\\.com.*", + "excluded_urls": ".*\\.(pdf|zip|exe)$", + "user_agent": "Mozilla/5.0", + "num_of_thread": 3, + "interval_time": 500, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin\n{role}user" } @@ -232,34 +232,34 @@ Description des champs * - ``urls`` - Oui - URLs de départ du crawl (séparées par des sauts de ligne si multiples). Indiquez ``http:`` ou ``https:`` - * - ``includedUrls`` + * - ``included_urls`` - Non - Expression régulière des URLs à crawler - * - ``excludedUrls`` + * - ``excluded_urls`` - Non - Expression régulière des URLs à exclure du crawl - * - ``includedDocUrls`` + * - ``included_doc_urls`` - Non - Expression régulière des URLs à indexer - * - ``excludedDocUrls`` + * - ``excluded_doc_urls`` - Non - Expression régulière des URLs à exclure de l'indexation - * - ``configParameter`` + * - ``config_parameter`` - Non - Paramètres de configuration supplémentaires (format ``key=value``, un par ligne) * - ``depth`` - Non - Profondeur du crawl (0 ou plus) - * - ``maxAccessCount`` + * - ``max_access_count`` - Non - Nombre maximum d'accès (0 ou plus) - * - ``userAgent`` + * - ``user_agent`` - Oui - Chaîne User-Agent (200 caractères maximum) - * - ``numOfThread`` + * - ``num_of_thread`` - Oui - Nombre de threads parallèles (1 ou plus) - * - ``intervalTime`` + * - ``interval_time`` - Oui - Intervalle entre les accès (en millisecondes, 0 ou plus) * - ``boost`` @@ -268,19 +268,19 @@ Description des champs * - ``available`` - Oui - Activé/Désactivé (chaîne ``"true"`` / ``"false"``) - * - ``sortOrder`` + * - ``sort_order`` - Oui - Ordre d'affichage (0 ou plus) * - ``permissions`` - Non - Rôles autorisés (séparés par des sauts de ligne si plusieurs) - * - ``virtualHosts`` + * - ``virtual_hosts`` - Non - Hôtes virtuels (séparés par des sauts de ligne si plusieurs) .. note:: - Les champs d'audit tels que ``createdBy``, ``createdTime``, ``updatedBy`` et ``updatedTime`` + Les champs d'audit tels que ``created_by``, ``created_time``, ``updated_by`` et ``updated_time`` sont définis automatiquement côté serveur et n'ont pas besoin d'être fournis dans le corps de la requête. Réponse @@ -310,8 +310,8 @@ Requête Corps de la requête ~~~~~~~~~~~~~~~~~~~ -Lors d'une mise à jour, les champs de création sont complétés par ``id``, qui identifie la configuration à mettre à jour, et ``versionNo``, le numéro de version actuel. -Indiquez pour ``versionNo`` la valeur renvoyée par l'API de récupération (GET). +Lors d'une mise à jour, les champs de création sont complétés par ``id``, qui identifie la configuration à mettre à jour, et ``version_no``, le numéro de version actuel. +Indiquez pour ``version_no`` la valeur renvoyée par l'API de récupération (GET). .. code-block:: json @@ -319,17 +319,17 @@ Indiquez pour ``versionNo`` la valeur renvoyée par l'API de récupération (GET "id": "existing_webconfig_id", "name": "Updated Corporate Site", "urls": "https://www.example.com/", - "includedUrls": ".*www\\.example\\.com.*", - "excludedUrls": ".*\\.(pdf|zip|exe|dmg)$", - "userAgent": "Mozilla/5.0", + "included_urls": ".*www\\.example\\.com.*", + "excluded_urls": ".*\\.(pdf|zip|exe|dmg)$", + "user_agent": "Mozilla/5.0", "depth": 10, - "maxAccessCount": 10000, - "numOfThread": 5, - "intervalTime": 300, + "max_access_count": 10000, + "num_of_thread": 5, + "interval_time": 300, "boost": 1.2, "available": "true", - "sortOrder": 0, - "versionNo": 1 + "sort_order": 0, + "version_no": 1 } Champs supplémentaires pour la mise à jour @@ -345,9 +345,9 @@ Champs supplémentaires pour la mise à jour * - ``id`` - Oui - Identifiant de la configuration à mettre à jour (1 000 caractères maximum) - * - ``versionNo`` + * - ``version_no`` - Oui - - Numéro de version actuel de la configuration à mettre à jour. Indiquez la valeur ``versionNo`` contenue dans la réponse de l'API de récupération (GET) + - Numéro de version actuel de la configuration à mettre à jour. Indiquez la valeur ``version_no`` contenue dans la réponse de l'API de récupération (GET) Réponse ------- @@ -386,7 +386,7 @@ Réponse Exemples de patterns d'URL ========================== -Les champs ``includedUrls`` / ``excludedUrls`` / ``includedDocUrls`` / ``excludedDocUrls`` acceptent des expressions régulières. +Les champs ``included_urls`` / ``excluded_urls`` / ``included_doc_urls`` / ``excluded_doc_urls`` acceptent des expressions régulières. .. list-table:: :header-rows: 1 @@ -419,16 +419,16 @@ Configuration de crawl pour un site d'entreprise -d '{ "name": "Corporate Website", "urls": "https://www.example.com/", - "includedUrls": ".*www\\.example\\.com.*", - "excludedUrls": ".*/(login|admin|api)/.*", - "userAgent": "Mozilla/5.0", + "included_urls": ".*www\\.example\\.com.*", + "excluded_urls": ".*/(login|admin|api)/.*", + "user_agent": "Mozilla/5.0", "depth": 5, - "maxAccessCount": 10000, - "numOfThread": 3, - "intervalTime": 500, + "max_access_count": 10000, + "num_of_thread": 3, + "interval_time": 500, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}guest" }' @@ -443,15 +443,15 @@ Configuration de crawl pour un site de documentation -d '{ "name": "Documentation Site", "urls": "https://docs.example.com/", - "includedUrls": ".*docs\\.example\\.com.*", - "includedDocUrls": ".*\\.(html|htm)$", - "userAgent": "Mozilla/5.0", - "maxAccessCount": 50000, - "numOfThread": 5, - "intervalTime": 200, + "included_urls": ".*docs\\.example\\.com.*", + "included_doc_urls": ".*\\.(html|htm)$", + "user_agent": "Mozilla/5.0", + "max_access_count": 50000, + "num_of_thread": 5, + "interval_time": 200, "boost": 1.5, "available": "true", - "sortOrder": 0 + "sort_order": 0 }' Informations complémentaires diff --git a/ja/15.9/api/admin/api-admin-accesstoken.rst b/ja/15.9/api/admin/api-admin-accesstoken.rst index e9cc00c2c..45652231d 100644 --- a/ja/15.9/api/admin/api-admin-accesstoken.rst +++ b/ja/15.9/api/admin/api-admin-accesstoken.rst @@ -98,14 +98,14 @@ HTTPステータスコード）については :doc:`api-admin-overview` を参 "id": "token_id_1", "name": "API Token 1", "token": "abcd1234efgh5678", - "parameterName": "permission", + "parameter_name": "permission", "permissions": "{role}admin-api", "expires": "2026-01-01T00:00:00", - "createdBy": "admin", - "createdTime": 1735689600000, - "updatedBy": "admin", - "updatedTime": 1735689600000, - "versionNo": 1 + "created_by": "admin", + "created_time": 1735689600000, + "updated_by": "admin", + "updated_time": 1735689600000, + "version_no": 1 } ], "total": 5 @@ -114,9 +114,9 @@ HTTPステータスコード）については :doc:`api-admin-overview` を参 .. note:: - 各トークンオブジェクトには、 ``createdBy`` 、 ``createdTime`` 、 ``updatedBy`` 、 - ``updatedTime`` 、 ``versionNo`` といった監査情報・バージョン情報も含まれます。 - ``createdTime`` と ``updatedTime`` はエポックからのミリ秒（数値）です。 + 各トークンオブジェクトには、 ``created_by`` 、 ``created_time`` 、 ``updated_by`` 、 + ``updated_time`` 、 ``version_no`` といった監査情報・バージョン情報も含まれます。 + ``created_time`` と ``updated_time`` はエポックからのミリ秒（数値）です。 値が ``null`` のフィールドはレスポンスから除外されます。 ``permissions`` は改行（ ``\n`` ）区切りの文字列として返されます。 @@ -142,14 +142,14 @@ HTTPステータスコード）については :doc:`api-admin-overview` を参 "id": "token_id_1", "name": "API Token 1", "token": "abcd1234efgh5678", - "parameterName": "permission", + "parameter_name": "permission", "permissions": "{role}admin-api", "expires": "2026-01-01T00:00:00", - "createdBy": "admin", - "createdTime": 1735689600000, - "updatedBy": "admin", - "updatedTime": 1735689600000, - "versionNo": 1 + "created_by": "admin", + "created_time": 1735689600000, + "updated_by": "admin", + "updated_time": 1735689600000, + "version_no": 1 } } } @@ -192,7 +192,7 @@ HTTPステータスコード）については :doc:`api-admin-overview` を参 * - ``permissions`` - いいえ - このトークンに付与する権限。改行（ ``\n`` ）区切りで複数指定できます（例: ``{role}admin-api`` ）。Admin APIを呼び出すトークンには、 ``api.admin.access.permissions`` （既定値 ``{role}admin-api`` ）に一致する権限が必要です。 - * - ``parameterName`` + * - ``parameter_name`` - いいえ - 追加権限を渡すためのリクエストパラメーター名。このトークンで認証されたリクエストに、ここで指定した名前のパラメーターが含まれる場合、その値が ``permissions`` に追加されます。省略した場合は設定されません。 * - ``expires`` @@ -239,7 +239,7 @@ HTTPステータスコード）については :doc:`api-admin-overview` を参 "name": "Updated API Token", "permissions": "{role}admin-api\n{role}user", "expires": "2026-01-01T00:00:00", - "versionNo": 1 + "version_no": 1 } フィールド説明 @@ -257,9 +257,9 @@ HTTPステータスコード）については :doc:`api-admin-overview` を参 * - ``id`` - はい - 更新対象のトークンID - * - ``versionNo`` + * - ``version_no`` - はい - - 楽観ロック用のバージョン番号。事前に取得したトークンの ``versionNo`` を指定します。 + - 楽観ロック用のバージョン番号。事前に取得したトークンの ``version_no`` を指定します。 .. note:: diff --git a/ja/15.9/api/admin/api-admin-badword.rst b/ja/15.9/api/admin/api-admin-badword.rst index b0aab5e76..9f18b124a 100644 --- a/ja/15.9/api/admin/api-admin-badword.rst +++ b/ja/15.9/api/admin/api-admin-badword.rst @@ -92,7 +92,7 @@ NGワード一覧取得 "settings": [ { "id": "badword_id_1", - "suggestWord": "inappropriate_word" + "suggest_word": "inappropriate_word" } ], "total": 5 @@ -119,7 +119,7 @@ NGワード取得 "status": 0, "setting": { "id": "badword_id_1", - "suggestWord": "inappropriate_word" + "suggest_word": "inappropriate_word" } } } @@ -141,7 +141,7 @@ NGワード作成 .. code-block:: json { - "suggestWord": "spam_keyword" + "suggest_word": "spam_keyword" } フィールド説明 @@ -154,7 +154,7 @@ NGワード作成 * - フィールド - 必須 - 説明 - * - ``suggestWord`` + * - ``suggest_word`` - はい - 除外するキーワード（空白文字を含めることはできません） @@ -189,8 +189,8 @@ NGワード更新 { "id": "existing_badword_id", - "suggestWord": "updated_spam_keyword", - "versionNo": 1 + "suggest_word": "updated_spam_keyword", + "version_no": 1 } レスポンス @@ -260,7 +260,7 @@ CSVフォーマット ~~~~~~~~~~~~~~~ - 1行目はヘッダー行として読み飛ばされます（列名は任意。ダウンロード時は ``BadWord`` が出力されます）。 -- 2行目以降は、1行に1つのNGワードを ``suggestWord`` として記述します。 +- 2行目以降は、1行に1つのNGワードを ``suggest_word`` として記述します。 - 値が空白のみの行は無視されます。 - 単語の先頭に ``--`` を付けると、その単語を削除します（例: ``--spam`` は ``spam`` を削除）。 - 既に登録済みの単語を指定した場合は更新（更新者・更新日時の再設定）として扱われます。 @@ -306,7 +306,7 @@ CSVは1行目に ``BadWord`` というヘッダー行を持ち、2行目以降 -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "suggestWord": "spam" + "suggest_word": "spam" }' CSVファイルのアップロード diff --git a/ja/15.9/api/admin/api-admin-boostdoc.rst b/ja/15.9/api/admin/api-admin-boostdoc.rst index 40cd1de24..c78551c33 100644 --- a/ja/15.9/api/admin/api-admin-boostdoc.rst +++ b/ja/15.9/api/admin/api-admin-boostdoc.rst @@ -10,18 +10,18 @@ BoostDoc APIは、|Fess| のドキュメントブースト設定を管理する 検索結果の上位に表示されやすくできます。 ブーストはインデックス作成時（クロール時）に各ドキュメントへ適用されます。 -条件（``urlExpr``）とブースト値（``boostExpr``）は、``scriptType`` フィールドで指定したスクリプトエンジンの式として評価されます。 -``scriptType`` に指定できるのは ``javascript`` と ``groovy``\ （``fess-script-groovy`` プラグインが必要）です。管理画面の新規作成画面では -``scriptType`` に ``javascript`` があらかじめ入力されますが、このAPIのリクエストボディで ``scriptType`` を省略した場合は +条件（``url_expr``）とブースト値（``boost_expr``）は、``script_type`` フィールドで指定したスクリプトエンジンの式として評価されます。 +``script_type`` に指定できるのは ``javascript`` と ``groovy``\ （``fess-script-groovy`` プラグインが必要）です。管理画面の新規作成画面では +``script_type`` に ``javascript`` があらかじめ入力されますが、このAPIのリクエストボディで ``script_type`` を省略した場合は 自動補完されず、Groovyとして評価されます。 -複数のルールは ``sortOrder`` の昇順で評価され、最初に条件が一致したルールのブースト値のみが適用されます +複数のルールは ``sort_order`` の昇順で評価され、最初に条件が一致したルールのブースト値のみが適用されます （一致したルールが見つかると、それ以降のルールは評価されません）。 .. note:: - 管理画面では、``urlExpr`` は「条件」、``boostExpr`` は「ブースト値式」、``scriptType`` は「スクリプト種別」として表示されます。 - ``scriptType`` は作成・更新・取得（一覧・詳細）のリクエストボディおよびレスポンスにのみ含まれ、 - 一覧取得のフィルタパラメーター（``urlExpr``、``boostExpr``）には含まれません。 + 管理画面では、``url_expr`` は「条件」、``boost_expr`` は「ブースト値式」、``script_type`` は「スクリプト種別」として表示されます。 + ``script_type`` は作成・更新・取得（一覧・詳細）のリクエストボディおよびレスポンスにのみ含まれ、 + 一覧取得のフィルタパラメーター（``url_expr``、``boost_expr``）には含まれません。 設定項目の詳細は :doc:`../../admin/boostdoc-guide` を参照してください。 ベースURL @@ -92,11 +92,11 @@ BoostDoc APIは、|Fess| のドキュメントブースト設定を管理する - Integer - いいえ - ページ番号（1から開始。デフォルト: 1） - * - ``urlExpr`` + * - ``url_expr`` - String - いいえ - 条件式による絞り込み（部分一致） - * - ``boostExpr`` + * - ``boost_expr`` - String - いいえ - ブースト値式による絞り込み（部分一致） @@ -112,11 +112,11 @@ BoostDoc APIは、|Fess| のドキュメントブースト設定を管理する "settings": [ { "id": "boostdoc_id_1", - "urlExpr": "url.startsWith(\"https://docs.example.com/\")", - "boostExpr": "3.0", - "scriptType": "javascript", - "sortOrder": 1, - "versionNo": 1 + "url_expr": "url.startsWith(\"https://docs.example.com/\")", + "boost_expr": "3.0", + "script_type": "javascript", + "sort_order": 1, + "version_no": 1 } ], "total": 5 @@ -126,8 +126,8 @@ BoostDoc APIは、|Fess| のドキュメントブースト設定を管理する .. note:: レスポンスの各設定オブジェクトには、上記フィールドに加えて、作成・更新に関するメタデータ - （``createdBy``、``createdTime``、``updatedBy``、``updatedTime``）も含まれます。 - ``versionNo`` は更新（PUT）時に必須となるため、更新前に取得・一覧APIで現在の値を確認してください。 + （``created_by``、``created_time``、``updated_by``、``updated_time``）も含まれます。 + ``version_no`` は更新（PUT）時に必須となるため、更新前に取得・一覧APIで現在の値を確認してください。 ドキュメントブースト取得 ======================== @@ -149,11 +149,11 @@ BoostDoc APIは、|Fess| のドキュメントブースト設定を管理する "status": 0, "setting": { "id": "boostdoc_id_1", - "urlExpr": "url.startsWith(\"https://docs.example.com/\")", - "boostExpr": "3.0", - "scriptType": "javascript", - "sortOrder": 1, - "versionNo": 1 + "url_expr": "url.startsWith(\"https://docs.example.com/\")", + "boost_expr": "3.0", + "script_type": "javascript", + "sort_order": 1, + "version_no": 1 } } } @@ -175,10 +175,10 @@ BoostDoc APIは、|Fess| のドキュメントブースト設定を管理する .. code-block:: json { - "urlExpr": "url.startsWith(\"https://important.example.com/\")", - "boostExpr": "5.0", - "scriptType": "javascript", - "sortOrder": 0 + "url_expr": "url.startsWith(\"https://important.example.com/\")", + "boost_expr": "5.0", + "script_type": "javascript", + "sort_order": 0 } フィールド説明 @@ -191,16 +191,16 @@ BoostDoc APIは、|Fess| のドキュメントブースト設定を管理する * - フィールド - 必須 - 説明 - * - ``urlExpr`` + * - ``url_expr`` - はい - 条件式。ブースト対象のドキュメントを判定するスクリプト式で、``Boolean`` を返します。管理画面の「条件」に相当します（最大10000文字）。 - * - ``boostExpr`` + * - ``boost_expr`` - はい - ブースト値式。ブースト値（数値）を返すスクリプト式です。\ ``3.0`` のような固定値も指定できます。管理画面の「ブースト値式」に相当します（最大10000文字）。 - * - ``scriptType`` + * - ``script_type`` - いいえ - - ``urlExpr`` と ``boostExpr`` を評価するスクリプトエンジン。\ ``javascript`` または ``groovy``\ （``fess-script-groovy`` プラグインが必要）を指定します。管理画面の「スクリプト種別」に相当します（最大100文字）。省略した場合はGroovyとして評価されます。 - * - ``sortOrder`` + - ``url_expr`` と ``boost_expr`` を評価するスクリプトエンジン。\ ``javascript`` または ``groovy``\ （``fess-script-groovy`` プラグインが必要）を指定します。管理画面の「スクリプト種別」に相当します（最大100文字）。省略した場合はGroovyとして評価されます。 + * - ``sort_order`` - はい - 適用順序。ルールは昇順で評価され、最初に条件が一致したルールのブースト値が適用されます（フォーム初期値: 0、0以上の整数）。 @@ -235,15 +235,15 @@ BoostDoc APIは、|Fess| のドキュメントブースト設定を管理する { "id": "existing_boostdoc_id", - "urlExpr": "url.startsWith(\"https://important.example.com/\")", - "boostExpr": "10.0", - "scriptType": "javascript", - "sortOrder": 0, - "versionNo": 1 + "url_expr": "url.startsWith(\"https://important.example.com/\")", + "boost_expr": "10.0", + "script_type": "javascript", + "sort_order": 0, + "version_no": 1 } -更新時は、作成時のフィールドに加えて ``id``\ （更新対象のID、最大1000文字）と ``versionNo``\ （楽観的ロック用のバージョン番号）が必須です。 -``versionNo`` には、取得・一覧APIのレスポンスに含まれる現在のバージョン番号を指定します。バージョン番号が一致しない場合、更新は失敗します。 +更新時は、作成時のフィールドに加えて ``id``\ （更新対象のID、最大1000文字）と ``version_no``\ （楽観的ロック用のバージョン番号）が必須です。 +``version_no`` には、取得・一覧APIのレスポンスに含まれる現在のバージョン番号を指定します。バージョン番号が一致しない場合、更新は失敗します。 レスポンス ---------- @@ -282,11 +282,11 @@ BoostDoc APIは、|Fess| のドキュメントブースト設定を管理する 条件式・ブースト値式について ============================ -``urlExpr``\ （条件）と ``boostExpr``\ （ブースト値式）は、``scriptType``\ （既定: Groovy。管理画面の新規作成画面のみ ``javascript`` を事前入力）で指定したスクリプトエンジンの式として評価されます。 +``url_expr``\ （条件）と ``boost_expr``\ （ブースト値式）は、``script_type``\ （既定: Groovy。管理画面の新規作成画面のみ ``javascript`` を事前入力）で指定したスクリプトエンジンの式として評価されます。 式の中では、インデックス対象ドキュメントのフィールド値をフィールド名の変数として参照できます。 -- ``urlExpr`` は ``Boolean`` を返す必要があります（例: ``url.startsWith("https://docs.example.com/")``）。単なる正規表現文字列（例: ``.*docs\.example\.com.*``）はスクリプト式として ``Boolean`` を返さないため、条件として機能しません。正規表現を使う場合は ``String#matches`` を利用します（GroovyとJavaScriptのいずれでも同じ記法で使用できます）。 -- ``boostExpr`` は数値を返す必要があります。結果は ``float`` に変換され、0より大きい場合にのみブーストが適用されます。 +- ``url_expr`` は ``Boolean`` を返す必要があります（例: ``url.startsWith("https://docs.example.com/")``）。単なる正規表現文字列（例: ``.*docs\.example\.com.*``）はスクリプト式として ``Boolean`` を返さないため、条件として機能しません。正規表現を使う場合は ``String#matches`` を利用します（GroovyとJavaScriptのいずれでも同じ記法で使用できます）。 +- ``boost_expr`` は数値を返す必要があります。結果は ``float`` に変換され、0より大きい場合にのみブーストが適用されます。 .. note:: @@ -295,8 +295,8 @@ BoostDoc APIは、|Fess| のドキュメントブースト設定を管理する ``indexer.favorite.count.enabled``\ （いずれもデフォルトで有効）の場合に参照できます。 ``now - 7d`` のようなOpenSearchの日付計算構文は、GroovyでもJavaScriptでも使用できません。 -条件式（``urlExpr``）の例 -------------------------- +条件式（``url_expr``）の例 +-------------------------- .. list-table:: :header-rows: 1 @@ -311,8 +311,8 @@ BoostDoc APIは、|Fess| のドキュメントブースト設定を管理する * - ``title.contains("リリースノート")`` - タイトルに特定の語を含むドキュメントを対象にする -ブースト値式（``boostExpr``）の例 ---------------------------------- +ブースト値式（``boost_expr``）の例 +---------------------------------- .. list-table:: :header-rows: 1 @@ -339,9 +339,9 @@ BoostDoc APIは、|Fess| のドキュメントブースト設定を管理する -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "urlExpr": "url.startsWith(\"https://docs.example.com/\")", - "boostExpr": "5.0", - "sortOrder": 0 + "url_expr": "url.startsWith(\"https://docs.example.com/\")", + "boost_expr": "5.0", + "sort_order": 0 }' クリック数の多いコンテンツのブースト @@ -353,9 +353,9 @@ BoostDoc APIは、|Fess| のドキュメントブースト設定を管理する -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "urlExpr": "url.startsWith(\"https://www.example.com/\")", - "boostExpr": "click_count * 0.1 + 1", - "sortOrder": 10 + "url_expr": "url.startsWith(\"https://www.example.com/\")", + "boost_expr": "click_count * 0.1 + 1", + "sort_order": 10 }' 参考情報 diff --git a/ja/15.9/api/admin/api-admin-crawlinginfo.rst b/ja/15.9/api/admin/api-admin-crawlinginfo.rst index 5fa799ab6..6d72cc1db 100644 --- a/ja/15.9/api/admin/api-admin-crawlinginfo.rst +++ b/ja/15.9/api/admin/api-admin-crawlinginfo.rst @@ -67,7 +67,7 @@ CrawlingInfo APIは、|Fess| のクロール情報（クロールセッション - Integer - いいえ - ページ番号（1から開始、デフォルト: 1） - * - ``sessionId`` + * - ``session_id`` - String - いいえ - セッションIDフィルター（部分一致） @@ -83,17 +83,17 @@ CrawlingInfo APIは、|Fess| のクロール情報（クロールセッション "logs": [ { "id": "crawling_info_id_1", - "sessionId": "20250129100000", + "session_id": "20250129100000", "name": "Default Crawler", - "expiredTime": "1738200000000", - "createdTime": 1738108800000 + "expired_time": "1738200000000", + "created_time": 1738108800000 }, { "id": "crawling_info_id_2", - "sessionId": "20250128100000", + "session_id": "20250128100000", "name": "Default Crawler", - "expiredTime": "1738113600000", - "createdTime": 1738022400000 + "expired_time": "1738113600000", + "created_time": 1738022400000 } ], "total": 10 @@ -111,18 +111,18 @@ CrawlingInfo APIは、|Fess| のクロール情報（クロールセッション - 説明 * - ``id`` - クロール情報ID - * - ``sessionId`` + * - ``session_id`` - セッションID * - ``name`` - セッション名 - * - ``expiredTime`` + * - ``expired_time`` - 有効期限（エポックミリ秒。文字列として返されます） - * - ``createdTime`` + * - ``created_time`` - 作成時刻（エポックミリ秒。数値として返されます） .. note:: - レスポンスの各ログオブジェクトには、内部的に使用される ``crudMode`` フィールド + レスポンスの各ログオブジェクトには、内部的に使用される ``crud_mode`` フィールド （CRUD操作モードを示す整数値で、参照時は常に ``0``）が含まれます。 クライアント側では無視して問題ありません。 @@ -146,10 +146,10 @@ CrawlingInfo APIは、|Fess| のクロール情報（クロールセッション "status": 0, "log": { "id": "crawling_info_id_1", - "sessionId": "20250129100000", + "session_id": "20250129100000", "name": "Default Crawler", - "expiredTime": "1738200000000", - "createdTime": 1738108800000 + "expired_time": "1738200000000", + "created_time": 1738108800000 } } } diff --git a/ja/15.9/api/admin/api-admin-dataconfig.rst b/ja/15.9/api/admin/api-admin-dataconfig.rst index 9e82a9b9e..5a51e1e02 100644 --- a/ja/15.9/api/admin/api-admin-dataconfig.rst +++ b/ja/15.9/api/admin/api-admin-dataconfig.rst @@ -74,7 +74,7 @@ DataConfig APIは、|Fess| のデータストア設定を管理するためのAP - String - いいえ - 設定名による絞り込み - * - ``handlerName`` + * - ``handler_name`` - String - いいえ - ハンドラー名による絞り込み @@ -96,14 +96,14 @@ DataConfig APIは、|Fess| のデータストア設定を管理するためのAP "id": "dataconfig_id_1", "name": "Database Crawler", "description": "データベースクローラー", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/mydb", - "handlerScript": "...", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/mydb", + "handler_script": "...", "boost": 1.0, "available": "true", "permissions": "{role}admin", - "virtualHosts": "", - "sortOrder": 0 + "virtual_hosts": "", + "sort_order": 0 } ], "total": 5 @@ -132,14 +132,14 @@ DataConfig APIは、|Fess| のデータストア設定を管理するためのAP "id": "dataconfig_id_1", "name": "Database Crawler", "description": "データベースクローラー", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/mydb\nusername=dbuser\npassword=dbpass", - "handlerScript": "...", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/mydb\nusername=dbuser\npassword=dbpass", + "handler_script": "...", "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin", - "virtualHosts": "" + "virtual_hosts": "" } } } @@ -162,12 +162,12 @@ DataConfig APIは、|Fess| のデータストア設定を管理するためのAP { "name": "Product Database", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/products\nusername=user\npassword=pass", - "handlerScript": "url=\"https://example.com/product/\" + product_id\ntitle=product_name\ncontent=description", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/products\nusername=user\npassword=pass", + "handler_script": "url=\"https://example.com/product/\" + product_id\ntitle=product_name\ncontent=description", "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin\n{role}user" } @@ -187,13 +187,13 @@ DataConfig APIは、|Fess| のデータストア設定を管理するためのAP * - ``description`` - いいえ - 設定の説明 - * - ``handlerName`` + * - ``handler_name`` - はい - データストアハンドラー名 - * - ``handlerParameter`` + * - ``handler_parameter`` - いいえ - ハンドラーパラメーター（接続情報など） - * - ``handlerScript`` + * - ``handler_script`` - いいえ - データ変換スクリプト * - ``boost`` @@ -202,13 +202,13 @@ DataConfig APIは、|Fess| のデータストア設定を管理するためのAP * - ``available`` - はい - 有効/無効（文字列 ``"true"`` / ``"false"``） - * - ``sortOrder`` + * - ``sort_order`` - はい - 表示順序 * - ``permissions`` - いいえ - アクセス許可ロール（複数の場合は改行区切り） - * - ``virtualHosts`` + * - ``virtual_hosts`` - いいえ - 仮想ホスト（複数の場合は改行区切り） @@ -244,17 +244,17 @@ DataConfig APIは、|Fess| のデータストア設定を管理するためのAP { "id": "existing_dataconfig_id", "name": "Updated Product Database", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/products\nusername=user\npassword=newpass", - "handlerScript": "url=\"https://example.com/product/\" + product_id\ntitle=product_name\ncontent=description + \" \" + features", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/products\nusername=user\npassword=newpass", + "handler_script": "url=\"https://example.com/product/\" + product_id\ntitle=product_name\ncontent=description + \" \" + features", "boost": 1.5, "available": "true", - "sortOrder": 0, - "versionNo": 1 + "sort_order": 0, + "version_no": 1 } -更新リクエストでは、作成時と同じ必須フィールド（``name`` 、 ``handlerName`` 、 ``boost`` 、 -``available`` 、 ``sortOrder`` ）に加えて、以下のフィールドが必須です。 +更新リクエストでは、作成時と同じ必須フィールド（``name`` 、 ``handler_name`` 、 ``boost`` 、 +``available`` 、 ``sort_order`` ）に加えて、以下のフィールドが必須です。 .. list-table:: :header-rows: 1 @@ -266,7 +266,7 @@ DataConfig APIは、|Fess| のデータストア設定を管理するためのAP * - ``id`` - はい - 更新対象の設定ID - * - ``versionNo`` + * - ``version_no`` - はい - 楽観ロック用のバージョン番号（取得時の値を指定） @@ -341,12 +341,12 @@ DataConfig APIは、|Fess| のデータストア設定を管理するためのAP -H "Content-Type: application/json" \ -d '{ "name": "User Database", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/userdb\nusername=dbuser\npassword=dbpass\nsql=SELECT * FROM users WHERE active=true", - "handlerScript": "url=\"https://example.com/user/\" + user_id\ntitle=username\ncontent=profile", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/userdb\nusername=dbuser\npassword=dbpass\nsql=SELECT * FROM users WHERE active=true", + "handler_script": "url=\"https://example.com/user/\" + user_id\ntitle=username\ncontent=profile", "boost": 1.0, "available": "true", - "sortOrder": 0 + "sort_order": 0 }' 参考情報 diff --git a/ja/15.9/api/admin/api-admin-dict.rst b/ja/15.9/api/admin/api-admin-dict.rst index 1f4e120e7..905348e1a 100644 --- a/ja/15.9/api/admin/api-admin-dict.rst +++ b/ja/15.9/api/admin/api-admin-dict.rst @@ -179,7 +179,7 @@ Dict APIは、|Fess| の辞書を管理するためのAPIです。 "settings": [ { "id": 1, - "dictId": "ZjA5...synonym.txt", + "dict_id": "ZjA5...synonym.txt", "inputs": "検索,サーチ", "outputs": "検索,サーチ,リサーチ" } @@ -233,7 +233,7 @@ Dict APIは、|Fess| の辞書を管理するためのAPIです。 "status": 0, "setting": { "id": 1, - "dictId": "ZjA5...synonym.txt", + "dict_id": "ZjA5...synonym.txt", "inputs": "検索,サーチ", "outputs": "検索,サーチ,リサーチ" } @@ -406,7 +406,7 @@ Dict APIは、|Fess| の辞書を管理するためのAPIです。 ============================ 辞書項目の作成・更新リクエストボディおよびレスポンスのフィールドは、辞書種別ごとに異なります。 -``id`` （項目ID）と ``dictId`` （辞書ID）はレスポンスに共通して含まれます。 +``id`` （項目ID）と ``dict_id`` （辞書ID）はレスポンスに共通して含まれます。 .. list-table:: :header-rows: 1 diff --git a/ja/15.9/api/admin/api-admin-elevateword.rst b/ja/15.9/api/admin/api-admin-elevateword.rst index 684ee4682..9c9f379e0 100644 --- a/ja/15.9/api/admin/api-admin-elevateword.rst +++ b/ja/15.9/api/admin/api-admin-elevateword.rst @@ -92,11 +92,11 @@ ElevateWord APIは、|Fess| のエレベートワード（特定キーワード "settings": [ { "id": "elevate_id_1", - "suggestWord": "fess", + "suggest_word": "fess", "reading": "フェス", "permissions": "{role}guest", "boost": 100.0, - "labelTypeIds": [] + "label_type_ids": [] } ], "total": 5 @@ -123,11 +123,11 @@ ElevateWord APIは、|Fess| のエレベートワード（特定キーワード "status": 0, "setting": { "id": "elevate_id_1", - "suggestWord": "fess", + "suggest_word": "fess", "reading": "フェス", "permissions": "{role}guest", "boost": 100.0, - "labelTypeIds": [] + "label_type_ids": [] } } } @@ -149,11 +149,11 @@ ElevateWord APIは、|Fess| のエレベートワード（特定キーワード .. code-block:: json { - "suggestWord": "documentation", + "suggest_word": "documentation", "reading": "ドキュメンテーション", "permissions": "{role}guest", "boost": 100.0, - "labelTypeIds": ["label1"] + "label_type_ids": ["label1"] } フィールド説明 @@ -166,7 +166,7 @@ ElevateWord APIは、|Fess| のエレベートワード（特定キーワード * - フィールド - 必須 - 説明 - * - ``suggestWord`` + * - ``suggest_word`` - はい - エレベート対象のキーワード * - ``reading`` @@ -178,7 +178,7 @@ ElevateWord APIは、|Fess| のエレベートワード（特定キーワード * - ``boost`` - はい - ブースト値（フォーム初期値: 100.0） - * - ``labelTypeIds`` + * - ``label_type_ids`` - いいえ - 対象ラベルID（文字列の配列） @@ -213,12 +213,12 @@ ElevateWord APIは、|Fess| のエレベートワード（特定キーワード { "id": "existing_elevate_id", - "suggestWord": "documentation", + "suggest_word": "documentation", "reading": "ドキュメンテーション", "permissions": "{role}guest\n{role}user", "boost": 100.0, - "labelTypeIds": ["label1"], - "versionNo": 1 + "label_type_ids": ["label1"], + "version_no": 1 } .. note:: @@ -226,7 +226,7 @@ ElevateWord APIは、|Fess| のエレベートワード（特定キーワード 更新時は、作成時のフィールドに加えて以下のフィールドが必須です。 - ``id`` - 更新対象のエレベートワードID - - ``versionNo`` - 楽観的ロック用のバージョン番号。\ ``GET /setting/{id}`` で取得した値を指定します。 + - ``version_no`` - 楽観的ロック用のバージョン番号。\ ``GET /setting/{id}`` で取得した値を指定します。 レスポンス ---------- @@ -326,7 +326,7 @@ CSVファイルからエレベートワードを一括登録します。ファ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "suggestWord": "Product X", + "suggest_word": "Product X", "boost": 100.0, "permissions": "{role}guest" }' @@ -340,9 +340,9 @@ CSVファイルからエレベートワードを一括登録します。ファ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "suggestWord": "API reference", + "suggest_word": "API reference", "boost": 100.0, - "labelTypeIds": ["technical_docs"], + "label_type_ids": ["technical_docs"], "permissions": "{role}guest" }' diff --git a/ja/15.9/api/admin/api-admin-failureurl.rst b/ja/15.9/api/admin/api-admin-failureurl.rst index 27c5d92d4..a68e073a8 100644 --- a/ja/15.9/api/admin/api-admin-failureurl.rst +++ b/ja/15.9/api/admin/api-admin-failureurl.rst @@ -71,15 +71,15 @@ FailureUrl APIは、|Fess| のクロール障害URLを管理するためのAPI - String - いいえ - URLフィルター（ワイルドカード ``*`` ``?`` 使用可） - * - ``errorCountMin`` + * - ``error_count_min`` - Integer - いいえ - エラー発生回数の下限フィルター（指定値以上） - * - ``errorCountMax`` + * - ``error_count_max`` - Integer - いいえ - エラー発生回数の上限フィルター（指定値以下） - * - ``errorName`` + * - ``error_name`` - String - いいえ - エラー名フィルター（格納されている完全修飾クラス名に対するワイルドカード検索。\ ``*`` ``?`` 使用可） @@ -96,22 +96,22 @@ FailureUrl APIは、|Fess| のクロール障害URLを管理するためのAPI { "id": "failure_id_1", "url": "https://example.com/broken-page", - "threadName": "Crawler-1", - "errorName": "java.net.ConnectException", - "errorLog": "Connection refused: connect", - "errorCount": "3", - "lastAccessTime": "1738144800000", - "configId": "webConfig_id_1" + "thread_name": "Crawler-1", + "error_name": "java.net.ConnectException", + "error_log": "Connection refused: connect", + "error_count": "3", + "last_access_time": "1738144800000", + "config_id": "webConfig_id_1" }, { "id": "failure_id_2", "url": "https://example.com/not-found", - "threadName": "Crawler-2", - "errorName": "org.codelibs.fess.exception.ContentNotFoundException", - "errorLog": "Not found: https://example.com/not-found", - "errorCount": "1", - "lastAccessTime": "1738143000000", - "configId": "webConfig_id_1" + "thread_name": "Crawler-2", + "error_name": "org.codelibs.fess.exception.ContentNotFoundException", + "error_log": "Not found: https://example.com/not-found", + "error_count": "1", + "last_access_time": "1738143000000", + "config_id": "webConfig_id_1" } ], "total": 45 @@ -131,23 +131,23 @@ FailureUrl APIは、|Fess| のクロール障害URLを管理するためのAPI - 障害URL ID * - ``url`` - 失敗したURL - * - ``threadName`` + * - ``thread_name`` - スレッド名 - * - ``errorName`` + * - ``error_name`` - エラー名（発生した例外の完全修飾クラス名。例: ``java.net.ConnectException``） - * - ``errorLog`` + * - ``error_log`` - エラーログ（例外のメッセージやスタックトレース） - * - ``errorCount`` + * - ``error_count`` - エラー発生回数（数値を表す文字列） - * - ``lastAccessTime`` + * - ``last_access_time`` - 最終アクセス時刻（エポックミリ秒を表す文字列） - * - ``configId`` + * - ``config_id`` - クロール設定ID .. note:: レスポンスの各フィールドはすべて文字列（JSON string）として返されます。 - ``errorCount`` は数値を表す文字列、``lastAccessTime`` はエポックミリ秒を表す文字列です。 + ``error_count`` は数値を表す文字列、``last_access_time`` はエポックミリ秒を表す文字列です。 障害URL取得 =========== @@ -170,12 +170,12 @@ FailureUrl APIは、|Fess| のクロール障害URLを管理するためのAPI "log": { "id": "failure_id_1", "url": "https://example.com/broken-page", - "threadName": "Crawler-1", - "errorName": "java.net.ConnectException", - "errorLog": "Connection refused: connect", - "errorCount": "3", - "lastAccessTime": "1738144800000", - "configId": "webConfig_id_1" + "thread_name": "Crawler-1", + "error_name": "java.net.ConnectException", + "error_log": "Connection refused: connect", + "error_count": "3", + "last_access_time": "1738144800000", + "config_id": "webConfig_id_1" } } } @@ -227,7 +227,7 @@ FailureUrl APIは、|Fess| のクロール障害URLを管理するためのAPI エラータイプ ============ -``errorName`` には、クロール中に発生した例外の完全修飾クラス名がそのまま格納されます。 +``error_name`` には、クロール中に発生した例外の完全修飾クラス名がそのまま格納されます。 固定の列挙値ではなく、発生した例外に応じて任意のクラス名が入ります。 以下は代表的な例です。 @@ -313,7 +313,7 @@ FailureUrl APIは、|Fess| のクロール障害URLを管理するためのAPI # エラータイプごとにカウント curl -X GET "http://localhost:8080/api/admin/failureurl/logs?size=1000" \ -H "Authorization: Bearer YOUR_TOKEN" | \ - jq '[.response.logs[].errorName] | group_by(.) | map({error: .[0], count: length})' + jq '[.response.logs[].error_name] | group_by(.) | map({error: .[0], count: length})' 参考情報 ======== diff --git a/ja/15.9/api/admin/api-admin-fileconfig.rst b/ja/15.9/api/admin/api-admin-fileconfig.rst index cbc870a55..89fa0605f 100644 --- a/ja/15.9/api/admin/api-admin-fileconfig.rst +++ b/ja/15.9/api/admin/api-admin-fileconfig.rst @@ -106,20 +106,20 @@ FileConfig APIは、|Fess| のファイルクロール設定を管理するた "name": "Shared Documents", "description": "共有ドキュメント", "paths": "smb://server/share/documents", - "includedPaths": ".*\\.pdf$", - "excludedPaths": ".*/(temp|cache)/.*", - "includedDocPaths": "", - "excludedDocPaths": "", - "configParameter": "", + "included_paths": ".*\\.pdf$", + "excluded_paths": ".*/(temp|cache)/.*", + "included_doc_paths": "", + "excluded_doc_paths": "", + "config_parameter": "", "depth": 10, - "maxAccessCount": 1000, - "numOfThread": 1, - "intervalTime": 1000, + "max_access_count": 1000, + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, "available": "true", "permissions": "{role}admin", - "virtualHosts": "", - "sortOrder": 0 + "virtual_hosts": "", + "sort_order": 0 } ], "total": 5 @@ -151,34 +151,34 @@ FileConfig APIは、|Fess| のファイルクロール設定を管理するた "name": "Shared Documents", "description": "共有ドキュメント", "paths": "smb://server/share/documents", - "includedPaths": ".*\\.pdf$", - "excludedPaths": ".*/(temp|cache)/.*", - "includedDocPaths": "", - "excludedDocPaths": "", - "configParameter": "", + "included_paths": ".*\\.pdf$", + "excluded_paths": ".*/(temp|cache)/.*", + "included_doc_paths": "", + "excluded_doc_paths": "", + "config_parameter": "", "depth": 10, - "maxAccessCount": 1000, - "numOfThread": 1, - "intervalTime": 1000, + "max_access_count": 1000, + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin", - "virtualHosts": "", - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_hosts": "", + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } .. note:: - レスポンスには、登録・更新時に自動設定される ``createdBy`` 、 ``createdTime`` 、 - ``updatedBy`` 、 ``updatedTime`` 、 ``versionNo`` が含まれます。 - ``versionNo`` は更新時に必要です（後述の「ファイルクロール設定更新」を参照）。 + レスポンスには、登録・更新時に自動設定される ``created_by`` 、 ``created_time`` 、 + ``updated_by`` 、 ``updated_time`` 、 ``version_no`` が含まれます。 + ``version_no`` は更新時に必要です（後述の「ファイルクロール設定更新」を参照）。 ファイルクロール設定作成 ======================== @@ -199,13 +199,13 @@ FileConfig APIは、|Fess| のファイルクロール設定を管理するた { "name": "Local Files", "paths": "file:///data/documents", - "includedPaths": ".*\\.(pdf|doc|docx|xls|xlsx)$", - "excludedPaths": ".*/(temp|backup)/.*", - "numOfThread": 2, - "intervalTime": 500, + "included_paths": ".*\\.(pdf|doc|docx|xls|xlsx)$", + "excluded_paths": ".*/(temp|backup)/.*", + "num_of_thread": 2, + "interval_time": 500, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin\n{role}user" } @@ -228,31 +228,31 @@ FileConfig APIは、|Fess| のファイルクロール設定を管理するた * - ``paths`` - はい - クロール開始パス（複数の場合は改行区切り）。\ ``file:`` 、 ``smb:`` 、 ``smb1:`` 、 ``ftp:`` 、 ``s3:`` 、 ``gcs:`` のいずれかのプロトコルで指定します - * - ``includedPaths`` + * - ``included_paths`` - いいえ - クロール対象パスの正規表現パターン - * - ``excludedPaths`` + * - ``excluded_paths`` - いいえ - クロール除外パスの正規表現パターン - * - ``includedDocPaths`` + * - ``included_doc_paths`` - いいえ - インデックス対象パスの正規表現パターン - * - ``excludedDocPaths`` + * - ``excluded_doc_paths`` - いいえ - インデックス除外パスの正規表現パターン - * - ``configParameter`` + * - ``config_parameter`` - いいえ - 追加設定パラメーター（``key=value`` 形式、1行に1項目） * - ``depth`` - いいえ - クロール深度（0以上） - * - ``maxAccessCount`` + * - ``max_access_count`` - いいえ - 最大アクセス数（0以上） - * - ``numOfThread`` + * - ``num_of_thread`` - はい - 並列スレッド数（1以上） - * - ``intervalTime`` + * - ``interval_time`` - はい - アクセス間隔（ミリ秒、0以上） * - ``boost`` @@ -261,19 +261,19 @@ FileConfig APIは、|Fess| のファイルクロール設定を管理するた * - ``available`` - はい - 有効/無効（文字列 ``"true"`` / ``"false"``） - * - ``sortOrder`` + * - ``sort_order`` - はい - 表示順序（0以上） * - ``permissions`` - いいえ - アクセス許可ロール（複数の場合は改行区切り） - * - ``virtualHosts`` + * - ``virtual_hosts`` - いいえ - 仮想ホスト（複数の場合は改行区切り） .. note:: - ``createdBy`` 、 ``createdTime`` 、 ``updatedBy`` 、 ``updatedTime`` などの監査用フィールドは + ``created_by`` 、 ``created_time`` 、 ``updated_by`` 、 ``updated_time`` などの監査用フィールドは サーバー側で自動設定されるため、リクエストボディで指定する必要はありません。 レスポンス @@ -303,8 +303,8 @@ FileConfig APIは、|Fess| のファイルクロール設定を管理するた リクエストボディ ~~~~~~~~~~~~~~~~ -更新時は、作成時のフィールドに加えて、更新対象を特定する ``id`` とバージョン番号 ``versionNo`` が必須です。 -``versionNo`` には取得API（GET）のレスポンスに含まれる現在の値を指定します。 +更新時は、作成時のフィールドに加えて、更新対象を特定する ``id`` とバージョン番号 ``version_no`` が必須です。 +``version_no`` には取得API（GET）のレスポンスに含まれる現在の値を指定します。 .. code-block:: json @@ -312,16 +312,16 @@ FileConfig APIは、|Fess| のファイルクロール設定を管理するた "id": "existing_fileconfig_id", "name": "Updated Local Files", "paths": "file:///data/documents", - "includedPaths": ".*\\.(pdf|doc|docx|xls|xlsx|ppt|pptx)$", - "excludedPaths": ".*/(temp|backup|archive)/.*", + "included_paths": ".*\\.(pdf|doc|docx|xls|xlsx|ppt|pptx)$", + "excluded_paths": ".*/(temp|backup|archive)/.*", "depth": 10, - "maxAccessCount": 10000, - "numOfThread": 3, - "intervalTime": 300, + "max_access_count": 10000, + "num_of_thread": 3, + "interval_time": 300, "boost": 1.2, "available": "true", - "sortOrder": 0, - "versionNo": 1 + "sort_order": 0, + "version_no": 1 } 更新時の追加フィールド @@ -337,9 +337,9 @@ FileConfig APIは、|Fess| のファイルクロール設定を管理するた * - ``id`` - はい - 更新対象の設定ID（最大1000文字） - * - ``versionNo`` + * - ``version_no`` - はい - - 更新対象の現在のバージョン番号。取得API（GET）のレスポンスに含まれる ``versionNo`` を指定します + - 更新対象の現在のバージョン番号。取得API（GET）のレスポンスに含まれる ``version_no`` を指定します レスポンス ---------- @@ -418,13 +418,13 @@ FileConfig APIは、|Fess| のファイルクロール設定を管理するた -d '{ "name": "Local Files", "paths": "file:///data/documents", - "includedPaths": ".*\\.(pdf|doc|docx)$", - "excludedPaths": ".*/(temp|backup)/.*", - "numOfThread": 2, - "intervalTime": 500, + "included_paths": ".*\\.(pdf|doc|docx)$", + "excluded_paths": ".*/(temp|backup)/.*", + "num_of_thread": 2, + "interval_time": 500, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}guest" }' @@ -439,14 +439,14 @@ SMB共有のクロール設定 -d '{ "name": "SMB Share", "paths": "smb://server/documents", - "includedPaths": ".*\\.(pdf|doc|docx)$", - "excludedPaths": ".*/(temp|private)/.*", - "maxAccessCount": 50000, - "numOfThread": 3, - "intervalTime": 200, + "included_paths": ".*\\.(pdf|doc|docx)$", + "excluded_paths": ".*/(temp|private)/.*", + "max_access_count": 50000, + "num_of_thread": 3, + "interval_time": 200, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}guest" }' diff --git a/ja/15.9/api/admin/api-admin-general.rst b/ja/15.9/api/admin/api-admin-general.rst index 328120b61..93478ad35 100644 --- a/ja/15.9/api/admin/api-admin-general.rst +++ b/ja/15.9/api/admin/api-admin-general.rst @@ -64,37 +64,36 @@ General APIは、|Fess| の一般設定（システム全般に関わる設定 "version": "15.9.0", "status": 0, "setting": { - "incrementalCrawling": "true", - "dayForCleanup": -1, - "crawlingThreadCount": 5, - "searchLog": "true", - "userInfo": "true", - "userFavorite": "false", - "webApiJson": "true", - "defaultLabelValue": "", - "defaultSortValue": "", - "appendQueryParameter": "false", - "loginRequired": "false", + "incremental_crawling": "true", + "day_for_cleanup": -1, + "crawling_thread_count": 5, + "search_log": "true", + "user_info": "true", + "user_favorite": "false", + "web_api_json": "true", + "default_label_value": "", + "default_sort_value": "", + "append_query_parameter": "false", + "login_required": "false", "thumbnail": "true", - "failureCountThreshold": -1, - "popularWord": "true", - "csvFileEncoding": "UTF-8", - "purgeSearchLogDay": 30, - "purgeJobLogDay": 30, - "purgeUserInfoDay": 30, - "purgeSuggestSearchLogDay": 30, - "notificationTo": "", - "suggestSearchLog": "true", - "suggestDocuments": "true", - "ldapProviderUrl": "ldap://localhost:389/", - "ldapBaseDn": "dc=example,dc=com", - "ldapAdminSecurityPrincipal": "cn=admin,dc=example,dc=com", - "ldapAdminSecurityCredentials": null, - "logLevel": "", - "ssoType": "none", - "storageType": "", - "notificationLogin": "", - "notificationSearchTop": "" + "failure_count_threshold": -1, + "popular_word": "true", + "csv_file_encoding": "UTF-8", + "purge_search_log_day": 30, + "purge_job_log_day": 30, + "purge_user_info_day": 30, + "purge_suggest_search_log_day": 30, + "notification_to": "", + "suggest_search_log": "true", + "suggest_documents": "true", + "ldap_provider_url": "ldap://localhost:389/", + "ldap_base_dn": "dc=example,dc=com", + "ldap_admin_security_principal": "cn=admin,dc=example,dc=com", + "log_level": "", + "sso_type": "none", + "storage_type": "", + "notification_login": "", + "notification_search_top": "" } } } @@ -110,11 +109,11 @@ General APIは、|Fess| の一般設定（システム全般に関わる設定 セキュリティ上の理由から、認証情報を含むフィールドはレスポンスにそのままの値では 含まれません。 - - LDAP管理者パスワード ``ldapAdminSecurityCredentials`` は常に ``null`` で - 返されます。 - - その他のシークレット（``storageAccessKey`` / ``storageSecretKey`` / - ``oicClientId`` / ``oicClientSecret`` / ``spnegoPreauthPassword`` / - ``entraidClientId`` / ``entraidClientSecret``）は、設定されている場合は + - LDAP管理者パスワード ``ldap_admin_security_credentials`` は常に + レスポンスに含まれません。 + - その他のシークレット（``storage_access_key`` / ``storage_secret_key`` / + ``oic_client_id`` / ``oic_client_secret`` / ``spnego_preauth_password`` / + ``entraid_client_id`` / ``entraid_client_secret``）は、設定されている場合は ``"**********"`` でマスクされ、設定されていない場合は空文字列（``""``）で 返されます。 @@ -141,10 +140,10 @@ General APIは、|Fess| の一般設定（システム全般に関わる設定 次の4つのフィールドは必須であり、**すべての** PUTリクエストに必ず含める必要が あります（部分更新の場合も同様です）。 - - ``dayForCleanup`` - - ``crawlingThreadCount`` - - ``failureCountThreshold`` - - ``csvFileEncoding`` + - ``day_for_cleanup`` + - ``crawling_thread_count`` + - ``failure_count_threshold`` + - ``csv_file_encoding`` いずれかが欠けるとバリデーションに失敗し、API は HTTP 400 で ``status: 1`` と エラー ``message`` を返します。送信した値で既存の設定が上書きされるため、値を @@ -169,12 +168,12 @@ General APIは、|Fess| の一般設定（システム全般に関わる設定 .. code-block:: json { - "incrementalCrawling": "true", - "dayForCleanup": -1, - "crawlingThreadCount": 10, - "failureCountThreshold": 100, - "csvFileEncoding": "UTF-8", - "popularWord": "true" + "incremental_crawling": "true", + "day_for_cleanup": -1, + "crawling_thread_count": 10, + "failure_count_threshold": 100, + "csv_file_encoding": "UTF-8", + "popular_word": "true" } 主なフィールド @@ -191,124 +190,124 @@ General APIは、|Fess| の一般設定（システム全般に関わる設定 * - フィールド - 必須 - 説明 - * - ``incrementalCrawling`` + * - ``incremental_crawling`` - いいえ - 増分クロールの有効/無効 - * - ``dayForCleanup`` + * - ``day_for_cleanup`` - はい - クロール済みドキュメントを保持する日数（-1=クリーンアップ無効。指定範囲: -1〜1000） - * - ``crawlingThreadCount`` + * - ``crawling_thread_count`` - はい - クロールに使用するスレッド数（指定範囲: 0〜100） - * - ``failureCountThreshold`` + * - ``failure_count_threshold`` - はい - URLのクロールを停止する失敗回数のしきい値（-1=無効。指定範囲: -1〜10000） - * - ``csvFileEncoding`` + * - ``csv_file_encoding`` - はい - CSVエクスポートのエンコーディング - * - ``searchLog`` + * - ``search_log`` - いいえ - 検索クエリログの有効/無効 - * - ``userInfo`` + * - ``user_info`` - いいえ - ユーザー情報の記録の有効/無効 - * - ``userFavorite`` + * - ``user_favorite`` - いいえ - お気に入り機能の有効/無効 - * - ``webApiJson`` + * - ``web_api_json`` - いいえ - JSON Web APIの有効/無効 - * - ``appValue`` + * - ``app_value`` - いいえ - アプリケーション固有の追加設定値 - * - ``virtualHostValue`` + * - ``virtual_host_value`` - いいえ - バーチャルホスト設定（マルチテナント構成用） - * - ``popularWord`` + * - ``popular_word`` - いいえ - 人気ワードの集計・表示の有効/無効 - * - ``defaultLabelValue`` + * - ``default_label_value`` - いいえ - 既定のラベル値 - * - ``defaultSortValue`` + * - ``default_sort_value`` - いいえ - 既定のソート順 - * - ``appendQueryParameter`` + * - ``append_query_parameter`` - いいえ - 検索結果URLへのクエリパラメーター付与 - * - ``loginRequired`` + * - ``login_required`` - いいえ - 検索にログインを必須とするか - * - ``loginLink`` + * - ``login_link`` - いいえ - 検索画面へのログインリンク表示の有効/無効 * - ``thumbnail`` - いいえ - サムネイル生成の有効/無効 - * - ``resultCollapsed`` + * - ``result_collapsed`` - いいえ - 類似ドキュメントの検索結果の折りたたみ表示の有効/無効 - * - ``ignoreFailureType`` + * - ``ignore_failure_type`` - いいえ - 無視するクロール失敗タイプ - * - ``crawlingUserAgent`` + * - ``crawling_user_agent`` - いいえ - クロール時に送信するUser-Agent文字列 - * - ``purgeSearchLogDay`` + * - ``purge_search_log_day`` - いいえ - 検索ログを保持する日数（-1=無効。指定範囲: -1〜100000） - * - ``purgeJobLogDay`` + * - ``purge_job_log_day`` - いいえ - ジョブログを保持する日数（-1=無効。指定範囲: -1〜100000） - * - ``purgeUserInfoDay`` + * - ``purge_user_info_day`` - いいえ - ユーザー情報を保持する日数（-1=無効。指定範囲: -1〜100000） - * - ``purgeSuggestSearchLogDay`` + * - ``purge_suggest_search_log_day`` - いいえ - サジェスト検索ログを保持する日数（0=無効。指定範囲: 0〜100000） - * - ``purgeByBots`` + * - ``purge_by_bots`` - いいえ - 検索ログを破棄する対象のボットUser-Agent - * - ``notificationTo`` + * - ``notification_to`` - いいえ - システム通知の送信先メールアドレス - * - ``notificationLogin`` + * - ``notification_login`` - いいえ - ログインページに表示する通知メッセージ - * - ``notificationSearchTop`` + * - ``notification_search_top`` - いいえ - 検索トップページに表示する通知メッセージ - * - ``notificationAdvanceSearch`` + * - ``notification_advance_search`` - いいえ - 詳細検索ページに表示する通知メッセージ - * - ``suggestSearchLog`` + * - ``suggest_search_log`` - いいえ - 検索ログからのサジェストの有効/無効 - * - ``suggestDocuments`` + * - ``suggest_documents`` - いいえ - ドキュメントからのサジェストの有効/無効 - * - ``logLevel`` + * - ``log_level`` - いいえ - システムログのログレベル - * - ``logNotificationEnabled`` + * - ``log_notification_enabled`` - いいえ - ERROR/WARNログの通知の有効/無効 - * - ``logNotificationLevel`` + * - ``log_notification_level`` - いいえ - ログ通知レベル - * - ``slackWebhookUrls`` + * - ``slack_webhook_urls`` - いいえ - 通知用のSlack Webhook URL - * - ``googleChatWebhookUrls`` + * - ``google_chat_webhook_urls`` - いいえ - 通知用のGoogle Chat Webhook URL - * - ``searchUseBrowserLocale`` + * - ``search_use_browser_locale`` - いいえ - 検索でブラウザのロケールを使用するかどうか - * - ``ragLlmName`` + * - ``rag_llm_name`` - いいえ - RAGで使用するLLMプロバイダー名 - * - ``llmLogLevel`` + * - ``llm_log_level`` - いいえ - LLM関連パッケージのログレベル @@ -325,29 +324,29 @@ LDAPおよびSSO（OpenID Connect、SAML、SPNEGO、Entra ID）に関する設 * - フィールド - 説明 - * - ``ldapProviderUrl`` + * - ``ldap_provider_url`` - LDAP接続URL - * - ``ldapBaseDn`` + * - ``ldap_base_dn`` - LDAPベースDN - * - ``ldapSecurityPrincipal`` + * - ``ldap_security_principal`` - LDAPバインド用のセキュリティプリンシパル - * - ``ldapAdminSecurityPrincipal`` + * - ``ldap_admin_security_principal`` - LDAP管理操作用のセキュリティプリンシパル - * - ``ldapAdminSecurityCredentials`` - - LDAP管理者パスワード（レスポンスでは ``null`` に置換） - * - ``ldapAccountFilter`` / ``ldapGroupFilter`` + * - ``ldap_admin_security_credentials`` + - LDAP管理者パスワード（レスポンスには含まれません） + * - ``ldap_account_filter`` / ``ldap_group_filter`` - ユーザー/グループ検索フィルター - * - ``ldapMemberofAttribute`` + * - ``ldap_memberof_attribute`` - グループ所属を示すLDAP属性名 - * - ``ssoType`` + * - ``sso_type`` - SSOタイプ（``none`` / ``oic`` / ``saml`` / ``spnego`` / ``entraid``） - * - ``oicClientId`` / ``oicClientSecret`` / ``oicAuthServerUrl`` 他 + * - ``oic_client_id`` / ``oic_client_secret`` / ``oic_auth_server_url`` 他 - OpenID Connectの設定 - * - ``samlIdpEntityid`` / ``samlSpEntityid`` 他 + * - ``saml_idp_entityid`` / ``saml_sp_entityid`` 他 - SAMLの設定 - * - ``spnegoKrb5Conf`` / ``spnegoLoginConf`` 他 + * - ``spnego_krb5_conf`` / ``spnego_login_conf`` 他 - SPNEGOの設定 - * - ``entraidClientId`` / ``entraidTenant`` 他 + * - ``entraid_client_id`` / ``entraid_tenant`` 他 - Microsoft Entra IDの設定 ストレージ関連フィールド @@ -361,24 +360,24 @@ LDAPおよびSSO（OpenID Connect、SAML、SPNEGO、Entra ID）に関する設 * - フィールド - 説明 - * - ``storageType`` + * - ``storage_type`` - ストレージタイプ（``auto`` / ``s3`` / ``gcs``） - * - ``storageEndpoint`` + * - ``storage_endpoint`` - ストレージのエンドポイントURL - * - ``storageAccessKey`` / ``storageSecretKey`` + * - ``storage_access_key`` / ``storage_secret_key`` - 認証用のアクセスキー/シークレットキー - * - ``storageBucket`` + * - ``storage_bucket`` - バケット名 - * - ``storageRegion`` + * - ``storage_region`` - S3のリージョン - * - ``storageProjectId`` / ``storageCredentialsPath`` + * - ``storage_project_id`` / ``storage_credentials_path`` - GCSのプロジェクトID / 認証情報ファイルパス .. note:: - ``ldapAdminSecurityCredentials``、``storageAccessKey`` / ``storageSecretKey``、 - ``oicClientId`` / ``oicClientSecret``、``entraidClientId`` / ``entraidClientSecret``、 - ``spnegoPreauthPassword`` などのシークレット系フィールドは、マスク値 + ``ldap_admin_security_credentials``、``storage_access_key`` / ``storage_secret_key``、 + ``oic_client_id`` / ``oic_client_secret``、``entraid_client_id`` / ``entraid_client_secret``、 + ``spnego_preauth_password`` などのシークレット系フィールドは、マスク値 ``"**********"`` をそのまま送信した場合、その値は更新されず、保存済みの値が 維持されます。値を変更する場合のみ、実際の値を送信してください。 @@ -412,8 +411,8 @@ LDAPおよびSSO（OpenID Connect、SAML、SPNEGO、Entra ID）に関する設 .. note:: - 以下の例には必須フィールド（``dayForCleanup`` 、``crawlingThreadCount`` 、 - ``failureCountThreshold`` 、``csvFileEncoding``）が含まれています。これらは変更内容に + 以下の例には必須フィールド（``day_for_cleanup`` 、``crawling_thread_count`` 、 + ``failure_count_threshold`` 、``csv_file_encoding``）が含まれています。これらは変更内容に 関わらず常に送信する必要があるため、実運用では ``GET`` で取得した現在の値を含めて ください（以下の例ではデフォルト値を使用しています）。 @@ -426,11 +425,11 @@ LDAPおよびSSO（OpenID Connect、SAML、SPNEGO、Entra ID）に関する設 -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "incrementalCrawling": "true", - "crawlingThreadCount": 10, - "failureCountThreshold": 100, - "dayForCleanup": -1, - "csvFileEncoding": "UTF-8" + "incremental_crawling": "true", + "crawling_thread_count": 10, + "failure_count_threshold": 100, + "day_for_cleanup": -1, + "csv_file_encoding": "UTF-8" }' ログ保持期間の更新 @@ -442,13 +441,13 @@ LDAPおよびSSO（OpenID Connect、SAML、SPNEGO、Entra ID）に関する設 -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "dayForCleanup": -1, - "crawlingThreadCount": 5, - "failureCountThreshold": -1, - "csvFileEncoding": "UTF-8", - "purgeSearchLogDay": 90, - "purgeJobLogDay": 90, - "purgeUserInfoDay": 90 + "day_for_cleanup": -1, + "crawling_thread_count": 5, + "failure_count_threshold": -1, + "csv_file_encoding": "UTF-8", + "purge_search_log_day": 90, + "purge_job_log_day": 90, + "purge_user_info_day": 90 }' サジェスト設定の更新 @@ -460,12 +459,12 @@ LDAPおよびSSO（OpenID Connect、SAML、SPNEGO、Entra ID）に関する設 -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "dayForCleanup": -1, - "crawlingThreadCount": 5, - "failureCountThreshold": -1, - "csvFileEncoding": "UTF-8", - "suggestSearchLog": "true", - "suggestDocuments": "true" + "day_for_cleanup": -1, + "crawling_thread_count": 5, + "failure_count_threshold": -1, + "csv_file_encoding": "UTF-8", + "suggest_search_log": "true", + "suggest_documents": "true" }' 参考情報 diff --git a/ja/15.9/api/admin/api-admin-group.rst b/ja/15.9/api/admin/api-admin-group.rst index 5d5208bf7..87959792e 100644 --- a/ja/15.9/api/admin/api-admin-group.rst +++ b/ja/15.9/api/admin/api-admin-group.rst @@ -90,7 +90,7 @@ Group APIは、|Fess| のグループを管理するためのAPIです。 "attributes": { "gidNumber": "1000" }, - "versionNo": 1 + "version_no": 1 }, { "id": "group_id_2", @@ -98,7 +98,7 @@ Group APIは、|Fess| のグループを管理するためのAPIです。 "attributes": { "gidNumber": "1001" }, - "versionNo": 1 + "version_no": 1 } ], "total": 5 @@ -129,7 +129,7 @@ Group APIは、|Fess| のグループを管理するためのAPIです。 "attributes": { "gidNumber": "1000" }, - "versionNo": 1 + "version_no": 1 } } } @@ -209,7 +209,7 @@ Group APIは、|Fess| のグループを管理するためのAPIです。 "attributes": { "gidNumber": "1002" }, - "versionNo": 1 + "version_no": 1 } フィールド説明 @@ -231,9 +231,9 @@ Group APIは、|Fess| のグループを管理するためのAPIです。 * - ``attributes`` - いいえ - 属性のマップ（``gidNumber`` などのLDAP属性を含む）。値は文字列で指定します - * - ``versionNo`` + * - ``version_no`` - はい - - 楽観的ロック用のバージョン番号。グループ取得で得た ``versionNo`` の値を指定します + - 楽観的ロック用のバージョン番号。グループ取得で得た ``version_no`` の値を指定します レスポンス ---------- diff --git a/ja/15.9/api/admin/api-admin-joblog.rst b/ja/15.9/api/admin/api-admin-joblog.rst index 9bae657b6..8187d9ea7 100644 --- a/ja/15.9/api/admin/api-admin-joblog.rst +++ b/ja/15.9/api/admin/api-admin-joblog.rst @@ -80,25 +80,25 @@ JobLog APIは、|Fess| のジョブ実行ログを参照・管理するための "logs": [ { "id": "joblog_id_1", - "jobName": "Default Crawler", - "jobStatus": "ok", + "job_name": "Default Crawler", + "job_status": "ok", "target": "all", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "scriptResult": "Job completed successfully", - "startTime": "1738116000000", - "endTime": "1738118723000" + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "script_result": "Job completed successfully", + "start_time": "1738116000000", + "end_time": "1738118723000" }, { "id": "joblog_id_2", - "jobName": "Default Crawler", - "jobStatus": "fail", + "job_name": "Default Crawler", + "job_status": "fail", "target": "all", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "scriptResult": "Error: Connection timeout", - "startTime": "1738029600000", - "endTime": "1738030215000" + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "script_result": "Error: Connection timeout", + "start_time": "1738029600000", + "end_time": "1738030215000" } ], "total": 100 @@ -116,26 +116,26 @@ JobLog APIは、|Fess| のジョブ実行ログを参照・管理するための - 説明 * - ``id`` - ジョブログID - * - ``jobName`` + * - ``job_name`` - ジョブ名 - * - ``jobStatus`` + * - ``job_status`` - ジョブステータス（``ok``: 成功、``fail``: 失敗、``running``: 実行中） * - ``target`` - 実行対象（スケジューラーのターゲット名。既定値は ``all``） - * - ``scriptType`` + * - ``script_type`` - スクリプトタイプ（例: ``javascript``） - * - ``scriptData`` + * - ``script_data`` - 実行スクリプト - * - ``scriptResult`` + * - ``script_result`` - 実行結果 - * - ``startTime`` + * - ``start_time`` - 開始時刻（エポックミリ秒。文字列として返されます） - * - ``endTime`` + * - ``end_time`` - 終了時刻（エポックミリ秒。文字列として返されます）。実行中のジョブでは返されません。 .. note:: - レスポンスの各ログオブジェクトには、内部的に使用される ``crudMode`` フィールド + レスポンスの各ログオブジェクトには、内部的に使用される ``crud_mode`` フィールド （CRUD操作モードを示す整数値で、参照時は常に ``0``）が含まれます。 クライアント側では無視して問題ありません。 @@ -159,14 +159,14 @@ JobLog APIは、|Fess| のジョブ実行ログを参照・管理するための "status": 0, "log": { "id": "joblog_id_1", - "jobName": "Default Crawler", - "jobStatus": "ok", + "job_name": "Default Crawler", + "job_status": "ok", "target": "all", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "scriptResult": "Crawl completed successfully.\nDocuments indexed: 1234\nDocuments updated: 567\nDocuments deleted: 12\nErrors: 0", - "startTime": "1738116000000", - "endTime": "1738118723000" + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "script_result": "Crawl completed successfully.\nDocuments indexed: 1234\nDocuments updated: 567\nDocuments deleted: 12\nErrors: 0", + "start_time": "1738116000000", + "end_time": "1738118723000" } } } diff --git a/ja/15.9/api/admin/api-admin-keymatch.rst b/ja/15.9/api/admin/api-admin-keymatch.rst index f5b947457..408729b1d 100644 --- a/ja/15.9/api/admin/api-admin-keymatch.rst +++ b/ja/15.9/api/admin/api-admin-keymatch.rst @@ -92,9 +92,9 @@ KeyMatch APIは、|Fess| のキーマッチ（検索キーワードと結果の "id": "keymatch_id_1", "term": "download", "query": "title:download OR content:download", - "maxSize": 10, + "max_size": 10, "boost": 10.0, - "versionNo": 1 + "version_no": 1 } ], "total": 5 @@ -104,8 +104,8 @@ KeyMatch APIは、|Fess| のキーマッチ（検索キーワードと結果の .. note:: ``total`` には絞り込み条件に一致する総件数が設定されます（現在のページの件数ではありません）。 - 各設定オブジェクトには上記のフィールドに加えて、値が設定されている場合に ``virtualHost`` 、 - ``createdBy`` 、 ``createdTime`` 、 ``updatedBy`` 、 ``updatedTime`` が含まれます。 + 各設定オブジェクトには上記のフィールドに加えて、値が設定されている場合に ``virtual_host`` 、 + ``created_by`` 、 ``created_time`` 、 ``updated_by`` 、 ``updated_time`` が含まれます。 キーマッチ取得 ============== @@ -129,21 +129,21 @@ KeyMatch APIは、|Fess| のキーマッチ（検索キーワードと結果の "id": "keymatch_id_1", "term": "download", "query": "title:download OR content:download", - "maxSize": 10, + "max_size": 10, "boost": 10.0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } .. note:: - ``versionNo`` は楽観ロック用のバージョン番号です。キーマッチを更新する際は、取得時に得られた - ``versionNo`` をリクエストボディに指定してください。指定したIDが存在しない場合はエラーが返されます。 + ``version_no`` は楽観ロック用のバージョン番号です。キーマッチを更新する際は、取得時に得られた + ``version_no`` をリクエストボディに指定してください。指定したIDが存在しない場合はエラーが返されます。 キーマッチ作成 ============== @@ -164,7 +164,7 @@ KeyMatch APIは、|Fess| のキーマッチ（検索キーワードと結果の { "term": "pricing", "query": "url:*/pricing* OR title:pricing", - "maxSize": 5, + "max_size": 5, "boost": 20.0 } @@ -187,7 +187,7 @@ KeyMatch APIは、|Fess| のキーマッチ（検索キーワードと結果の - String - はい - マッチ条件クエリ（最大長は ``form.admin.max.input.size`` の設定値に従う） - * - ``maxSize`` + * - ``max_size`` - Integer - はい - 最大表示件数（0以上の整数。管理画面での初期値は10） @@ -195,16 +195,16 @@ KeyMatch APIは、|Fess| のキーマッチ（検索キーワードと結果の - Float - はい - ブースト値（管理画面での初期値は100.0） - * - ``virtualHost`` + * - ``virtual_host`` - String - いいえ - 仮想ホスト名（最大1000文字。仮想ホストごとにキーマッチを切り替える場合に指定） .. note:: - ``maxSize`` と ``boost`` はAPI経由では必須です。初期値は管理画面のフォームに表示される値であり、 + ``max_size`` と ``boost`` はAPI経由では必須です。初期値は管理画面のフォームに表示される値であり、 APIでは適用されません。省略した場合はバリデーションエラーになります。 - なお、 ``createdBy`` と ``createdTime`` はリクエストで指定してもサーバー側で上書きされます。 + なお、 ``created_by`` と ``created_time`` はリクエストで指定してもサーバー側で上書きされます。 レスポンス ---------- @@ -239,15 +239,15 @@ KeyMatch APIは、|Fess| のキーマッチ（検索キーワードと結果の "id": "existing_keymatch_id", "term": "pricing", "query": "url:*/pricing* OR title:pricing OR content:price", - "maxSize": 10, + "max_size": 10, "boost": 15.0, - "versionNo": 1 + "version_no": 1 } フィールド説明 ~~~~~~~~~~~~~~ -作成時のフィールド（ ``term`` 、 ``query`` 、 ``maxSize`` 、 ``boost`` 、 ``virtualHost`` ）に加えて、 +作成時のフィールド（ ``term`` 、 ``query`` 、 ``max_size`` 、 ``boost`` 、 ``virtual_host`` ）に加えて、 以下のフィールドを指定します。 .. list-table:: @@ -262,7 +262,7 @@ KeyMatch APIは、|Fess| のキーマッチ（検索キーワードと結果の - String - はい - 更新対象のキーマッチID（最大1000文字） - * - ``versionNo`` + * - ``version_no`` - Integer - はい - 楽観ロック用のバージョン番号。取得時に得られた値を指定 @@ -315,7 +315,7 @@ KeyMatch APIは、|Fess| のキーマッチ（検索キーワードと結果の -d '{ "term": "product features", "query": "url:*/products/* AND (title:features OR content:features)", - "maxSize": 10, + "max_size": 10, "boost": 15.0 }' @@ -330,7 +330,7 @@ KeyMatch APIは、|Fess| のキーマッチ（検索キーワードと結果の -d '{ "term": "help", "query": "url:*/support/* OR url:*/help/* OR url:*/faq/*", - "maxSize": 5, + "max_size": 5, "boost": 20.0 }' diff --git a/ja/15.9/api/admin/api-admin-labeltype.rst b/ja/15.9/api/admin/api-admin-labeltype.rst index 3fe3f8472..baecd8e83 100644 --- a/ja/15.9/api/admin/api-admin-labeltype.rst +++ b/ja/15.9/api/admin/api-admin-labeltype.rst @@ -99,16 +99,16 @@ HTTPステータスコードなど）については :doc:`api-admin-overview` "id": "label_id_1", "name": "Documentation", "value": "docs", - "includedPaths": ".*docs\\.example\\.com.*", - "excludedPaths": "", + "included_paths": ".*docs\\.example\\.com.*", + "excluded_paths": "", "permissions": "{role}admin", - "virtualHost": "", - "sortOrder": 0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_host": "", + "sort_order": 0, + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } ], "total": 5 @@ -117,8 +117,8 @@ HTTPステータスコードなど）については :doc:`api-admin-overview` .. note:: - 各設定オブジェクトには、監査用の ``createdBy`` / ``createdTime`` / ``updatedBy`` / - ``updatedTime`` と、楽観的ロック用の ``versionNo`` も含まれます（値が ``null`` の + 各設定オブジェクトには、監査用の ``created_by`` / ``created_time`` / ``updated_by`` / + ``updated_time`` と、楽観的ロック用の ``version_no`` も含まれます（値が ``null`` の フィールドは省略されます）。\ ``response`` オブジェクトには製品バージョンを示す ``version`` が常に含まれますが、以降の例では簡潔さのために省略している場合があります。 @@ -144,16 +144,16 @@ HTTPステータスコードなど）については :doc:`api-admin-overview` "id": "label_id_1", "name": "Documentation", "value": "docs", - "includedPaths": ".*docs\\.example\\.com.*", - "excludedPaths": "", + "included_paths": ".*docs\\.example\\.com.*", + "excluded_paths": "", "permissions": "{role}admin", - "virtualHost": "", - "sortOrder": 0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_host": "", + "sort_order": 0, + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } @@ -177,9 +177,9 @@ HTTPステータスコードなど）については :doc:`api-admin-overview` { "name": "News", "value": "news", - "includedPaths": ".*news\\.example\\.com.*\n.*example\\.com/news/.*", - "excludedPaths": ".*/(archive|old)/.*", - "sortOrder": 1, + "included_paths": ".*news\\.example\\.com.*\n.*example\\.com/news/.*", + "excluded_paths": ".*/(archive|old)/.*", + "sort_order": 1, "permissions": "{role}guest" } @@ -202,11 +202,11 @@ HTTPステータスコードなど）については :doc:`api-admin-overview` - String - はい - ラベル値（検索時に ``label`` パラメーターで使用）。半角英数字とアンダースコア（``_``）のみ使用可能で、正規表現 ``^[a-zA-Z0-9_]+$`` に一致する必要があります（最大100文字）。 - * - ``includedPaths`` + * - ``included_paths`` - String - いいえ - ラベル対象とするパスの正規表現。複数指定する場合は改行（``\n``）で区切ります。 - * - ``excludedPaths`` + * - ``excluded_paths`` - String - いいえ - ラベル対象から除外するパスの正規表現。複数指定する場合は改行（``\n``）で区切ります。 @@ -214,18 +214,18 @@ HTTPステータスコードなど）については :doc:`api-admin-overview` - String - いいえ - アクセスを許可するロール／グループ／ユーザー（例: ``{role}admin``）。複数指定する場合は改行（``\n``）で区切ります。 - * - ``sortOrder`` + * - ``sort_order`` - Integer - いいえ - 表示順序（0以上の整数）。指定しない場合は ``0`` です。 - * - ``virtualHost`` + * - ``virtual_host`` - String - いいえ - 仮想ホスト（最大1000文字）。 .. note:: - ``createdBy`` / ``createdTime`` などの監査フィールドはサーバー側で自動的に設定される + ``created_by`` / ``created_time`` などの監査フィールドはサーバー側で自動的に設定される ため、リクエストでの指定は不要です。 レスポンス @@ -263,11 +263,11 @@ HTTPステータスコードなど）については :doc:`api-admin-overview` "id": "existing_label_id", "name": "News Articles", "value": "news", - "includedPaths": ".*news\\.example\\.com.*\n.*example\\.com/(news|articles)/.*", - "excludedPaths": ".*/(archive|old|draft)/.*", - "sortOrder": 1, + "included_paths": ".*news\\.example\\.com.*\n.*example\\.com/(news|articles)/.*", + "excluded_paths": ".*/(archive|old|draft)/.*", + "sort_order": 1, "permissions": "{role}guest", - "versionNo": 1 + "version_no": 1 } 更新時は、作成時のフィールドに加えて以下のフィールドが必須です。 @@ -284,10 +284,10 @@ HTTPステータスコードなど）については :doc:`api-admin-overview` - String - はい - 更新対象のラベルタイプID。 - * - ``versionNo`` + * - ``version_no`` - Integer - はい - - 楽観的ロック用のバージョン番号。取得時のレスポンスに含まれる ``versionNo`` を指定します。指定したバージョンが現在のものと一致しない場合、更新は失敗します。 + - 楽観的ロック用のバージョン番号。取得時のレスポンスに含まれる ``version_no`` を指定します。指定したバージョンが現在のものと一致しない場合、更新は失敗します。 レスポンス ---------- @@ -339,8 +339,8 @@ HTTPステータスコードなど）については :doc:`api-admin-overview` -d '{ "name": "Technical Documentation", "value": "tech_docs", - "includedPaths": ".*docs\\.example\\.com.*\n.*example\\.com/documentation/.*", - "sortOrder": 0, + "included_paths": ".*docs\\.example\\.com.*\n.*example\\.com/documentation/.*", + "sort_order": 0, "permissions": "{role}guest" }' diff --git a/ja/15.9/api/admin/api-admin-overview.rst b/ja/15.9/api/admin/api-admin-overview.rst index 120ef1860..0ba165515 100644 --- a/ja/15.9/api/admin/api-admin-overview.rst +++ b/ja/15.9/api/admin/api-admin-overview.rst @@ -515,22 +515,22 @@ Webクロール設定の作成 -d '{ "name": "Example Site", "urls": "https://example.com/", - "includedUrls": ".*example.com.*", - "excludedUrls": "", - "userAgent": "Mozilla/5.0 (compatible; Fess)", - "numOfThread": 1, - "intervalTime": 1000, + "included_urls": ".*example.com.*", + "excluded_urls": "", + "user_agent": "Mozilla/5.0 (compatible; Fess)", + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, - "maxAccessCount": 1000, + "max_access_count": 1000, "depth": 3, - "sortOrder": 1, + "sort_order": 1, "available": "true" }' .. note:: - Webクロール設定の作成では、``name``、``urls``、``userAgent``、``numOfThread``、 - ``intervalTime``、``boost``、``available``、``sortOrder`` が必須です。これらを + Webクロール設定の作成では、``name``、``urls``、``user_agent``、``num_of_thread``、 + ``interval_time``、``boost``、``available``、``sort_order`` が必須です。これらを 省略すると検証エラー（``status: 1``）になります。\ ``available`` は文字列で指定し、 ``"true"`` または ``"false"`` を設定します。 diff --git a/ja/15.9/api/admin/api-admin-relatedcontent.rst b/ja/15.9/api/admin/api-admin-relatedcontent.rst index 87cf08a52..c1197e12a 100644 --- a/ja/15.9/api/admin/api-admin-relatedcontent.rst +++ b/ja/15.9/api/admin/api-admin-relatedcontent.rst @@ -93,13 +93,13 @@ RelatedContent APIは、|Fess| の関連コンテンツを管理するためのA "id": "content_id_1", "term": "fess", "content": "
Fess is an open source search server.
", - "virtualHost": "", - "sortOrder": 0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_host": "", + "sort_order": 0, + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } ], "total": 5 @@ -109,9 +109,9 @@ RelatedContent APIは、|Fess| の関連コンテンツを管理するためのA .. note:: ``settings`` の各要素および単一取得の ``setting`` には、保存されているエンティティの - フィールドがそのまま含まれます。\ ``term``、``content``、``sortOrder``、``virtualHost`` に - 加えて、監査用の ``createdBy``・``createdTime``・``updatedBy``・``updatedTime`` と、 - 楽観的ロック用の ``versionNo`` も返されます。\ ``createdTime``・``updatedTime`` は + フィールドがそのまま含まれます。\ ``term``、``content``、``sort_order``、``virtual_host`` に + 加えて、監査用の ``created_by``・``created_time``・``updated_by``・``updated_time`` と、 + 楽観的ロック用の ``version_no`` も返されます。\ ``created_time``・``updated_time`` は エポックからのミリ秒（数値）です。値が未設定（null）のフィールドはレスポンスには 含まれません。また、すべてのレスポンスの ``response`` オブジェクトには、製品バージョンを 示す ``version`` が常に含まれます（詳細は :doc:`api-admin-overview` を参照）。 @@ -139,20 +139,20 @@ RelatedContent APIは、|Fess| の関連コンテンツを管理するためのA "id": "content_id_1", "term": "fess", "content": "
Fess is an open source search server.
", - "virtualHost": "", - "sortOrder": 0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_host": "", + "sort_order": 0, + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } .. note:: - 更新（PUT）の際に必要となる ``versionNo`` は、この取得結果に含まれる値を指定します。 + 更新（PUT）の際に必要となる ``version_no`` は、この取得結果に含まれる値を指定します。 関連コンテンツ作成 ================== @@ -173,8 +173,8 @@ RelatedContent APIは、|Fess| の関連コンテンツを管理するためのA { "term": "search", "content": "

About Search

Learn more about search features...

", - "sortOrder": 0, - "virtualHost": "" + "sort_order": 0, + "virtual_host": "" } フィールド説明 @@ -193,10 +193,10 @@ RelatedContent APIは、|Fess| の関連コンテンツを管理するためのA * - ``content`` - はい - 表示するHTMLコンテンツ（最大10000文字） - * - ``sortOrder`` + * - ``sort_order`` - いいえ - 表示順序（0以上2147483647以下の整数） - * - ``virtualHost`` + * - ``virtual_host`` - いいえ - 仮想ホスト（最大1000文字） @@ -234,9 +234,9 @@ RelatedContent APIは、|Fess| の関連コンテンツを管理するためのA "id": "existing_content_id", "term": "search", "content": "

About Search

Updated information...

", - "sortOrder": 0, - "virtualHost": "", - "versionNo": 1 + "sort_order": 0, + "virtual_host": "", + "version_no": 1 } フィールド説明 @@ -258,13 +258,13 @@ RelatedContent APIは、|Fess| の関連コンテンツを管理するためのA * - ``content`` - はい - 表示するHTMLコンテンツ（最大10000文字） - * - ``sortOrder`` + * - ``sort_order`` - いいえ - 表示順序（0以上2147483647以下の整数） - * - ``virtualHost`` + * - ``virtual_host`` - いいえ - 仮想ホスト（最大1000文字） - * - ``versionNo`` + * - ``version_no`` - はい - 楽観的ロック用のバージョン番号。\ ``setting/{id}`` の取得結果に含まれる値を指定します。 @@ -284,8 +284,8 @@ RelatedContent APIは、|Fess| の関連コンテンツを管理するためのA .. note:: - ``createdBy``・``createdTime``・``updatedBy``・``updatedTime`` などの監査フィールドや - ``crudMode`` をリクエストボディに含めても、サーバー側で自動的に設定されるため無視されます。 + ``created_by``・``created_time``・``updated_by``・``updated_time`` などの監査フィールドや + ``crud_mode`` をリクエストボディに含めても、サーバー側で自動的に設定されるため無視されます。 作成・更新時に指定する必要はありません。 関連コンテンツ削除 @@ -324,7 +324,7 @@ RelatedContent APIは、|Fess| の関連コンテンツを管理するためのA -d '{ "term": "product", "content": "

Our Products

", - "sortOrder": 0 + "sort_order": 0 }' サポート情報の関連コンテンツ @@ -338,7 +338,7 @@ RelatedContent APIは、|Fess| の関連コンテンツを管理するためのA -d '{ "term": "support", "content": "

Need help? Contact: support@example.com

", - "sortOrder": 0 + "sort_order": 0 }' 参考情報 diff --git a/ja/15.9/api/admin/api-admin-relatedquery.rst b/ja/15.9/api/admin/api-admin-relatedquery.rst index 3674e8d3b..8605112ce 100644 --- a/ja/15.9/api/admin/api-admin-relatedquery.rst +++ b/ja/15.9/api/admin/api-admin-relatedquery.rst @@ -90,7 +90,7 @@ RelatedQuery APIは、|Fess| の関連クエリを管理するためのAPIです "id": "query_id_1", "term": "fess", "queries": "fess tutorial\nfess installation\nfess configuration", - "versionNo": 1 + "version_no": 1 } ], "total": 5 @@ -99,9 +99,9 @@ RelatedQuery APIは、|Fess| の関連クエリを管理するためのAPIです .. note:: - 各設定には ``versionNo``\ （楽観的ロック用のバージョン番号）が含まれます。\ ``virtualHost`` - や監査用フィールド（``createdBy``、``createdTime``、``updatedBy``、``updatedTime``）は、 - 値が設定されている場合に限り含まれます。値が空の ``virtualHost`` はレスポンスに含まれません。 + 各設定には ``version_no``\ （楽観的ロック用のバージョン番号）が含まれます。\ ``virtual_host`` + や監査用フィールド（``created_by``、``created_time``、``updated_by``、``updated_time``）は、 + 値が設定されている場合に限り含まれます。値が空の ``virtual_host`` はレスポンスに含まれません。 関連クエリ取得 ============== @@ -126,8 +126,8 @@ RelatedQuery APIは、|Fess| の関連クエリを管理するためのAPIです "id": "query_id_1", "term": "fess", "queries": "fess tutorial\nfess installation\nfess configuration", - "virtualHost": "site1.example.com", - "versionNo": 1 + "virtual_host": "site1.example.com", + "version_no": 1 } } } @@ -151,7 +151,7 @@ RelatedQuery APIは、|Fess| の関連クエリを管理するためのAPIです { "term": "search", "queries": "search tutorial\nsearch syntax\nadvanced search", - "virtualHost": "" + "virtual_host": "" } フィールド説明 @@ -170,13 +170,13 @@ RelatedQuery APIは、|Fess| の関連クエリを管理するためのAPIです * - ``queries`` - はい - 関連クエリ。1行に1件を記述した改行区切りの文字列です（空行は無視されます。最大10000文字） - * - ``virtualHost`` + * - ``virtual_host`` - いいえ - 仮想ホスト（最大1000文字） .. note:: - ``crudMode`` はAPI側で自動的に設定されるため、リクエストボディに含める必要はありません。 + ``crud_mode`` はAPI側で自動的に設定されるため、リクエストボディに含める必要はありません。 レスポンス ---------- @@ -212,8 +212,8 @@ RelatedQuery APIは、|Fess| の関連クエリを管理するためのAPIです "id": "existing_query_id", "term": "search", "queries": "search tutorial\nsearch syntax\nadvanced search\nsearch tips", - "virtualHost": "", - "versionNo": 1 + "virtual_host": "", + "version_no": 1 } フィールド説明 @@ -235,10 +235,10 @@ RelatedQuery APIは、|Fess| の関連クエリを管理するためのAPIです * - ``queries`` - はい - 関連クエリ。1行に1件を記述した改行区切りの文字列です（空行は無視されます。最大10000文字） - * - ``virtualHost`` + * - ``virtual_host`` - いいえ - 仮想ホスト（最大1000文字） - * - ``versionNo`` + * - ``version_no`` - はい - 楽観的ロック用のバージョン番号。取得時のレスポンスに含まれる値を指定します diff --git a/ja/15.9/api/admin/api-admin-role.rst b/ja/15.9/api/admin/api-admin-role.rst index 68c2394c3..123a17180 100644 --- a/ja/15.9/api/admin/api-admin-role.rst +++ b/ja/15.9/api/admin/api-admin-role.rst @@ -87,12 +87,12 @@ Role APIは、|Fess| のロールを管理するためのAPIです。 { "id": "role_id_1", "name": "admin", - "versionNo": 1 + "version_no": 1 }, { "id": "role_id_2", "name": "user", - "versionNo": 1 + "version_no": 1 } ], "total": 5 @@ -120,7 +120,7 @@ Role APIは、|Fess| のロールを管理するためのAPIです。 "setting": { "id": "role_id_1", "name": "admin", - "versionNo": 1 + "version_no": 1 } } } @@ -194,7 +194,7 @@ Role APIは、|Fess| のロールを管理するためのAPIです。 { "id": "existing_role_id", "name": "editor_updated", - "versionNo": 1 + "version_no": 1 } フィールド説明 @@ -216,9 +216,9 @@ Role APIは、|Fess| のロールを管理するためのAPIです。 * - ``attributes`` - いいえ - 属性のマップ。値は文字列で指定します - * - ``versionNo`` + * - ``version_no`` - はい - - 楽観的ロック用のバージョン番号。ロール取得で得た ``versionNo`` の値を指定します + - 楽観的ロック用のバージョン番号。ロール取得で得た ``version_no`` の値を指定します レスポンス ---------- diff --git a/ja/15.9/api/admin/api-admin-scheduler.rst b/ja/15.9/api/admin/api-admin-scheduler.rst index 31a392742..b9f1fa66b 100644 --- a/ja/15.9/api/admin/api-admin-scheduler.rst +++ b/ja/15.9/api/admin/api-admin-scheduler.rst @@ -91,14 +91,14 @@ Scheduler APIは、|Fess| のスケジュールジョブを管理するための "id": "job_id_1", "name": "Default Crawler", "target": "all", - "cronExpression": "0 0 0 * * ?", - "scriptType": "javascript", - "scriptData": "...", - "jobLogging": "true", + "cron_expression": "0 0 0 * * ?", + "script_type": "javascript", + "script_data": "...", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 0, - "versionNo": 1, + "sort_order": 0, + "version_no": 1, "running": false } ], @@ -112,7 +112,7 @@ Scheduler APIは、|Fess| のスケジュールジョブを管理するための .. note:: - レスポンス内の ``jobLogging`` / ``crawler`` / ``available`` は文字列（``"true"`` / ``"false"``）として返されます。\ ``running`` はブール値で、ジョブが現在実行中かどうかを示すレスポンス専用フィールドです（リクエストでは指定できません）。\ ``total`` は条件に一致する全ジョブ数です。 + レスポンス内の ``job_logging`` / ``crawler`` / ``available`` は文字列（``"true"`` / ``"false"``）として返されます。\ ``running`` はブール値で、ジョブが現在実行中かどうかを示すレスポンス専用フィールドです（リクエストでは指定できません）。\ ``total`` は条件に一致する全ジョブ数です。 スケジュールジョブ取得 ====================== @@ -136,14 +136,14 @@ Scheduler APIは、|Fess| のスケジュールジョブを管理するための "id": "job_id_1", "name": "Default Crawler", "target": "all", - "cronExpression": "0 0 0 * * ?", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "jobLogging": "true", + "cron_expression": "0 0 0 * * ?", + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 0, - "versionNo": 1, + "sort_order": 0, + "version_no": 1, "running": false } } @@ -168,13 +168,13 @@ Scheduler APIは、|Fess| のスケジュールジョブを管理するための { "name": "Daily Crawler", "target": "all", - "cronExpression": "0 0 2 * * ?", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "jobLogging": "true", + "cron_expression": "0 0 2 * * ?", + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 1 + "sort_order": 1 } フィールド説明 @@ -193,16 +193,16 @@ Scheduler APIは、|Fess| のスケジュールジョブを管理するための * - ``target`` - はい - 実行対象（最大100文字）。\ ``all`` または特定のターゲット名を指定します - * - ``cronExpression`` + * - ``cron_expression`` - いいえ - Cron式（秒 分 時 日 月 曜日）。最大100文字で、Cron式として検証されます。空の場合はスケジュール実行されず、手動でのみ起動できます - * - ``scriptType`` + * - ``script_type`` - はい - スクリプトタイプ（最大100文字）。\ ``javascript``\ （新規ジョブの既定値。\ ``job.default.script`` プロパティで決まります）または ``groovy``\ （\ ``fess-script-groovy`` プラグインが必要）を指定します - * - ``scriptData`` + * - ``script_data`` - いいえ - 実行スクリプト。最大サイズは ``fess_config.properties`` の ``form.admin.max.input.size`` に従います - * - ``jobLogging`` + * - ``job_logging`` - いいえ - ジョブログの記録を有効化（文字列） * - ``crawler`` @@ -211,17 +211,17 @@ Scheduler APIは、|Fess| のスケジュールジョブを管理するための * - ``available`` - いいえ - 有効/無効（文字列） - * - ``sortOrder`` + * - ``sort_order`` - はい - 表示順序（0〜2147483647の整数） .. note:: - ``jobLogging`` / ``crawler`` / ``available`` は文字列フィールドです。リクエストでは ``"on"`` または ``"true"``\ （大文字小文字を区別しない）を指定すると有効になり、それ以外の値（``"false"``、空文字列、未指定など）は無効として扱われます。レスポンスでは ``"true"`` / ``"false"`` として返されます。 + ``job_logging`` / ``crawler`` / ``available`` は文字列フィールドです。リクエストでは ``"on"`` または ``"true"``\ （大文字小文字を区別しない）を指定すると有効になり、それ以外の値（``"false"``、空文字列、未指定など）は無効として扱われます。レスポンスでは ``"true"`` / ``"false"`` として返されます。 .. note:: - ``crudMode`` はサーバー側で自動的に設定されるため、リクエストで指定する必要はありません。\ ``createdBy`` / ``createdTime`` などの監査フィールドもサーバー側で設定されます。 + ``crud_mode`` はサーバー側で自動的に設定されるため、リクエストで指定する必要はありません。\ ``created_by`` / ``created_time`` などの監査フィールドもサーバー側で設定されます。 レスポンス ---------- @@ -274,19 +274,19 @@ Cron式の例 "id": "existing_job_id", "name": "Updated Crawler", "target": "all", - "cronExpression": "0 0 3 * * ?", - "scriptType": "javascript", - "scriptData": "...", - "jobLogging": "true", + "cron_expression": "0 0 3 * * ?", + "script_type": "javascript", + "script_data": "...", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 1, - "versionNo": 1 + "sort_order": 1, + "version_no": 1 } .. note:: - 更新では ``id``\ （最大1000文字）と ``versionNo`` が必須です。\ ``versionNo`` は楽観的ロックに使用され、取得時のレスポンスに含まれる値を指定します。値が一致しない場合は更新が失敗します。そのほかの必須フィールド（``name`` / ``target`` / ``scriptType`` / ``sortOrder``）は作成時と同様です。 + 更新では ``id``\ （最大1000文字）と ``version_no`` が必須です。\ ``version_no`` は楽観的ロックに使用され、取得時のレスポンスに含まれる値を指定します。値が一致しない場合は更新が失敗します。そのほかの必須フィールド（``name`` / ``target`` / ``script_type`` / ``sort_order``）は作成時と同様です。 レスポンス ---------- @@ -344,7 +344,7 @@ Cron式の例 { "response": { "status": 0, - "jobLogId": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6" + "job_log_id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6" } } @@ -357,15 +357,15 @@ Cron式の例 * - フィールド - 説明 - * - ``jobLogId`` - - 起動したジョブのジョブログID。ジョブログが有効な場合に発行されます。ジョブログが無効な場合は ``null`` になります。 + * - ``job_log_id`` + - 起動したジョブのジョブログID。ジョブログが有効な場合に発行されます。ジョブログが無効な場合はレスポンスに含まれません。 注意事項 -------- - ジョブが既に実行中の場合、起動に失敗しエラー（``status`` が ``0`` 以外）が返されます - ジョブが無効（``available`` が有効でない）の場合も、同様に起動に失敗しエラーが返されます -- ``jobLogId`` は、ジョブログが有効（``jobLogging`` が有効）な場合にのみ発行されます +- ``job_log_id`` は、ジョブログが有効（``job_logging`` が有効）な場合にのみ発行されます ジョブ停止 ========== @@ -405,13 +405,13 @@ Cron式の例 -d '{ "name": "Hourly Crawler", "target": "all", - "cronExpression": "0 0 * * * ?", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "jobLogging": "true", + "cron_expression": "0 0 * * * ?", + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 1 + "sort_order": 1 }' # ジョブを即座に実行 diff --git a/ja/15.9/api/admin/api-admin-suggest.rst b/ja/15.9/api/admin/api-admin-suggest.rst index 96644db7f..2eaad16a4 100644 --- a/ja/15.9/api/admin/api-admin-suggest.rst +++ b/ja/15.9/api/admin/api-admin-suggest.rst @@ -77,9 +77,9 @@ Suggest APIは、|Fess| のサジェスト機能で利用されるサジェス "version": "15.9.0", "status": 0, "setting": { - "totalWordsNum": 1500, - "documentWordsNum": 1200, - "queryWordsNum": 450 + "total_words_num": 1500, + "document_words_num": 1200, + "query_words_num": 450 } } } @@ -93,18 +93,18 @@ Suggest APIは、|Fess| のサジェスト機能で利用されるサジェス * - フィールド - 説明 - * - ``setting.totalWordsNum`` + * - ``setting.total_words_num`` - サジェストワードの総数（サジェストインデックスに登録されているサジェストワードの件数） - * - ``setting.documentWordsNum`` + * - ``setting.document_words_num`` - ドキュメント由来のサジェストワード数（ドキュメント頻度が1以上のサジェストワードの件数） - * - ``setting.queryWordsNum`` + * - ``setting.query_words_num`` - 検索クエリ由来のサジェストワード数（クエリ頻度が1以上のサジェストワードの件数） .. note:: - ``documentWordsNum`` と ``queryWordsNum`` は排他的ではありません。1つのサジェストワードが + ``document_words_num`` と ``query_words_num`` は排他的ではありません。1つのサジェストワードが ドキュメントと検索クエリの両方に由来する場合は、両方の件数に含まれます。このため、 - ``documentWordsNum`` と ``queryWordsNum`` の合計が ``totalWordsNum`` と一致しないことがあります。 + ``document_words_num`` と ``query_words_num`` の合計が ``total_words_num`` と一致しないことがあります。 全サジェストワードの削除 ======================== diff --git a/ja/15.9/api/admin/api-admin-systeminfo.rst b/ja/15.9/api/admin/api-admin-systeminfo.rst index 429a8bc72..8301b2953 100644 --- a/ja/15.9/api/admin/api-admin-systeminfo.rst +++ b/ja/15.9/api/admin/api-admin-systeminfo.rst @@ -57,22 +57,22 @@ SystemInfo APIは、|Fess| のシステム情報を取得するためのAPIで "response": { "version": "15.9.0", "status": 0, - "envProps": [ + "env_props": [ {"label": "JAVA_HOME", "value": "/usr/lib/jvm/java-21"}, {"label": "FESS_DICTIONARY_PATH", "value": "/var/lib/fess/dict"} ], - "systemProps": [ + "system_props": [ {"label": "java.version", "value": "21.0.1"}, {"label": "java.vendor", "value": "Oracle Corporation"}, {"label": "os.name", "value": "Linux"}, {"label": "user.dir", "value": "/opt/fess"} ], - "fessProps": [ + "fess_props": [ {"label": "crawler.document.max.site.length", "value": "100"}, {"label": "indexer.thread.dump.enabled", "value": "true"}, {"label": "app.cipher.key", "value": "XXXXXXXX"} ], - "bugReportProps": [ + "bug_report_props": [ {"label": "os.name", "value": "Linux"}, {"label": "java.vm.version", "value": "21.0.1+12"} ] @@ -92,24 +92,24 @@ SystemInfo APIは、|Fess| のシステム情報を取得するためのAPIで - |Fess| の製品バージョン（例: ``15.9.0``）。 * - ``status`` - 処理結果を示すコード。\ ``0`` は正常終了を表します。 - * - ``envProps`` + * - ``env_props`` - 環境変数の一覧（``label`` / ``value`` の配列）。\ ``System.getenv()`` で取得される値がそのまま返されます。 - * - ``systemProps`` + * - ``system_props`` - Javaのシステムプロパティの一覧（``label`` / ``value`` の配列）。\ ``System.getProperties()`` で取得される値がそのまま返されます。 - * - ``fessProps`` + * - ``fess_props`` - |Fess| の設定プロパティの一覧（``label`` / ``value`` の配列）。\ ``fess_config.properties`` の設定値と、管理画面で設定されるシステムプロパティが含まれます。機密性の高い項目はマスクされます（下記の注記を参照）。 - * - ``bugReportProps`` + * - ``bug_report_props`` - バグレポート用に収集される情報の一覧（``label`` / ``value`` の配列）。OSおよびJava実行環境に関する主要なシステムプロパティ（``os.name``、``os.version``、``java.vm.version`` など）と、|Fess| のシステムプロパティ設定値が含まれます。 .. note:: - ``fessProps`` では、以下の機密性の高い設定値はマスクされ、``XXXXXXXX`` として返されます: + ``fess_props`` では、以下の機密性の高い設定値はマスクされ、``XXXXXXXX`` として返されます: ``http.proxy.password``、``ldap.admin.security.credentials``、``spnego.preauth.password``、 ``app.cipher.key``、``oic.client.id``、``oic.client.secret``\ 。 .. warning:: - ``envProps``\ （環境変数）と ``systemProps``\ （Javaシステムプロパティ）はマスクされず、 + ``env_props``\ （環境変数）と ``system_props``\ （Javaシステムプロパティ）はマスクされず、 設定されている値がそのまま返されます。環境変数やシステムプロパティに認証情報などの 機密情報を含めている場合、それらがレスポンスに含まれる点に注意してください。 diff --git a/ja/15.9/api/admin/api-admin-user.rst b/ja/15.9/api/admin/api-admin-user.rst index 2ab8166aa..0c538ecb9 100644 --- a/ja/15.9/api/admin/api-admin-user.rst +++ b/ja/15.9/api/admin/api-admin-user.rst @@ -105,7 +105,7 @@ User APIは、|Fess| のユーザーアカウントを管理するためのREST }, "roles": ["admin"], "groups": [], - "versionNo": 1 + "version_no": 1 } ], "total": 10 @@ -150,7 +150,7 @@ User APIは、|Fess| のユーザーアカウントを管理するためのREST }, "roles": ["admin"], "groups": [], - "versionNo": 1 + "version_no": 1 } } } @@ -179,7 +179,7 @@ User APIは、|Fess| のユーザーアカウントを管理するためのREST { "name": "testuser", "password": "securepassword", - "confirmPassword": "securepassword", + "confirm_password": "securepassword", "attributes": { "surname": "Test", "givenName": "User", @@ -205,7 +205,7 @@ User APIは、|Fess| のユーザーアカウントを管理するためのREST * - ``password`` - いいえ - パスワード - * - ``confirmPassword`` + * - ``confirm_password`` - いいえ - 確認用パスワード * - ``attributes`` @@ -220,7 +220,7 @@ User APIは、|Fess| のユーザーアカウントを管理するためのREST .. note:: - REST APIでは、パスワードの必須チェック、``password`` と ``confirmPassword`` の一致チェック、 + REST APIでは、パスワードの必須チェック、``password`` と ``confirm_password`` の一致チェック、 パスワードポリシー検証は行われません（これらは管理画面でのみ適用されます）。 運用上は、一致する有効な ``password`` を指定することを推奨します。 @@ -277,7 +277,7 @@ User APIは、|Fess| のユーザーアカウントを管理するためのREST "id": "existing_user_id", "name": "testuser", "password": "newpassword", - "confirmPassword": "newpassword", + "confirm_password": "newpassword", "attributes": { "surname": "Test", "givenName": "User Updated", @@ -285,7 +285,7 @@ User APIは、|Fess| のユーザーアカウントを管理するためのREST }, "roles": ["user", "editor"], "groups": ["group_id_1", "group_id_2"], - "versionNo": 1 + "version_no": 1 } フィールド説明 @@ -304,13 +304,13 @@ User APIは、|Fess| のユーザーアカウントを管理するためのREST * - ``name`` - はい - ユーザー名（ログインID） - * - ``versionNo`` + * - ``version_no`` - はい - バージョン番号（楽観的ロック用） * - ``password`` - いいえ - 新しいパスワード（指定した場合のみ更新） - * - ``confirmPassword`` + * - ``confirm_password`` - いいえ - 確認用パスワード * - ``attributes`` @@ -325,8 +325,8 @@ User APIは、|Fess| のユーザーアカウントを管理するためのREST .. note:: - 更新時は ``id`` ・``name`` ・``versionNo`` が必須です。 - ``versionNo`` は対象ユーザーの取得（GET）時に返される値で、OpenSearchドキュメントのバージョンに対応します。 + 更新時は ``id`` ・``name`` ・``version_no`` が必須です。 + ``version_no`` は対象ユーザーの取得（GET）時に返される値で、OpenSearchドキュメントのバージョンに対応します。 値が現在のバージョンと一致しない場合、競合と判断され更新は拒否されます。 レスポンス @@ -391,7 +391,7 @@ User APIは、|Fess| のユーザーアカウントを管理するためのREST -d '{ "name": "john.doe", "password": "SecureP@ss123", - "confirmPassword": "SecureP@ss123", + "confirm_password": "SecureP@ss123", "attributes": { "surname": "Doe", "givenName": "John", @@ -413,7 +413,7 @@ User APIは、|Fess| のユーザーアカウントを管理するためのREST "id": "user_id_123", "name": "john.doe", "roles": ["user", "editor", "admin"], - "versionNo": 1 + "version_no": 1 }' 参考情報 diff --git a/ja/15.9/api/admin/api-admin-webconfig.rst b/ja/15.9/api/admin/api-admin-webconfig.rst index f2337e65c..094022bd7 100644 --- a/ja/15.9/api/admin/api-admin-webconfig.rst +++ b/ja/15.9/api/admin/api-admin-webconfig.rst @@ -106,21 +106,21 @@ Webクロール設定一覧取得 "name": "Example Site", "description": "サンプルサイト", "urls": "https://example.com/", - "includedUrls": ".*example\\.com.*", - "excludedUrls": ".*\\.(pdf|zip)$", - "includedDocUrls": "", - "excludedDocUrls": "", - "configParameter": "", + "included_urls": ".*example\\.com.*", + "excluded_urls": ".*\\.(pdf|zip)$", + "included_doc_urls": "", + "excluded_doc_urls": "", + "config_parameter": "", "depth": 3, - "maxAccessCount": 1000, - "userAgent": "Mozilla/5.0", - "numOfThread": 1, - "intervalTime": 1000, + "max_access_count": 1000, + "user_agent": "Mozilla/5.0", + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, "available": "true", "permissions": "{role}admin", - "virtualHosts": "", - "sortOrder": 0 + "virtual_hosts": "", + "sort_order": 0 } ], "total": 5 @@ -152,35 +152,35 @@ Webクロール設定取得 "name": "Example Site", "description": "サンプルサイト", "urls": "https://example.com/", - "includedUrls": ".*example\\.com.*", - "excludedUrls": ".*\\.(pdf|zip)$", - "includedDocUrls": "", - "excludedDocUrls": "", - "configParameter": "", + "included_urls": ".*example\\.com.*", + "excluded_urls": ".*\\.(pdf|zip)$", + "included_doc_urls": "", + "excluded_doc_urls": "", + "config_parameter": "", "depth": 3, - "maxAccessCount": 1000, - "userAgent": "Mozilla/5.0", - "numOfThread": 1, - "intervalTime": 1000, + "max_access_count": 1000, + "user_agent": "Mozilla/5.0", + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin", - "virtualHosts": "", - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_hosts": "", + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } .. note:: - レスポンスには、登録・更新時に自動設定される ``createdBy`` 、 ``createdTime`` 、 - ``updatedBy`` 、 ``updatedTime`` 、 ``versionNo`` が含まれます。 - ``versionNo`` は更新時に必要です（後述の「Webクロール設定更新」を参照）。 + レスポンスには、登録・更新時に自動設定される ``created_by`` 、 ``created_time`` 、 + ``updated_by`` 、 ``updated_time`` 、 ``version_no`` が含まれます。 + ``version_no`` は更新時に必要です（後述の「Webクロール設定更新」を参照）。 Webクロール設定作成 =================== @@ -201,14 +201,14 @@ Webクロール設定作成 { "name": "Corporate Site", "urls": "https://www.example.com/", - "includedUrls": ".*www\\.example\\.com.*", - "excludedUrls": ".*\\.(pdf|zip|exe)$", - "userAgent": "Mozilla/5.0", - "numOfThread": 3, - "intervalTime": 500, + "included_urls": ".*www\\.example\\.com.*", + "excluded_urls": ".*\\.(pdf|zip|exe)$", + "user_agent": "Mozilla/5.0", + "num_of_thread": 3, + "interval_time": 500, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin\n{role}user" } @@ -231,34 +231,34 @@ Webクロール設定作成 * - ``urls`` - はい - クロール開始URL（複数の場合は改行区切り）。\ ``http:`` または ``https:`` で指定します - * - ``includedUrls`` + * - ``included_urls`` - いいえ - クロール対象URLの正規表現パターン - * - ``excludedUrls`` + * - ``excluded_urls`` - いいえ - クロール除外URLの正規表現パターン - * - ``includedDocUrls`` + * - ``included_doc_urls`` - いいえ - インデックス対象URLの正規表現パターン - * - ``excludedDocUrls`` + * - ``excluded_doc_urls`` - いいえ - インデックス除外URLの正規表現パターン - * - ``configParameter`` + * - ``config_parameter`` - いいえ - 追加設定パラメーター（``key=value`` 形式、1行に1項目） * - ``depth`` - いいえ - クロール深度（0以上） - * - ``maxAccessCount`` + * - ``max_access_count`` - いいえ - 最大アクセス数（0以上） - * - ``userAgent`` + * - ``user_agent`` - はい - User-Agent文字列（最大200文字） - * - ``numOfThread`` + * - ``num_of_thread`` - はい - 並列スレッド数（1以上） - * - ``intervalTime`` + * - ``interval_time`` - はい - アクセス間隔（ミリ秒、0以上） * - ``boost`` @@ -267,19 +267,19 @@ Webクロール設定作成 * - ``available`` - はい - 有効/無効（文字列 ``"true"`` / ``"false"``） - * - ``sortOrder`` + * - ``sort_order`` - はい - 表示順序（0以上） * - ``permissions`` - いいえ - アクセス許可ロール（複数の場合は改行区切り） - * - ``virtualHosts`` + * - ``virtual_hosts`` - いいえ - 仮想ホスト（複数の場合は改行区切り） .. note:: - ``createdBy`` 、 ``createdTime`` 、 ``updatedBy`` 、 ``updatedTime`` などの監査用フィールドは + ``created_by`` 、 ``created_time`` 、 ``updated_by`` 、 ``updated_time`` などの監査用フィールドは サーバー側で自動設定されるため、リクエストボディで指定する必要はありません。 レスポンス @@ -309,8 +309,8 @@ Webクロール設定更新 リクエストボディ ~~~~~~~~~~~~~~~~ -更新時は、作成時のフィールドに加えて、更新対象を特定する ``id`` とバージョン番号 ``versionNo`` が必須です。 -``versionNo`` には取得API（GET）のレスポンスに含まれる現在の値を指定します。 +更新時は、作成時のフィールドに加えて、更新対象を特定する ``id`` とバージョン番号 ``version_no`` が必須です。 +``version_no`` には取得API（GET）のレスポンスに含まれる現在の値を指定します。 .. code-block:: json @@ -318,17 +318,17 @@ Webクロール設定更新 "id": "existing_webconfig_id", "name": "Updated Corporate Site", "urls": "https://www.example.com/", - "includedUrls": ".*www\\.example\\.com.*", - "excludedUrls": ".*\\.(pdf|zip|exe|dmg)$", - "userAgent": "Mozilla/5.0", + "included_urls": ".*www\\.example\\.com.*", + "excluded_urls": ".*\\.(pdf|zip|exe|dmg)$", + "user_agent": "Mozilla/5.0", "depth": 10, - "maxAccessCount": 10000, - "numOfThread": 5, - "intervalTime": 300, + "max_access_count": 10000, + "num_of_thread": 5, + "interval_time": 300, "boost": 1.2, "available": "true", - "sortOrder": 0, - "versionNo": 1 + "sort_order": 0, + "version_no": 1 } 更新時の追加フィールド @@ -344,9 +344,9 @@ Webクロール設定更新 * - ``id`` - はい - 更新対象の設定ID（最大1000文字） - * - ``versionNo`` + * - ``version_no`` - はい - - 更新対象の現在のバージョン番号。取得API（GET）のレスポンスに含まれる ``versionNo`` を指定します + - 更新対象の現在のバージョン番号。取得API（GET）のレスポンスに含まれる ``version_no`` を指定します レスポンス ---------- @@ -385,7 +385,7 @@ Webクロール設定削除 URLパターンの例 =============== -``includedUrls`` / ``excludedUrls`` / ``includedDocUrls`` / ``excludedDocUrls`` には正規表現を指定します。 +``included_urls`` / ``excluded_urls`` / ``included_doc_urls`` / ``excluded_doc_urls`` には正規表現を指定します。 .. list-table:: :header-rows: 1 @@ -418,16 +418,16 @@ URLパターンの例 -d '{ "name": "Corporate Website", "urls": "https://www.example.com/", - "includedUrls": ".*www\\.example\\.com.*", - "excludedUrls": ".*/(login|admin|api)/.*", - "userAgent": "Mozilla/5.0", + "included_urls": ".*www\\.example\\.com.*", + "excluded_urls": ".*/(login|admin|api)/.*", + "user_agent": "Mozilla/5.0", "depth": 5, - "maxAccessCount": 10000, - "numOfThread": 3, - "intervalTime": 500, + "max_access_count": 10000, + "num_of_thread": 3, + "interval_time": 500, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}guest" }' @@ -442,15 +442,15 @@ URLパターンの例 -d '{ "name": "Documentation Site", "urls": "https://docs.example.com/", - "includedUrls": ".*docs\\.example\\.com.*", - "includedDocUrls": ".*\\.(html|htm)$", - "userAgent": "Mozilla/5.0", - "maxAccessCount": 50000, - "numOfThread": 5, - "intervalTime": 200, + "included_urls": ".*docs\\.example\\.com.*", + "included_doc_urls": ".*\\.(html|htm)$", + "user_agent": "Mozilla/5.0", + "max_access_count": 50000, + "num_of_thread": 5, + "interval_time": 200, "boost": 1.5, "available": "true", - "sortOrder": 0 + "sort_order": 0 }' 参考情報 diff --git a/ko/15.9/api/admin/api-admin-accesstoken.rst b/ko/15.9/api/admin/api-admin-accesstoken.rst index e9682f25d..4218898ff 100644 --- a/ko/15.9/api/admin/api-admin-accesstoken.rst +++ b/ko/15.9/api/admin/api-admin-accesstoken.rst @@ -98,14 +98,14 @@ HTTP 상태 코드)에 대해서는 :doc:`api-admin-overview` 를 참조하십 "id": "token_id_1", "name": "API Token 1", "token": "abcd1234efgh5678", - "parameterName": "permission", + "parameter_name": "permission", "permissions": "{role}admin-api", "expires": "2026-01-01T00:00:00", - "createdBy": "admin", - "createdTime": 1735689600000, - "updatedBy": "admin", - "updatedTime": 1735689600000, - "versionNo": 1 + "created_by": "admin", + "created_time": 1735689600000, + "updated_by": "admin", + "updated_time": 1735689600000, + "version_no": 1 } ], "total": 5 @@ -114,9 +114,9 @@ HTTP 상태 코드)에 대해서는 :doc:`api-admin-overview` 를 참조하십 .. note:: - 각 토큰 객체에는 ``createdBy`` , ``createdTime`` , ``updatedBy`` , - ``updatedTime`` , ``versionNo`` 와 같은 감사 정보 및 버전 정보도 포함됩니다. - ``createdTime`` 과 ``updatedTime`` 은 에포크 기준 밀리초(숫자)입니다. + 각 토큰 객체에는 ``created_by`` , ``created_time`` , ``updated_by`` , + ``updated_time`` , ``version_no`` 와 같은 감사 정보 및 버전 정보도 포함됩니다. + ``created_time`` 과 ``updated_time`` 은 에포크 기준 밀리초(숫자)입니다. 값이 ``null`` 인 필드는 응답에서 제외됩니다. ``permissions`` 는 줄 바꿈( ``\n`` ) 구분 문자열로 반환됩니다. @@ -142,14 +142,14 @@ HTTP 상태 코드)에 대해서는 :doc:`api-admin-overview` 를 참조하십 "id": "token_id_1", "name": "API Token 1", "token": "abcd1234efgh5678", - "parameterName": "permission", + "parameter_name": "permission", "permissions": "{role}admin-api", "expires": "2026-01-01T00:00:00", - "createdBy": "admin", - "createdTime": 1735689600000, - "updatedBy": "admin", - "updatedTime": 1735689600000, - "versionNo": 1 + "created_by": "admin", + "created_time": 1735689600000, + "updated_by": "admin", + "updated_time": 1735689600000, + "version_no": 1 } } } @@ -192,7 +192,7 @@ HTTP 상태 코드)에 대해서는 :doc:`api-admin-overview` 를 참조하십 * - ``permissions`` - 아니오 - 이 토큰에 부여할 권한. 줄 바꿈( ``\n`` ) 구분으로 여러 개를 지정할 수 있습니다 (예: ``{role}admin-api`` ). Admin API를 호출하는 토큰에는 ``api.admin.access.permissions`` (기본값 ``{role}admin-api`` )에 일치하는 권한이 필요합니다. - * - ``parameterName`` + * - ``parameter_name`` - 아니오 - 추가 권한을 전달하기 위한 요청 파라미터 이름. 이 토큰으로 인증된 요청에 여기서 지정한 이름의 파라미터가 포함된 경우 해당 값이 ``permissions`` 에 추가됩니다. 생략하면 설정되지 않습니다. * - ``expires`` @@ -239,7 +239,7 @@ HTTP 상태 코드)에 대해서는 :doc:`api-admin-overview` 를 참조하십 "name": "Updated API Token", "permissions": "{role}admin-api\n{role}user", "expires": "2026-01-01T00:00:00", - "versionNo": 1 + "version_no": 1 } 필드 설명 @@ -257,9 +257,9 @@ HTTP 상태 코드)에 대해서는 :doc:`api-admin-overview` 를 참조하십 * - ``id`` - 예 - 업데이트 대상 토큰 ID - * - ``versionNo`` + * - ``version_no`` - 예 - - 낙관적 잠금용 버전 번호. 사전에 조회한 토큰의 ``versionNo`` 를 지정합니다. + - 낙관적 잠금용 버전 번호. 사전에 조회한 토큰의 ``version_no`` 를 지정합니다. .. note:: diff --git a/ko/15.9/api/admin/api-admin-badword.rst b/ko/15.9/api/admin/api-admin-badword.rst index 50e762325..59abe24fc 100644 --- a/ko/15.9/api/admin/api-admin-badword.rst +++ b/ko/15.9/api/admin/api-admin-badword.rst @@ -92,7 +92,7 @@ NG 워드 목록 조회 "settings": [ { "id": "badword_id_1", - "suggestWord": "inappropriate_word" + "suggest_word": "inappropriate_word" } ], "total": 5 @@ -119,7 +119,7 @@ NG 워드 조회 "status": 0, "setting": { "id": "badword_id_1", - "suggestWord": "inappropriate_word" + "suggest_word": "inappropriate_word" } } } @@ -141,7 +141,7 @@ NG 워드 만들기 .. code-block:: json { - "suggestWord": "spam_keyword" + "suggest_word": "spam_keyword" } 필드 설명 @@ -154,7 +154,7 @@ NG 워드 만들기 * - 필드 - 필수 - 설명 - * - ``suggestWord`` + * - ``suggest_word`` - 예 - 제외할 키워드 (공백 문자를 포함할 수 없습니다) @@ -189,8 +189,8 @@ NG 워드 업데이트 { "id": "existing_badword_id", - "suggestWord": "updated_spam_keyword", - "versionNo": 1 + "suggest_word": "updated_spam_keyword", + "version_no": 1 } 응답 @@ -260,7 +260,7 @@ CSV 형식 ~~~~~~~~~~ - 1행째는 헤더 행으로 건너뜁니다 (열 이름은 임의. 다운로드 시에는 ``BadWord`` 가 출력됩니다). -- 2행째 이후로는 1행에 1개의 NG 워드를 ``suggestWord`` 로 기재합니다. +- 2행째 이후로는 1행에 1개의 NG 워드를 ``suggest_word`` 로 기재합니다. - 값이 공백뿐인 행은 무시됩니다. - 단어 앞에 ``--`` 를 붙이면 해당 단어를 삭제합니다 (예: ``--spam`` 은 ``spam`` 을 삭제). - 이미 등록된 단어를 지정한 경우에는 업데이트 (업데이트한 사람·업데이트 일시의 재설정)로 처리됩니다. @@ -306,7 +306,7 @@ CSV는 1행째에 ``BadWord`` 라는 헤더 행을 가지며, 2행째 이후로 -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "suggestWord": "spam" + "suggest_word": "spam" }' CSV 파일 업로드 diff --git a/ko/15.9/api/admin/api-admin-boostdoc.rst b/ko/15.9/api/admin/api-admin-boostdoc.rst index 15982e475..da8dea0b8 100644 --- a/ko/15.9/api/admin/api-admin-boostdoc.rst +++ b/ko/15.9/api/admin/api-admin-boostdoc.rst @@ -10,18 +10,18 @@ BoostDoc API는 |Fess| 의 문서 부스트 설정을 관리하기 위한 API입 검색 결과 상위에 표시되기 쉽게 할 수 있습니다. 부스트는 인덱스 생성 시(크롤링 시)에 각 문서에 적용됩니다. -조건(``urlExpr``)과 부스트 값(``boostExpr``)은 ``scriptType`` 필드에서 지정한 스크립트 엔진의 식으로 평가됩니다. -``scriptType`` 에는 ``javascript`` 와 ``groovy``(``fess-script-groovy`` 플러그인 필요) 중 하나를 지정할 수 있습니다. -관리 화면의 신규 작성 화면에서는 ``scriptType`` 에 ``javascript`` 가 미리 입력되지만, 이 API의 요청 본문에서 -``scriptType`` 을 생략하면 자동으로 채워지지 않고 Groovy로 평가됩니다. -여러 규칙은 ``sortOrder`` 의 오름차순으로 평가되며, 처음 조건이 일치한 규칙의 부스트 값만 적용됩니다 +조건(``url_expr``)과 부스트 값(``boost_expr``)은 ``script_type`` 필드에서 지정한 스크립트 엔진의 식으로 평가됩니다. +``script_type`` 에는 ``javascript`` 와 ``groovy``(``fess-script-groovy`` 플러그인 필요) 중 하나를 지정할 수 있습니다. +관리 화면의 신규 작성 화면에서는 ``script_type`` 에 ``javascript`` 가 미리 입력되지만, 이 API의 요청 본문에서 +``script_type`` 을 생략하면 자동으로 채워지지 않고 Groovy로 평가됩니다. +여러 규칙은 ``sort_order`` 의 오름차순으로 평가되며, 처음 조건이 일치한 규칙의 부스트 값만 적용됩니다 (일치하는 규칙이 발견되면, 이후 규칙은 평가되지 않습니다). .. note:: - 관리 화면에서는 ``urlExpr`` 은 "조건", ``boostExpr`` 은 "부스트 값 식", ``scriptType`` 은 "스크립트 종류"로 - 표시됩니다. ``scriptType`` 은 생성·수정·조회(목록·상세)의 요청 본문 및 응답에만 포함되며, 목록 조회의 - 필터 파라미터(``urlExpr``, ``boostExpr``)에는 포함되지 않습니다. + 관리 화면에서는 ``url_expr`` 은 "조건", ``boost_expr`` 은 "부스트 값 식", ``script_type`` 은 "스크립트 종류"로 + 표시됩니다. ``script_type`` 은 생성·수정·조회(목록·상세)의 요청 본문 및 응답에만 포함되며, 목록 조회의 + 필터 파라미터(``url_expr``, ``boost_expr``)에는 포함되지 않습니다. 설정 항목의 자세한 내용은 :doc:`../../admin/boostdoc-guide` 를 참조하십시오. 기본 URL @@ -92,11 +92,11 @@ BoostDoc API는 |Fess| 의 문서 부스트 설정을 관리하기 위한 API입 - Integer - 아니오 - 페이지 번호 (1부터 시작. 기본값: 1) - * - ``urlExpr`` + * - ``url_expr`` - String - 아니오 - 조건식으로 필터링 (부분 일치) - * - ``boostExpr`` + * - ``boost_expr`` - String - 아니오 - 부스트 값 식으로 필터링 (부분 일치) @@ -112,11 +112,11 @@ BoostDoc API는 |Fess| 의 문서 부스트 설정을 관리하기 위한 API입 "settings": [ { "id": "boostdoc_id_1", - "urlExpr": "url.startsWith(\"https://docs.example.com/\")", - "boostExpr": "3.0", - "scriptType": "javascript", - "sortOrder": 1, - "versionNo": 1 + "url_expr": "url.startsWith(\"https://docs.example.com/\")", + "boost_expr": "3.0", + "script_type": "javascript", + "sort_order": 1, + "version_no": 1 } ], "total": 5 @@ -125,8 +125,8 @@ BoostDoc API는 |Fess| 의 문서 부스트 설정을 관리하기 위한 API입 .. note:: - 위에 표시된 필드 외에도, 응답의 각 설정 객체에는 생성/업데이트 메타데이터(``createdBy``, ``createdTime``, ``updatedBy``, ``updatedTime``)가 포함됩니다. - ``versionNo`` 는 업데이트(PUT) 시에 필수이므로, 업데이트 전에 조회 또는 목록 API를 통해 현재 값을 취득하십시오. + 위에 표시된 필드 외에도, 응답의 각 설정 객체에는 생성/업데이트 메타데이터(``created_by``, ``created_time``, ``updated_by``, ``updated_time``)가 포함됩니다. + ``version_no`` 는 업데이트(PUT) 시에 필수이므로, 업데이트 전에 조회 또는 목록 API를 통해 현재 값을 취득하십시오. 문서 부스트 조회 ================ @@ -148,11 +148,11 @@ BoostDoc API는 |Fess| 의 문서 부스트 설정을 관리하기 위한 API입 "status": 0, "setting": { "id": "boostdoc_id_1", - "urlExpr": "url.startsWith(\"https://docs.example.com/\")", - "boostExpr": "3.0", - "scriptType": "javascript", - "sortOrder": 1, - "versionNo": 1 + "url_expr": "url.startsWith(\"https://docs.example.com/\")", + "boost_expr": "3.0", + "script_type": "javascript", + "sort_order": 1, + "version_no": 1 } } } @@ -174,10 +174,10 @@ BoostDoc API는 |Fess| 의 문서 부스트 설정을 관리하기 위한 API입 .. code-block:: json { - "urlExpr": "url.startsWith(\"https://important.example.com/\")", - "boostExpr": "5.0", - "scriptType": "javascript", - "sortOrder": 0 + "url_expr": "url.startsWith(\"https://important.example.com/\")", + "boost_expr": "5.0", + "script_type": "javascript", + "sort_order": 0 } 필드 설명 @@ -190,16 +190,16 @@ BoostDoc API는 |Fess| 의 문서 부스트 설정을 관리하기 위한 API입 * - 필드 - 필수 - 설명 - * - ``urlExpr`` + * - ``url_expr`` - 예 - 조건식. 부스트 대상 문서를 판별하는 스크립트 식으로, ``Boolean`` 을 반환합니다. 관리 화면의 "조건"에 해당합니다 (최대 10000자). - * - ``boostExpr`` + * - ``boost_expr`` - 예 - 부스트 값 식. 부스트 값(숫자)을 반환하는 스크립트 식입니다. ``3.0`` 과 같은 고정값도 지정할 수 있습니다. 관리 화면의 "부스트 값 식"에 해당합니다 (최대 10000자). - * - ``scriptType`` + * - ``script_type`` - 아니오 - - ``urlExpr`` 과 ``boostExpr`` 을 평가하는 스크립트 엔진. ``javascript`` 또는 ``groovy``(``fess-script-groovy`` 플러그인 필요)를 지정합니다. 관리 화면의 "스크립트 종류"에 해당합니다 (최대 100자). 생략하면 Groovy로 평가됩니다. - * - ``sortOrder`` + - ``url_expr`` 과 ``boost_expr`` 을 평가하는 스크립트 엔진. ``javascript`` 또는 ``groovy``(``fess-script-groovy`` 플러그인 필요)를 지정합니다. 관리 화면의 "스크립트 종류"에 해당합니다 (최대 100자). 생략하면 Groovy로 평가됩니다. + * - ``sort_order`` - 예 - 적용 순서. 규칙은 오름차순으로 평가되며, 처음 조건이 일치한 규칙의 부스트 값이 적용됩니다 (폼 초기값: 0, 0 이상의 정수). @@ -234,15 +234,15 @@ BoostDoc API는 |Fess| 의 문서 부스트 설정을 관리하기 위한 API입 { "id": "existing_boostdoc_id", - "urlExpr": "url.startsWith(\"https://important.example.com/\")", - "boostExpr": "10.0", - "scriptType": "javascript", - "sortOrder": 0, - "versionNo": 1 + "url_expr": "url.startsWith(\"https://important.example.com/\")", + "boost_expr": "10.0", + "script_type": "javascript", + "sort_order": 0, + "version_no": 1 } -업데이트 시에는 만들기 시의 필드에 더하여 ``id`` (대상 규칙의 ID, 최대 1000자)와 ``versionNo`` (낙관적 잠금을 위한 버전 번호)가 필수입니다. -``versionNo`` 에는 조회 또는 목록 API 응답에서 취득한 현재 버전 번호를 지정하십시오. +업데이트 시에는 만들기 시의 필드에 더하여 ``id`` (대상 규칙의 ID, 최대 1000자)와 ``version_no`` (낙관적 잠금을 위한 버전 번호)가 필수입니다. +``version_no`` 에는 조회 또는 목록 API 응답에서 취득한 현재 버전 번호를 지정하십시오. 버전 번호가 일치하지 않으면 업데이트는 실패합니다. 응답 @@ -282,12 +282,12 @@ BoostDoc API는 |Fess| 의 문서 부스트 설정을 관리하기 위한 API입 조건식 및 부스트 값 식에 대하여 ================================ -``urlExpr`` (조건)과 ``boostExpr`` (부스트 값 식)은 ``scriptType``(기본값: Groovy. 관리 화면의 신규 작성 +``url_expr`` (조건)과 ``boost_expr`` (부스트 값 식)은 ``script_type``(기본값: Groovy. 관리 화면의 신규 작성 화면에서만 ``javascript`` 가 미리 입력됨)에서 지정한 스크립트 엔진의 식으로 평가됩니다. 식 안에서는 인덱스 대상 문서의 필드 값을 필드명 변수로 참조할 수 있습니다. -- ``urlExpr`` 은 ``Boolean`` 을 반환해야 합니다 (예: ``url.startsWith("https://docs.example.com/")``). 단순 정규식 문자열 (예: ``.*docs\.example\.com.*``)은 스크립트 식으로서 ``Boolean`` 을 반환하지 않으므로 조건으로 동작하지 않습니다. 정규식을 사용하는 경우에는 ``String#matches`` 를 이용합니다(Groovy와 JavaScript 모두 동일한 표기법으로 사용할 수 있습니다). -- ``boostExpr`` 은 숫자를 반환해야 합니다. 결과는 ``float`` 으로 변환되며, 0보다 큰 경우에만 부스트가 적용됩니다. +- ``url_expr`` 은 ``Boolean`` 을 반환해야 합니다 (예: ``url.startsWith("https://docs.example.com/")``). 단순 정규식 문자열 (예: ``.*docs\.example\.com.*``)은 스크립트 식으로서 ``Boolean`` 을 반환하지 않으므로 조건으로 동작하지 않습니다. 정규식을 사용하는 경우에는 ``String#matches`` 를 이용합니다(Groovy와 JavaScript 모두 동일한 표기법으로 사용할 수 있습니다). +- ``boost_expr`` 은 숫자를 반환해야 합니다. 결과는 ``float`` 으로 변환되며, 0보다 큰 경우에만 부스트가 적용됩니다. .. note:: @@ -296,7 +296,7 @@ BoostDoc API는 |Fess| 의 문서 부스트 설정을 관리하기 위한 API입 ``indexer.favorite.count.enabled`` (모두 기본적으로 활성화)가 설정된 경우에 참조할 수 있습니다. ``now - 7d`` 와 같은 OpenSearch 날짜 계산 구문은 Groovy와 JavaScript 모두에서 사용할 수 없습니다. -조건식(``urlExpr``) 예시 +조건식(``url_expr``) 예시 ------------------------- .. list-table:: @@ -312,7 +312,7 @@ BoostDoc API는 |Fess| 의 문서 부스트 설정을 관리하기 위한 API입 * - ``title.contains("릴리스 노트")`` - 제목에 특정 단어를 포함하는 문서를 대상으로 함 -부스트 값 식(``boostExpr``) 예시 +부스트 값 식(``boost_expr``) 예시 --------------------------------- .. list-table:: @@ -340,9 +340,9 @@ BoostDoc API는 |Fess| 의 문서 부스트 설정을 관리하기 위한 API입 -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "urlExpr": "url.startsWith(\"https://docs.example.com/\")", - "boostExpr": "5.0", - "sortOrder": 0 + "url_expr": "url.startsWith(\"https://docs.example.com/\")", + "boost_expr": "5.0", + "sort_order": 0 }' 클릭 수가 많은 콘텐츠 부스트 @@ -354,9 +354,9 @@ BoostDoc API는 |Fess| 의 문서 부스트 설정을 관리하기 위한 API입 -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "urlExpr": "url.startsWith(\"https://www.example.com/\")", - "boostExpr": "click_count * 0.1 + 1", - "sortOrder": 10 + "url_expr": "url.startsWith(\"https://www.example.com/\")", + "boost_expr": "click_count * 0.1 + 1", + "sort_order": 10 }' 참고 정보 diff --git a/ko/15.9/api/admin/api-admin-crawlinginfo.rst b/ko/15.9/api/admin/api-admin-crawlinginfo.rst index b64adf21e..a1bfc69c4 100644 --- a/ko/15.9/api/admin/api-admin-crawlinginfo.rst +++ b/ko/15.9/api/admin/api-admin-crawlinginfo.rst @@ -67,7 +67,7 @@ CrawlingInfo API는 |Fess| 의 크롤링 정보(크롤링 세션)를 참조 및 - Integer - 아니오 - 페이지 번호 (1부터 시작, 기본값: 1) - * - ``sessionId`` + * - ``session_id`` - String - 아니오 - 세션 ID 필터 (부분 일치) @@ -83,17 +83,17 @@ CrawlingInfo API는 |Fess| 의 크롤링 정보(크롤링 세션)를 참조 및 "logs": [ { "id": "crawling_info_id_1", - "sessionId": "20250129100000", + "session_id": "20250129100000", "name": "Default Crawler", - "expiredTime": "1738200000000", - "createdTime": 1738108800000 + "expired_time": "1738200000000", + "created_time": 1738108800000 }, { "id": "crawling_info_id_2", - "sessionId": "20250128100000", + "session_id": "20250128100000", "name": "Default Crawler", - "expiredTime": "1738113600000", - "createdTime": 1738022400000 + "expired_time": "1738113600000", + "created_time": 1738022400000 } ], "total": 10 @@ -111,18 +111,18 @@ CrawlingInfo API는 |Fess| 의 크롤링 정보(크롤링 세션)를 참조 및 - 설명 * - ``id`` - 크롤링 정보 ID - * - ``sessionId`` + * - ``session_id`` - 세션 ID * - ``name`` - 세션 이름 - * - ``expiredTime`` + * - ``expired_time`` - 유효 기간 (에포크 밀리초; 문자열로 반환됨) - * - ``createdTime`` + * - ``created_time`` - 작성 시각 (에포크 밀리초; 숫자로 반환됨) .. note:: - 응답의 각 로그 오브젝트에는 내부적으로 사용되는 ``crudMode`` 필드 + 응답의 각 로그 오브젝트에는 내부적으로 사용되는 ``crud_mode`` 필드 (CRUD 작업 모드를 나타내는 정수값으로, 읽기 작업 시 항상 ``0``)가 포함됩니다. 클라이언트 측에서는 무시해도 됩니다. @@ -146,10 +146,10 @@ CrawlingInfo API는 |Fess| 의 크롤링 정보(크롤링 세션)를 참조 및 "status": 0, "log": { "id": "crawling_info_id_1", - "sessionId": "20250129100000", + "session_id": "20250129100000", "name": "Default Crawler", - "expiredTime": "1738200000000", - "createdTime": 1738108800000 + "expired_time": "1738200000000", + "created_time": 1738108800000 } } } diff --git a/ko/15.9/api/admin/api-admin-dataconfig.rst b/ko/15.9/api/admin/api-admin-dataconfig.rst index 092320f96..8e5fc318d 100644 --- a/ko/15.9/api/admin/api-admin-dataconfig.rst +++ b/ko/15.9/api/admin/api-admin-dataconfig.rst @@ -74,7 +74,7 @@ DataConfig API는 |Fess| 의 데이터스토어 설정을 관리하기 위한 AP - String - 아니오 - 설정 이름으로 필터링 - * - ``handlerName`` + * - ``handler_name`` - String - 아니오 - 핸들러 이름으로 필터링 @@ -96,14 +96,14 @@ DataConfig API는 |Fess| 의 데이터스토어 설정을 관리하기 위한 AP "id": "dataconfig_id_1", "name": "Database Crawler", "description": "데이터베이스 크롤러", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/mydb", - "handlerScript": "...", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/mydb", + "handler_script": "...", "boost": 1.0, "available": "true", "permissions": "{role}admin", - "virtualHosts": "", - "sortOrder": 0 + "virtual_hosts": "", + "sort_order": 0 } ], "total": 5 @@ -132,14 +132,14 @@ DataConfig API는 |Fess| 의 데이터스토어 설정을 관리하기 위한 AP "id": "dataconfig_id_1", "name": "Database Crawler", "description": "데이터베이스 크롤러", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/mydb\nusername=dbuser\npassword=dbpass", - "handlerScript": "...", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/mydb\nusername=dbuser\npassword=dbpass", + "handler_script": "...", "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin", - "virtualHosts": "" + "virtual_hosts": "" } } } @@ -162,12 +162,12 @@ DataConfig API는 |Fess| 의 데이터스토어 설정을 관리하기 위한 AP { "name": "Product Database", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/products\nusername=user\npassword=pass", - "handlerScript": "url=\"https://example.com/product/\" + product_id\ntitle=product_name\ncontent=description", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/products\nusername=user\npassword=pass", + "handler_script": "url=\"https://example.com/product/\" + product_id\ntitle=product_name\ncontent=description", "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin\n{role}user" } @@ -187,13 +187,13 @@ DataConfig API는 |Fess| 의 데이터스토어 설정을 관리하기 위한 AP * - ``description`` - 아니오 - 설정 설명 - * - ``handlerName`` + * - ``handler_name`` - 예 - 데이터스토어 핸들러 이름 - * - ``handlerParameter`` + * - ``handler_parameter`` - 아니오 - 핸들러 파라미터 (연결 정보 등) - * - ``handlerScript`` + * - ``handler_script`` - 아니오 - 데이터 변환 스크립트 * - ``boost`` @@ -202,13 +202,13 @@ DataConfig API는 |Fess| 의 데이터스토어 설정을 관리하기 위한 AP * - ``available`` - 예 - 활성화/비활성화 (문자열 ``"true"`` / ``"false"``) - * - ``sortOrder`` + * - ``sort_order`` - 예 - 표시 순서 * - ``permissions`` - 아니오 - 접근 허용 역할 (여러 개인 경우 줄바꿈으로 구분) - * - ``virtualHosts`` + * - ``virtual_hosts`` - 아니오 - 가상 호스트 (여러 개인 경우 줄바꿈으로 구분) @@ -244,16 +244,16 @@ DataConfig API는 |Fess| 의 데이터스토어 설정을 관리하기 위한 AP { "id": "existing_dataconfig_id", "name": "Updated Product Database", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/products\nusername=user\npassword=newpass", - "handlerScript": "url=\"https://example.com/product/\" + product_id\ntitle=product_name\ncontent=description + \" \" + features", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/products\nusername=user\npassword=newpass", + "handler_script": "url=\"https://example.com/product/\" + product_id\ntitle=product_name\ncontent=description + \" \" + features", "boost": 1.5, "available": "true", - "sortOrder": 0, - "versionNo": 1 + "sort_order": 0, + "version_no": 1 } -업데이트 요청에는 생성 시와 동일한 필수 필드(``name``, ``handlerName``, ``boost``, ``available``, ``sortOrder``)에 더해 다음 필드가 필수입니다. +업데이트 요청에는 생성 시와 동일한 필수 필드(``name``, ``handler_name``, ``boost``, ``available``, ``sort_order``)에 더해 다음 필드가 필수입니다. .. list-table:: :header-rows: 1 @@ -265,7 +265,7 @@ DataConfig API는 |Fess| 의 데이터스토어 설정을 관리하기 위한 AP * - ``id`` - 예 - 업데이트할 설정 ID - * - ``versionNo`` + * - ``version_no`` - 예 - 낙관적 잠금을 위한 버전 번호(조회 시 얻은 값을 지정) @@ -340,12 +340,12 @@ DataConfig API는 |Fess| 의 데이터스토어 설정을 관리하기 위한 AP -H "Content-Type: application/json" \ -d '{ "name": "User Database", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/userdb\nusername=dbuser\npassword=dbpass\nsql=SELECT * FROM users WHERE active=true", - "handlerScript": "url=\"https://example.com/user/\" + user_id\ntitle=username\ncontent=profile", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/userdb\nusername=dbuser\npassword=dbpass\nsql=SELECT * FROM users WHERE active=true", + "handler_script": "url=\"https://example.com/user/\" + user_id\ntitle=username\ncontent=profile", "boost": 1.0, "available": "true", - "sortOrder": 0 + "sort_order": 0 }' 참고 정보 diff --git a/ko/15.9/api/admin/api-admin-dict.rst b/ko/15.9/api/admin/api-admin-dict.rst index 52e34ab11..6054ab88e 100644 --- a/ko/15.9/api/admin/api-admin-dict.rst +++ b/ko/15.9/api/admin/api-admin-dict.rst @@ -179,7 +179,7 @@ Dict API는 |Fess| 의 사전을 관리하기 위한 API입니다. "settings": [ { "id": 1, - "dictId": "ZjA5...synonym.txt", + "dict_id": "ZjA5...synonym.txt", "inputs": "検索,サーチ", "outputs": "検索,サーチ,リサーチ" } @@ -233,7 +233,7 @@ Dict API는 |Fess| 의 사전을 관리하기 위한 API입니다. "status": 0, "setting": { "id": 1, - "dictId": "ZjA5...synonym.txt", + "dict_id": "ZjA5...synonym.txt", "inputs": "検索,サーチ", "outputs": "検索,サーチ,リサーチ" } @@ -406,7 +406,7 @@ Dict API는 |Fess| 의 사전을 관리하기 위한 API입니다. ============================ 사전 항목의 생성, 업데이트 요청 본문 및 응답의 필드는 사전 종류별로 다릅니다. -``id`` (항목 ID)와 ``dictId`` (사전 ID)는 응답에 공통으로 포함됩니다. +``id`` (항목 ID)와 ``dict_id`` (사전 ID)는 응답에 공통으로 포함됩니다. .. list-table:: :header-rows: 1 diff --git a/ko/15.9/api/admin/api-admin-elevateword.rst b/ko/15.9/api/admin/api-admin-elevateword.rst index d8bac0b2e..9c8afc3fa 100644 --- a/ko/15.9/api/admin/api-admin-elevateword.rst +++ b/ko/15.9/api/admin/api-admin-elevateword.rst @@ -92,11 +92,11 @@ ElevateWord API는 |Fess| 의 엘리베이트 워드(특정 키워드에서의 "settings": [ { "id": "elevate_id_1", - "suggestWord": "fess", + "suggest_word": "fess", "reading": "", "permissions": "{role}guest", "boost": 100.0, - "labelTypeIds": [] + "label_type_ids": [] } ], "total": 5 @@ -123,11 +123,11 @@ ElevateWord API는 |Fess| 의 엘리베이트 워드(특정 키워드에서의 "status": 0, "setting": { "id": "elevate_id_1", - "suggestWord": "fess", + "suggest_word": "fess", "reading": "", "permissions": "{role}guest", "boost": 100.0, - "labelTypeIds": [] + "label_type_ids": [] } } } @@ -149,11 +149,11 @@ ElevateWord API는 |Fess| 의 엘리베이트 워드(특정 키워드에서의 .. code-block:: json { - "suggestWord": "documentation", + "suggest_word": "documentation", "reading": "", "permissions": "{role}guest", "boost": 100.0, - "labelTypeIds": ["label1"] + "label_type_ids": ["label1"] } 필드 설명 @@ -166,7 +166,7 @@ ElevateWord API는 |Fess| 의 엘리베이트 워드(특정 키워드에서의 * - 필드 - 필수 - 설명 - * - ``suggestWord`` + * - ``suggest_word`` - 예 - 엘리베이트 대상 키워드 * - ``reading`` @@ -178,7 +178,7 @@ ElevateWord API는 |Fess| 의 엘리베이트 워드(특정 키워드에서의 * - ``boost`` - 예 - 부스트 값 (폼 초기값: 100.0) - * - ``labelTypeIds`` + * - ``label_type_ids`` - 아니오 - 대상 라벨 ID (문자열 배열) @@ -213,12 +213,12 @@ ElevateWord API는 |Fess| 의 엘리베이트 워드(특정 키워드에서의 { "id": "existing_elevate_id", - "suggestWord": "documentation", + "suggest_word": "documentation", "reading": "", "permissions": "{role}guest\n{role}user", "boost": 100.0, - "labelTypeIds": ["label1"], - "versionNo": 1 + "label_type_ids": ["label1"], + "version_no": 1 } .. note:: @@ -226,7 +226,7 @@ ElevateWord API는 |Fess| 의 엘리베이트 워드(특정 키워드에서의 업데이트 시에는 만들기에서 사용하는 필드 외에 다음 필드가 필수입니다. - ``id`` - 업데이트 대상 엘리베이트 워드의 ID - - ``versionNo`` - 낙관적 잠금을 위한 버전 번호. ``GET /setting/{id}`` 로 취득한 값을 지정합니다. + - ``version_no`` - 낙관적 잠금을 위한 버전 번호. ``GET /setting/{id}`` 로 취득한 값을 지정합니다. 응답 ---------- @@ -326,7 +326,7 @@ CSV 파일에서 엘리베이트 워드를 일괄 등록합니다. 파일은 ``m -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "suggestWord": "Product X", + "suggest_word": "Product X", "boost": 100.0, "permissions": "{role}guest" }' @@ -340,9 +340,9 @@ CSV 파일에서 엘리베이트 워드를 일괄 등록합니다. 파일은 ``m -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "suggestWord": "API reference", + "suggest_word": "API reference", "boost": 100.0, - "labelTypeIds": ["technical_docs"], + "label_type_ids": ["technical_docs"], "permissions": "{role}guest" }' diff --git a/ko/15.9/api/admin/api-admin-failureurl.rst b/ko/15.9/api/admin/api-admin-failureurl.rst index 40a73e9d4..c02b0718b 100644 --- a/ko/15.9/api/admin/api-admin-failureurl.rst +++ b/ko/15.9/api/admin/api-admin-failureurl.rst @@ -71,15 +71,15 @@ FailureUrl API는 |Fess| 의 크롤링 실패 URL을 관리하기 위한 API입 - String - 아니오 - URL 필터 (와일드카드 ``*`` ``?`` 지원) - * - ``errorCountMin`` + * - ``error_count_min`` - Integer - 아니오 - 오류 횟수의 하한값 (지정한 값 이상) - * - ``errorCountMax`` + * - ``error_count_max`` - Integer - 아니오 - 오류 횟수의 상한값 (지정한 값 이하) - * - ``errorName`` + * - ``error_name`` - String - 아니오 - 오류 이름 필터 (저장된 완전한정 클래스명에 대한 와일드카드 매칭; ``*`` ``?`` 지원) @@ -96,22 +96,22 @@ FailureUrl API는 |Fess| 의 크롤링 실패 URL을 관리하기 위한 API입 { "id": "failure_id_1", "url": "https://example.com/broken-page", - "threadName": "Crawler-1", - "errorName": "java.net.ConnectException", - "errorLog": "Connection refused: connect", - "errorCount": "3", - "lastAccessTime": "1738144800000", - "configId": "webConfig_id_1" + "thread_name": "Crawler-1", + "error_name": "java.net.ConnectException", + "error_log": "Connection refused: connect", + "error_count": "3", + "last_access_time": "1738144800000", + "config_id": "webConfig_id_1" }, { "id": "failure_id_2", "url": "https://example.com/not-found", - "threadName": "Crawler-2", - "errorName": "org.codelibs.fess.exception.ContentNotFoundException", - "errorLog": "Not found: https://example.com/not-found", - "errorCount": "1", - "lastAccessTime": "1738143000000", - "configId": "webConfig_id_1" + "thread_name": "Crawler-2", + "error_name": "org.codelibs.fess.exception.ContentNotFoundException", + "error_log": "Not found: https://example.com/not-found", + "error_count": "1", + "last_access_time": "1738143000000", + "config_id": "webConfig_id_1" } ], "total": 45 @@ -131,22 +131,22 @@ FailureUrl API는 |Fess| 의 크롤링 실패 URL을 관리하기 위한 API입 - 실패 URL ID * - ``url`` - 실패한 URL - * - ``threadName`` + * - ``thread_name`` - 스레드 이름 - * - ``errorName`` + * - ``error_name`` - 오류 이름 (발생한 예외의 완전한정 클래스명; 예: ``java.net.ConnectException``) - * - ``errorLog`` + * - ``error_log`` - 오류 로그 (예외 메시지 또는 스택 트레이스) - * - ``errorCount`` + * - ``error_count`` - 오류 발생 횟수 (문자열로 표현된 숫자값) - * - ``lastAccessTime`` + * - ``last_access_time`` - 최종 접근 시각 (문자열로 표현된 에포크 밀리초) - * - ``configId`` + * - ``config_id`` - 크롤링 설정 ID .. note:: - 모든 응답 필드는 문자열(JSON string)로 반환됩니다. ``errorCount`` 는 문자열로 표현된 숫자값이며, ``lastAccessTime`` 은 문자열로 표현된 에포크 밀리초입니다. + 모든 응답 필드는 문자열(JSON string)로 반환됩니다. ``error_count`` 는 문자열로 표현된 숫자값이며, ``last_access_time`` 은 문자열로 표현된 에포크 밀리초입니다. 실패 URL 조회 ============= @@ -169,12 +169,12 @@ FailureUrl API는 |Fess| 의 크롤링 실패 URL을 관리하기 위한 API입 "log": { "id": "failure_id_1", "url": "https://example.com/broken-page", - "threadName": "Crawler-1", - "errorName": "java.net.ConnectException", - "errorLog": "Connection refused: connect", - "errorCount": "3", - "lastAccessTime": "1738144800000", - "configId": "webConfig_id_1" + "thread_name": "Crawler-1", + "error_name": "java.net.ConnectException", + "error_log": "Connection refused: connect", + "error_count": "3", + "last_access_time": "1738144800000", + "config_id": "webConfig_id_1" } } } @@ -226,7 +226,7 @@ FailureUrl API는 |Fess| 의 크롤링 실패 URL을 관리하기 위한 API입 오류 타입 ============ -``errorName`` 에는 크롤링 중 발생한 예외의 완전한정 클래스명이 있는 그대로 저장됩니다. 고정된 열거형이 아니며, 발생한 예외에 따라 어떠한 클래스명도 나타날 수 있습니다. 다음은 대표적인 예시입니다. +``error_name`` 에는 크롤링 중 발생한 예외의 완전한정 클래스명이 있는 그대로 저장됩니다. 고정된 열거형이 아니며, 발생한 예외에 따라 어떠한 클래스명도 나타날 수 있습니다. 다음은 대표적인 예시입니다. .. list-table:: :header-rows: 1 @@ -310,7 +310,7 @@ FailureUrl API는 |Fess| 의 크롤링 실패 URL을 관리하기 위한 API입 # 오류 타입별 카운트 curl -X GET "http://localhost:8080/api/admin/failureurl/logs?size=1000" \ -H "Authorization: Bearer YOUR_TOKEN" | \ - jq '[.response.logs[].errorName] | group_by(.) | map({error: .[0], count: length})' + jq '[.response.logs[].error_name] | group_by(.) | map({error: .[0], count: length})' 참고 정보 ========= diff --git a/ko/15.9/api/admin/api-admin-fileconfig.rst b/ko/15.9/api/admin/api-admin-fileconfig.rst index a55edf0bf..5849a7588 100644 --- a/ko/15.9/api/admin/api-admin-fileconfig.rst +++ b/ko/15.9/api/admin/api-admin-fileconfig.rst @@ -106,20 +106,20 @@ FileConfig API는 |Fess| 의 파일 크롤링 설정을 관리하기 위한 API "name": "Shared Documents", "description": "공유 문서", "paths": "smb://server/share/documents", - "includedPaths": ".*\\.pdf$", - "excludedPaths": ".*/(temp|cache)/.*", - "includedDocPaths": "", - "excludedDocPaths": "", - "configParameter": "", + "included_paths": ".*\\.pdf$", + "excluded_paths": ".*/(temp|cache)/.*", + "included_doc_paths": "", + "excluded_doc_paths": "", + "config_parameter": "", "depth": 10, - "maxAccessCount": 1000, - "numOfThread": 1, - "intervalTime": 1000, + "max_access_count": 1000, + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, "available": "true", "permissions": "{role}admin", - "virtualHosts": "", - "sortOrder": 0 + "virtual_hosts": "", + "sort_order": 0 } ], "total": 5 @@ -151,34 +151,34 @@ FileConfig API는 |Fess| 의 파일 크롤링 설정을 관리하기 위한 API "name": "Shared Documents", "description": "공유 문서", "paths": "smb://server/share/documents", - "includedPaths": ".*\\.pdf$", - "excludedPaths": ".*/(temp|cache)/.*", - "includedDocPaths": "", - "excludedDocPaths": "", - "configParameter": "", + "included_paths": ".*\\.pdf$", + "excluded_paths": ".*/(temp|cache)/.*", + "included_doc_paths": "", + "excluded_doc_paths": "", + "config_parameter": "", "depth": 10, - "maxAccessCount": 1000, - "numOfThread": 1, - "intervalTime": 1000, + "max_access_count": 1000, + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin", - "virtualHosts": "", - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_hosts": "", + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } .. note:: - 응답에는 등록 및 업데이트 시 자동으로 설정되는 ``createdBy``, ``createdTime``, - ``updatedBy``, ``updatedTime``, ``versionNo`` 가 포함됩니다. - ``versionNo`` 는 업데이트 시 필요합니다 (아래의 「파일 크롤링 설정 업데이트」를 참조). + 응답에는 등록 및 업데이트 시 자동으로 설정되는 ``created_by``, ``created_time``, + ``updated_by``, ``updated_time``, ``version_no`` 가 포함됩니다. + ``version_no`` 는 업데이트 시 필요합니다 (아래의 「파일 크롤링 설정 업데이트」를 참조). 파일 크롤링 설정 생성 ======================== @@ -199,13 +199,13 @@ FileConfig API는 |Fess| 의 파일 크롤링 설정을 관리하기 위한 API { "name": "Local Files", "paths": "file:///data/documents", - "includedPaths": ".*\\.(pdf|doc|docx|xls|xlsx)$", - "excludedPaths": ".*/(temp|backup)/.*", - "numOfThread": 2, - "intervalTime": 500, + "included_paths": ".*\\.(pdf|doc|docx|xls|xlsx)$", + "excluded_paths": ".*/(temp|backup)/.*", + "num_of_thread": 2, + "interval_time": 500, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin\n{role}user" } @@ -228,31 +228,31 @@ FileConfig API는 |Fess| 의 파일 크롤링 설정을 관리하기 위한 API * - ``paths`` - 예 - 크롤링 시작 경로 (여러 개인 경우 줄바꿈으로 구분). ``file:``, ``smb:``, ``smb1:``, ``ftp:``, ``s3:``, ``gcs:`` 중 하나의 프로토콜로 지정합니다 - * - ``includedPaths`` + * - ``included_paths`` - 아니오 - 크롤링 대상 경로의 정규 표현식 패턴 - * - ``excludedPaths`` + * - ``excluded_paths`` - 아니오 - 크롤링 제외 경로의 정규 표현식 패턴 - * - ``includedDocPaths`` + * - ``included_doc_paths`` - 아니오 - 인덱스 대상 경로의 정규 표현식 패턴 - * - ``excludedDocPaths`` + * - ``excluded_doc_paths`` - 아니오 - 인덱스 제외 경로의 정규 표현식 패턴 - * - ``configParameter`` + * - ``config_parameter`` - 아니오 - 추가 설정 파라미터 (``key=value`` 형식, 한 줄에 한 항목) * - ``depth`` - 아니오 - 크롤링 깊이 (0 이상) - * - ``maxAccessCount`` + * - ``max_access_count`` - 아니오 - 최대 접근 수 (0 이상) - * - ``numOfThread`` + * - ``num_of_thread`` - 예 - 병렬 스레드 수 (1 이상) - * - ``intervalTime`` + * - ``interval_time`` - 예 - 접근 간격 (밀리초, 0 이상) * - ``boost`` @@ -261,19 +261,19 @@ FileConfig API는 |Fess| 의 파일 크롤링 설정을 관리하기 위한 API * - ``available`` - 예 - 활성화/비활성화 (문자열 ``"true"`` / ``"false"``) - * - ``sortOrder`` + * - ``sort_order`` - 예 - 표시 순서 (0 이상) * - ``permissions`` - 아니오 - 접근 허용 역할 (여러 개인 경우 줄바꿈으로 구분) - * - ``virtualHosts`` + * - ``virtual_hosts`` - 아니오 - 가상 호스트 (여러 개인 경우 줄바꿈으로 구분) .. note:: - ``createdBy``, ``createdTime``, ``updatedBy``, ``updatedTime`` 등의 감사용 필드는 + ``created_by``, ``created_time``, ``updated_by``, ``updated_time`` 등의 감사용 필드는 서버 측에서 자동으로 설정되므로 요청 본문에 지정할 필요가 없습니다. 응답 @@ -303,8 +303,8 @@ FileConfig API는 |Fess| 의 파일 크롤링 설정을 관리하기 위한 API 요청 본문 ~~~~~~~~~~~~~~~~ -업데이트 시에는 생성 시의 필드에 더하여, 업데이트 대상을 식별하는 ``id`` 와 버전 번호 ``versionNo`` 가 필수입니다. -``versionNo`` 에는 조회 API (GET)의 응답에 포함된 현재 값을 지정합니다. +업데이트 시에는 생성 시의 필드에 더하여, 업데이트 대상을 식별하는 ``id`` 와 버전 번호 ``version_no`` 가 필수입니다. +``version_no`` 에는 조회 API (GET)의 응답에 포함된 현재 값을 지정합니다. .. code-block:: json @@ -312,16 +312,16 @@ FileConfig API는 |Fess| 의 파일 크롤링 설정을 관리하기 위한 API "id": "existing_fileconfig_id", "name": "Updated Local Files", "paths": "file:///data/documents", - "includedPaths": ".*\\.(pdf|doc|docx|xls|xlsx|ppt|pptx)$", - "excludedPaths": ".*/(temp|backup|archive)/.*", + "included_paths": ".*\\.(pdf|doc|docx|xls|xlsx|ppt|pptx)$", + "excluded_paths": ".*/(temp|backup|archive)/.*", "depth": 10, - "maxAccessCount": 10000, - "numOfThread": 3, - "intervalTime": 300, + "max_access_count": 10000, + "num_of_thread": 3, + "interval_time": 300, "boost": 1.2, "available": "true", - "sortOrder": 0, - "versionNo": 1 + "sort_order": 0, + "version_no": 1 } 업데이트 시 추가 필드 @@ -337,9 +337,9 @@ FileConfig API는 |Fess| 의 파일 크롤링 설정을 관리하기 위한 API * - ``id`` - 예 - 업데이트 대상의 설정 ID (최대 1000자) - * - ``versionNo`` + * - ``version_no`` - 예 - - 업데이트 대상의 현재 버전 번호. 조회 API (GET)의 응답에 포함된 ``versionNo`` 를 지정합니다 + - 업데이트 대상의 현재 버전 번호. 조회 API (GET)의 응답에 포함된 ``version_no`` 를 지정합니다 응답 ---------- @@ -418,13 +418,13 @@ FileConfig API는 |Fess| 의 파일 크롤링 설정을 관리하기 위한 API -d '{ "name": "Local Files", "paths": "file:///data/documents", - "includedPaths": ".*\\.(pdf|doc|docx)$", - "excludedPaths": ".*/(temp|backup)/.*", - "numOfThread": 2, - "intervalTime": 500, + "included_paths": ".*\\.(pdf|doc|docx)$", + "excluded_paths": ".*/(temp|backup)/.*", + "num_of_thread": 2, + "interval_time": 500, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}guest" }' @@ -439,14 +439,14 @@ SMB 공유 크롤링 설정 -d '{ "name": "SMB Share", "paths": "smb://server/documents", - "includedPaths": ".*\\.(pdf|doc|docx)$", - "excludedPaths": ".*/(temp|private)/.*", - "maxAccessCount": 50000, - "numOfThread": 3, - "intervalTime": 200, + "included_paths": ".*\\.(pdf|doc|docx)$", + "excluded_paths": ".*/(temp|private)/.*", + "max_access_count": 50000, + "num_of_thread": 3, + "interval_time": 200, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}guest" }' diff --git a/ko/15.9/api/admin/api-admin-general.rst b/ko/15.9/api/admin/api-admin-general.rst index 0047b87cb..cb66f0036 100644 --- a/ko/15.9/api/admin/api-admin-general.rst +++ b/ko/15.9/api/admin/api-admin-general.rst @@ -64,37 +64,36 @@ General API는 |Fess| 의 일반 설정（시스템 전반에 관한 설정） "version": "15.9.0", "status": 0, "setting": { - "incrementalCrawling": "true", - "dayForCleanup": -1, - "crawlingThreadCount": 5, - "searchLog": "true", - "userInfo": "true", - "userFavorite": "false", - "webApiJson": "true", - "defaultLabelValue": "", - "defaultSortValue": "", - "appendQueryParameter": "false", - "loginRequired": "false", + "incremental_crawling": "true", + "day_for_cleanup": -1, + "crawling_thread_count": 5, + "search_log": "true", + "user_info": "true", + "user_favorite": "false", + "web_api_json": "true", + "default_label_value": "", + "default_sort_value": "", + "append_query_parameter": "false", + "login_required": "false", "thumbnail": "true", - "failureCountThreshold": -1, - "popularWord": "true", - "csvFileEncoding": "UTF-8", - "purgeSearchLogDay": 30, - "purgeJobLogDay": 30, - "purgeUserInfoDay": 30, - "purgeSuggestSearchLogDay": 30, - "notificationTo": "", - "suggestSearchLog": "true", - "suggestDocuments": "true", - "ldapProviderUrl": "ldap://localhost:389/", - "ldapBaseDn": "dc=example,dc=com", - "ldapAdminSecurityPrincipal": "cn=admin,dc=example,dc=com", - "ldapAdminSecurityCredentials": null, - "logLevel": "", - "ssoType": "none", - "storageType": "", - "notificationLogin": "", - "notificationSearchTop": "" + "failure_count_threshold": -1, + "popular_word": "true", + "csv_file_encoding": "UTF-8", + "purge_search_log_day": 30, + "purge_job_log_day": 30, + "purge_user_info_day": 30, + "purge_suggest_search_log_day": 30, + "notification_to": "", + "suggest_search_log": "true", + "suggest_documents": "true", + "ldap_provider_url": "ldap://localhost:389/", + "ldap_base_dn": "dc=example,dc=com", + "ldap_admin_security_principal": "cn=admin,dc=example,dc=com", + "log_level": "", + "sso_type": "none", + "storage_type": "", + "notification_login": "", + "notification_search_top": "" } } } @@ -110,11 +109,11 @@ General API는 |Fess| 의 일반 설정（시스템 전반에 관한 설정） 보안상의 이유로 인증 정보를 포함하는 필드는 응답에 실제 값이 그대로 포함되지 않습니다. - - LDAP 관리자 비밀번호 ``ldapAdminSecurityCredentials`` 는 항상 ``null`` 로 - 대체됩니다. - - 그 외 시크릿（``storageAccessKey`` / ``storageSecretKey`` / - ``oicClientId`` / ``oicClientSecret`` / ``spnegoPreauthPassword`` / - ``entraidClientId`` / ``entraidClientSecret``）은 설정되어 있는 경우 + - LDAP 관리자 비밀번호 ``ldap_admin_security_credentials`` 는 항상 + 응답에 포함되지 않습니다. + - 그 외 시크릿（``storage_access_key`` / ``storage_secret_key`` / + ``oic_client_id`` / ``oic_client_secret`` / ``spnego_preauth_password`` / + ``entraid_client_id`` / ``entraid_client_secret``）은 설정되어 있는 경우 마스크 값 ``"**********"`` 으로, 설정되어 있지 않은 경우 빈 문자열（``""``） 로 반환됩니다. @@ -141,10 +140,10 @@ General API는 |Fess| 의 일반 설정（시스템 전반에 관한 설정） 다음 4개의 필드는 필수이며, **모든** PUT 요청에 반드시 포함해야 합니다（부분 업데이트의 경우에도 마찬가지입니다）. - - ``dayForCleanup`` - - ``crawlingThreadCount`` - - ``failureCountThreshold`` - - ``csvFileEncoding`` + - ``day_for_cleanup`` + - ``crawling_thread_count`` + - ``failure_count_threshold`` + - ``csv_file_encoding`` 그 중 하나라도 누락되면 유효성 검사 오류가 발생하여 API는 ``status: 1`` 과 오류 ``message`` 를 포함한 HTTP 400 을 반환합니다. 전송한 값으로 기존 설정이 @@ -170,12 +169,12 @@ General API는 |Fess| 의 일반 설정（시스템 전반에 관한 설정） .. code-block:: json { - "incrementalCrawling": "true", - "dayForCleanup": -1, - "crawlingThreadCount": 10, - "failureCountThreshold": 100, - "csvFileEncoding": "UTF-8", - "popularWord": "true" + "incremental_crawling": "true", + "day_for_cleanup": -1, + "crawling_thread_count": 10, + "failure_count_threshold": 100, + "csv_file_encoding": "UTF-8", + "popular_word": "true" } 주요 필드 @@ -192,124 +191,124 @@ General API는 |Fess| 의 일반 설정（시스템 전반에 관한 설정） * - 필드 - 필수 - 설명 - * - ``incrementalCrawling`` + * - ``incremental_crawling`` - 아니오 - 증분 크롤링 활성화/비활성화 - * - ``dayForCleanup`` + * - ``day_for_cleanup`` - 예 - 크롤링된 문서를 보존하는 일수 (-1=클린업 비활성화; 지정 범위: -1~1000) - * - ``crawlingThreadCount`` + * - ``crawling_thread_count`` - 예 - 크롤링에 사용하는 스레드 수 (지정 범위: 0~100) - * - ``failureCountThreshold`` + * - ``failure_count_threshold`` - 예 - URL 크롤링을 중지하는 실패 횟수 임계값 (-1=비활성화; 지정 범위: -1~10000) - * - ``csvFileEncoding`` + * - ``csv_file_encoding`` - 예 - CSV 내보내기 인코딩 - * - ``searchLog`` + * - ``search_log`` - 아니오 - 검색 쿼리 로그 활성화/비활성화 - * - ``userInfo`` + * - ``user_info`` - 아니오 - 사용자 정보 기록 활성화/비활성화 - * - ``userFavorite`` + * - ``user_favorite`` - 아니오 - 즐겨찾기 기능 활성화/비활성화 - * - ``webApiJson`` + * - ``web_api_json`` - 아니오 - JSON Web API 활성화/비활성화 - * - ``appValue`` + * - ``app_value`` - 아니오 - 애플리케이션 고유의 추가 설정값 - * - ``virtualHostValue`` + * - ``virtual_host_value`` - 아니오 - 가상 호스트 설정（멀티 테넌트 구성용） - * - ``popularWord`` + * - ``popular_word`` - 아니오 - 인기 워드 집계·표시 활성화/비활성화 - * - ``defaultLabelValue`` + * - ``default_label_value`` - 아니오 - 기본 라벨 값 - * - ``defaultSortValue`` + * - ``default_sort_value`` - 아니오 - 기본 정렬 순서 - * - ``appendQueryParameter`` + * - ``append_query_parameter`` - 아니오 - 검색 결과 URL에 쿼리 파라미터 부여 - * - ``loginRequired`` + * - ``login_required`` - 아니오 - 검색에 로그인을 필수로 할지 여부 - * - ``loginLink`` + * - ``login_link`` - 아니오 - 검색 화면의 로그인 링크 표시 활성화/비활성화 * - ``thumbnail`` - 아니오 - 썸네일 생성 활성화/비활성화 - * - ``resultCollapsed`` + * - ``result_collapsed`` - 아니오 - 검색 결과의 유사 문서 접기 표시 활성화/비활성화 - * - ``ignoreFailureType`` + * - ``ignore_failure_type`` - 아니오 - 무시할 크롤링 실패 타입 - * - ``crawlingUserAgent`` + * - ``crawling_user_agent`` - 아니오 - 크롤링 시 전송하는 User-Agent 문자열 - * - ``purgeSearchLogDay`` + * - ``purge_search_log_day`` - 아니오 - 검색 로그를 보존하는 일수 (-1=비활성화; 지정 범위: -1~100000) - * - ``purgeJobLogDay`` + * - ``purge_job_log_day`` - 아니오 - 잡 로그를 보존하는 일수 (-1=비활성화; 지정 범위: -1~100000) - * - ``purgeUserInfoDay`` + * - ``purge_user_info_day`` - 아니오 - 사용자 정보를 보존하는 일수 (-1=비활성화; 지정 범위: -1~100000) - * - ``purgeSuggestSearchLogDay`` + * - ``purge_suggest_search_log_day`` - 아니오 - 서제스트 검색 로그를 보존하는 일수 (0=비활성화; 지정 범위: 0~100000) - * - ``purgeByBots`` + * - ``purge_by_bots`` - 아니오 - 검색 로그를 폐기할 대상 봇 User-Agent - * - ``notificationTo`` + * - ``notification_to`` - 아니오 - 시스템 알림 발송처 이메일 주소 - * - ``notificationLogin`` + * - ``notification_login`` - 아니오 - 로그인 페이지에 표시할 알림 메시지 - * - ``notificationSearchTop`` + * - ``notification_search_top`` - 아니오 - 검색 톱 페이지에 표시할 알림 메시지 - * - ``notificationAdvanceSearch`` + * - ``notification_advance_search`` - 아니오 - 상세 검색 페이지에 표시할 알림 메시지 - * - ``suggestSearchLog`` + * - ``suggest_search_log`` - 아니오 - 검색 로그에서 서제스트 활성화/비활성화 - * - ``suggestDocuments`` + * - ``suggest_documents`` - 아니오 - 문서에서 서제스트 활성화/비활성화 - * - ``logLevel`` + * - ``log_level`` - 아니오 - 시스템 로그의 로그 레벨 - * - ``logNotificationEnabled`` + * - ``log_notification_enabled`` - 아니오 - ERROR/WARN 로그 알림 활성화/비활성화 - * - ``logNotificationLevel`` + * - ``log_notification_level`` - 아니오 - 로그 알림 레벨 - * - ``slackWebhookUrls`` + * - ``slack_webhook_urls`` - 아니오 - 알림용 Slack Webhook URL - * - ``googleChatWebhookUrls`` + * - ``google_chat_webhook_urls`` - 아니오 - 알림용 Google Chat Webhook URL - * - ``searchUseBrowserLocale`` + * - ``search_use_browser_locale`` - 아니오 - 검색 시 브라우저 로케일 사용 여부 - * - ``ragLlmName`` + * - ``rag_llm_name`` - 아니오 - RAG에서 사용하는 LLM 프로바이더 이름 - * - ``llmLogLevel`` + * - ``llm_log_level`` - 아니오 - LLM 관련 패키지의 로그 레벨 @@ -326,29 +325,29 @@ LDAP 및 SSO（OpenID Connect, SAML, SPNEGO, Entra ID）에 관한 설정도 이 * - 필드 - 설명 - * - ``ldapProviderUrl`` + * - ``ldap_provider_url`` - LDAP 연결 URL - * - ``ldapBaseDn`` + * - ``ldap_base_dn`` - LDAP 베이스 DN - * - ``ldapSecurityPrincipal`` + * - ``ldap_security_principal`` - LDAP 바인드용 시큐리티 프린시펄 - * - ``ldapAdminSecurityPrincipal`` + * - ``ldap_admin_security_principal`` - LDAP 관리 작업용 시큐리티 프린시펄 - * - ``ldapAdminSecurityCredentials`` - - LDAP 관리자 비밀번호 (응답에서 ``null`` 로 대체) - * - ``ldapAccountFilter`` / ``ldapGroupFilter`` + * - ``ldap_admin_security_credentials`` + - LDAP 관리자 비밀번호 (응답에 포함되지 않음) + * - ``ldap_account_filter`` / ``ldap_group_filter`` - 사용자/그룹 검색 필터 - * - ``ldapMemberofAttribute`` + * - ``ldap_memberof_attribute`` - 그룹 소속을 나타내는 LDAP 속성 이름 - * - ``ssoType`` + * - ``sso_type`` - SSO 타입 (``none`` / ``oic`` / ``saml`` / ``spnego`` / ``entraid``) - * - ``oicClientId`` / ``oicClientSecret`` / ``oicAuthServerUrl`` 외 + * - ``oic_client_id`` / ``oic_client_secret`` / ``oic_auth_server_url`` 외 - OpenID Connect 설정 - * - ``samlIdpEntityid`` / ``samlSpEntityid`` 외 + * - ``saml_idp_entityid`` / ``saml_sp_entityid`` 외 - SAML 설정 - * - ``spnegoKrb5Conf`` / ``spnegoLoginConf`` 외 + * - ``spnego_krb5_conf`` / ``spnego_login_conf`` 외 - SPNEGO 설정 - * - ``entraidClientId`` / ``entraidTenant`` 외 + * - ``entraid_client_id`` / ``entraid_tenant`` 외 - Microsoft Entra ID 설정 스토리지 관련 필드 @@ -362,24 +361,24 @@ LDAP 및 SSO（OpenID Connect, SAML, SPNEGO, Entra ID）에 관한 설정도 이 * - 필드 - 설명 - * - ``storageType`` + * - ``storage_type`` - 스토리지 타입 (``auto`` / ``s3`` / ``gcs``) - * - ``storageEndpoint`` + * - ``storage_endpoint`` - 스토리지 엔드포인트 URL - * - ``storageAccessKey`` / ``storageSecretKey`` + * - ``storage_access_key`` / ``storage_secret_key`` - 인증용 액세스 키/시크릿 키 - * - ``storageBucket`` + * - ``storage_bucket`` - 버킷 이름 - * - ``storageRegion`` + * - ``storage_region`` - S3 리전 - * - ``storageProjectId`` / ``storageCredentialsPath`` + * - ``storage_project_id`` / ``storage_credentials_path`` - GCS 프로젝트 ID / 인증 정보 파일 경로 .. note:: - ``ldapAdminSecurityCredentials``、``storageAccessKey`` / ``storageSecretKey``、 - ``oicClientId`` / ``oicClientSecret``、``entraidClientId`` / ``entraidClientSecret``、 - ``spnegoPreauthPassword`` 등의 시크릿 계열 필드에 마스크 값 ``"**********"`` 을 + ``ldap_admin_security_credentials``、``storage_access_key`` / ``storage_secret_key``、 + ``oic_client_id`` / ``oic_client_secret``、``entraid_client_id`` / ``entraid_client_secret``、 + ``spnego_preauth_password`` 등의 시크릿 계열 필드에 마스크 값 ``"**********"`` 을 그대로 전송한 경우, 해당 값은 업데이트되지 않으며 저장된 값이 유지됩니다. 값을 변경하는 경우에만 실제 값을 전송하십시오. @@ -412,8 +411,8 @@ LDAP 및 SSO（OpenID Connect, SAML, SPNEGO, Entra ID）에 관한 설정도 이 .. note:: - 아래 예시에서는 필수 필드（``dayForCleanup``, ``crawlingThreadCount``, - ``failureCountThreshold``, ``csvFileEncoding``）를 포함하고 있습니다. 이 필드들은 + 아래 예시에서는 필수 필드（``day_for_cleanup``, ``crawling_thread_count``, + ``failure_count_threshold``, ``csv_file_encoding``）를 포함하고 있습니다. 이 필드들은 변경 내용에 관계없이 항상 전송해야 하므로, 실제 운용 시에는 ``GET`` 으로 조회한 현재 값을 지정하십시오（아래 예시에서는 기본값을 사용합니다）. @@ -426,11 +425,11 @@ LDAP 및 SSO（OpenID Connect, SAML, SPNEGO, Entra ID）에 관한 설정도 이 -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "incrementalCrawling": "true", - "crawlingThreadCount": 10, - "failureCountThreshold": 100, - "dayForCleanup": -1, - "csvFileEncoding": "UTF-8" + "incremental_crawling": "true", + "crawling_thread_count": 10, + "failure_count_threshold": 100, + "day_for_cleanup": -1, + "csv_file_encoding": "UTF-8" }' 로그 보존 기간 업데이트 @@ -442,13 +441,13 @@ LDAP 및 SSO（OpenID Connect, SAML, SPNEGO, Entra ID）에 관한 설정도 이 -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "dayForCleanup": -1, - "crawlingThreadCount": 5, - "failureCountThreshold": -1, - "csvFileEncoding": "UTF-8", - "purgeSearchLogDay": 90, - "purgeJobLogDay": 90, - "purgeUserInfoDay": 90 + "day_for_cleanup": -1, + "crawling_thread_count": 5, + "failure_count_threshold": -1, + "csv_file_encoding": "UTF-8", + "purge_search_log_day": 90, + "purge_job_log_day": 90, + "purge_user_info_day": 90 }' 서제스트 설정 업데이트 @@ -460,12 +459,12 @@ LDAP 및 SSO（OpenID Connect, SAML, SPNEGO, Entra ID）에 관한 설정도 이 -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "dayForCleanup": -1, - "crawlingThreadCount": 5, - "failureCountThreshold": -1, - "csvFileEncoding": "UTF-8", - "suggestSearchLog": "true", - "suggestDocuments": "true" + "day_for_cleanup": -1, + "crawling_thread_count": 5, + "failure_count_threshold": -1, + "csv_file_encoding": "UTF-8", + "suggest_search_log": "true", + "suggest_documents": "true" }' 참고 정보 diff --git a/ko/15.9/api/admin/api-admin-group.rst b/ko/15.9/api/admin/api-admin-group.rst index 894d73c81..7a2f5589f 100644 --- a/ko/15.9/api/admin/api-admin-group.rst +++ b/ko/15.9/api/admin/api-admin-group.rst @@ -90,7 +90,7 @@ Group API는 |Fess| 의 그룹을 관리하기 위한 API입니다. "attributes": { "gidNumber": "1000" }, - "versionNo": 1 + "version_no": 1 }, { "id": "group_id_2", @@ -98,7 +98,7 @@ Group API는 |Fess| 의 그룹을 관리하기 위한 API입니다. "attributes": { "gidNumber": "1001" }, - "versionNo": 1 + "version_no": 1 } ], "total": 5 @@ -129,7 +129,7 @@ Group API는 |Fess| 의 그룹을 관리하기 위한 API입니다. "attributes": { "gidNumber": "1000" }, - "versionNo": 1 + "version_no": 1 } } } @@ -209,7 +209,7 @@ Group API는 |Fess| 의 그룹을 관리하기 위한 API입니다. "attributes": { "gidNumber": "1002" }, - "versionNo": 1 + "version_no": 1 } 필드 설명 @@ -231,9 +231,9 @@ Group API는 |Fess| 의 그룹을 관리하기 위한 API입니다. * - ``attributes`` - 아니오 - 속성의 맵 (``gidNumber`` 등의 LDAP 속성을 포함). 값은 문자열로 지정합니다 - * - ``versionNo`` + * - ``version_no`` - 예 - - 낙관적 잠금을 위한 버전 번호. 그룹 조회에서 얻은 ``versionNo`` 값을 지정합니다 + - 낙관적 잠금을 위한 버전 번호. 그룹 조회에서 얻은 ``version_no`` 값을 지정합니다 응답 ---------- diff --git a/ko/15.9/api/admin/api-admin-joblog.rst b/ko/15.9/api/admin/api-admin-joblog.rst index 0c06e0e20..df45f1e26 100644 --- a/ko/15.9/api/admin/api-admin-joblog.rst +++ b/ko/15.9/api/admin/api-admin-joblog.rst @@ -80,25 +80,25 @@ JobLog API는 |Fess| 의 작업 실행 로그를 참조 및 관리하기 위한 "logs": [ { "id": "joblog_id_1", - "jobName": "Default Crawler", - "jobStatus": "ok", + "job_name": "Default Crawler", + "job_status": "ok", "target": "all", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "scriptResult": "Job completed successfully", - "startTime": "1738116000000", - "endTime": "1738118723000" + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "script_result": "Job completed successfully", + "start_time": "1738116000000", + "end_time": "1738118723000" }, { "id": "joblog_id_2", - "jobName": "Default Crawler", - "jobStatus": "fail", + "job_name": "Default Crawler", + "job_status": "fail", "target": "all", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "scriptResult": "Error: Connection timeout", - "startTime": "1738029600000", - "endTime": "1738030215000" + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "script_result": "Error: Connection timeout", + "start_time": "1738029600000", + "end_time": "1738030215000" } ], "total": 100 @@ -116,26 +116,26 @@ JobLog API는 |Fess| 의 작업 실행 로그를 참조 및 관리하기 위한 - 설명 * - ``id`` - 작업 로그 ID - * - ``jobName`` + * - ``job_name`` - 작업 이름 - * - ``jobStatus`` + * - ``job_status`` - 작업 상태 (``ok``: 성공, ``fail``: 실패, ``running``: 실행 중) * - ``target`` - 실행 대상 (스케줄러의 타겟 이름. 기본값은 ``all``) - * - ``scriptType`` + * - ``script_type`` - 스크립트 타입 (예: ``javascript``) - * - ``scriptData`` + * - ``script_data`` - 실행 스크립트 - * - ``scriptResult`` + * - ``script_result`` - 실행 결과 - * - ``startTime`` + * - ``start_time`` - 시작 시각 (에포크 밀리초. 문자열로 반환됨) - * - ``endTime`` + * - ``end_time`` - 종료 시각 (에포크 밀리초. 문자열로 반환됨). 실행 중인 작업에서는 반환되지 않습니다. .. note:: - 응답의 각 로그 오브젝트에는 내부적으로 사용되는 ``crudMode`` 필드 + 응답의 각 로그 오브젝트에는 내부적으로 사용되는 ``crud_mode`` 필드 (CRUD 작업 모드를 나타내는 정수값으로, 읽기 작업 시 항상 ``0``)가 포함됩니다. 클라이언트 측에서는 무시해도 됩니다. @@ -159,14 +159,14 @@ JobLog API는 |Fess| 의 작업 실행 로그를 참조 및 관리하기 위한 "status": 0, "log": { "id": "joblog_id_1", - "jobName": "Default Crawler", - "jobStatus": "ok", + "job_name": "Default Crawler", + "job_status": "ok", "target": "all", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "scriptResult": "Crawl completed successfully.\nDocuments indexed: 1234\nDocuments updated: 567\nDocuments deleted: 12\nErrors: 0", - "startTime": "1738116000000", - "endTime": "1738118723000" + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "script_result": "Crawl completed successfully.\nDocuments indexed: 1234\nDocuments updated: 567\nDocuments deleted: 12\nErrors: 0", + "start_time": "1738116000000", + "end_time": "1738118723000" } } } diff --git a/ko/15.9/api/admin/api-admin-keymatch.rst b/ko/15.9/api/admin/api-admin-keymatch.rst index 2734d405d..a1b2e5c41 100644 --- a/ko/15.9/api/admin/api-admin-keymatch.rst +++ b/ko/15.9/api/admin/api-admin-keymatch.rst @@ -92,9 +92,9 @@ KeyMatch API는 |Fess| 의 키 매치(검색 키워드와 결과의 연결)를 "id": "keymatch_id_1", "term": "download", "query": "title:download OR content:download", - "maxSize": 10, + "max_size": 10, "boost": 10.0, - "versionNo": 1 + "version_no": 1 } ], "total": 5 @@ -104,8 +104,8 @@ KeyMatch API는 |Fess| 의 키 매치(검색 키워드와 결과의 연결)를 .. note:: ``total`` 에는 필터링 조건에 일치하는 총 건수가 설정됩니다 (현재 페이지의 건수가 아닙니다). - 각 설정 객체에는 위의 필드 외에도, 값이 설정되어 있는 경우 ``virtualHost`` 、 - ``createdBy`` 、 ``createdTime`` 、 ``updatedBy`` 、 ``updatedTime`` 이 포함됩니다. + 각 설정 객체에는 위의 필드 외에도, 값이 설정되어 있는 경우 ``virtual_host`` 、 + ``created_by`` 、 ``created_time`` 、 ``updated_by`` 、 ``updated_time`` 이 포함됩니다. 키 매치 조회 ============== @@ -129,21 +129,21 @@ KeyMatch API는 |Fess| 의 키 매치(검색 키워드와 결과의 연결)를 "id": "keymatch_id_1", "term": "download", "query": "title:download OR content:download", - "maxSize": 10, + "max_size": 10, "boost": 10.0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } .. note:: - ``versionNo`` 는 낙관적 잠금(Optimistic Lock)을 위한 버전 번호입니다. 키 매치를 업데이트할 때는 - 조회 시 얻은 ``versionNo`` 를 요청 본문에 지정해 주세요. 지정한 ID가 존재하지 않는 경우 오류가 반환됩니다. + ``version_no`` 는 낙관적 잠금(Optimistic Lock)을 위한 버전 번호입니다. 키 매치를 업데이트할 때는 + 조회 시 얻은 ``version_no`` 를 요청 본문에 지정해 주세요. 지정한 ID가 존재하지 않는 경우 오류가 반환됩니다. 키 매치 만들기 ============== @@ -164,7 +164,7 @@ KeyMatch API는 |Fess| 의 키 매치(검색 키워드와 결과의 연결)를 { "term": "pricing", "query": "url:*/pricing* OR title:pricing", - "maxSize": 5, + "max_size": 5, "boost": 20.0 } @@ -187,7 +187,7 @@ KeyMatch API는 |Fess| 의 키 매치(검색 키워드와 결과의 연결)를 - String - 예 - 매치 조건 쿼리 (최대 길이는 ``form.admin.max.input.size`` 의 설정값에 따름) - * - ``maxSize`` + * - ``max_size`` - Integer - 예 - 최대 표시 건수 (0 이상의 정수. 관리 화면 초기값: 10) @@ -195,16 +195,16 @@ KeyMatch API는 |Fess| 의 키 매치(검색 키워드와 결과의 연결)를 - Float - 예 - 부스트 값 (관리 화면 초기값: 100.0) - * - ``virtualHost`` + * - ``virtual_host`` - String - 아니오 - 가상 호스트명 (최대 1000자. 가상 호스트별로 키 매치를 전환할 경우 지정) .. note:: - ``maxSize`` 와 ``boost`` 는 API를 통해서는 필수 항목입니다. 초기값은 관리 화면 폼에 표시되는 값이며, + ``max_size`` 와 ``boost`` 는 API를 통해서는 필수 항목입니다. 초기값은 관리 화면 폼에 표시되는 값이며, API에서는 적용되지 않습니다. 생략한 경우 유효성 검사 오류가 발생합니다. - 또한, ``createdBy`` 와 ``createdTime`` 은 요청에서 지정하더라도 서버 측에서 덮어씁니다. + 또한, ``created_by`` 와 ``created_time`` 은 요청에서 지정하더라도 서버 측에서 덮어씁니다. 응답 ---------- @@ -239,15 +239,15 @@ KeyMatch API는 |Fess| 의 키 매치(검색 키워드와 결과의 연결)를 "id": "existing_keymatch_id", "term": "pricing", "query": "url:*/pricing* OR title:pricing OR content:price", - "maxSize": 10, + "max_size": 10, "boost": 15.0, - "versionNo": 1 + "version_no": 1 } 필드 설명 ~~~~~~~~~~~~~~ -만들기 시의 필드 ( ``term`` 、 ``query`` 、 ``maxSize`` 、 ``boost`` 、 ``virtualHost`` ) 에 더해, +만들기 시의 필드 ( ``term`` 、 ``query`` 、 ``max_size`` 、 ``boost`` 、 ``virtual_host`` ) 에 더해, 아래 필드를 지정합니다. .. list-table:: @@ -262,7 +262,7 @@ KeyMatch API는 |Fess| 의 키 매치(검색 키워드와 결과의 연결)를 - String - 예 - 업데이트 대상 키 매치 ID (최대 1000자) - * - ``versionNo`` + * - ``version_no`` - Integer - 예 - 낙관적 잠금을 위한 버전 번호. 조회 시 얻은 값을 지정 @@ -315,7 +315,7 @@ KeyMatch API는 |Fess| 의 키 매치(검색 키워드와 결과의 연결)를 -d '{ "term": "product features", "query": "url:*/products/* AND (title:features OR content:features)", - "maxSize": 10, + "max_size": 10, "boost": 15.0 }' @@ -330,7 +330,7 @@ KeyMatch API는 |Fess| 의 키 매치(검색 키워드와 결과의 연결)를 -d '{ "term": "help", "query": "url:*/support/* OR url:*/help/* OR url:*/faq/*", - "maxSize": 5, + "max_size": 5, "boost": 20.0 }' diff --git a/ko/15.9/api/admin/api-admin-labeltype.rst b/ko/15.9/api/admin/api-admin-labeltype.rst index 39f5e1461..d8a92aa70 100644 --- a/ko/15.9/api/admin/api-admin-labeltype.rst +++ b/ko/15.9/api/admin/api-admin-labeltype.rst @@ -99,16 +99,16 @@ HTTP 상태 코드 등)에 대해서는 :doc:`api-admin-overview` 를 참조하 "id": "label_id_1", "name": "Documentation", "value": "docs", - "includedPaths": ".*docs\\.example\\.com.*", - "excludedPaths": "", + "included_paths": ".*docs\\.example\\.com.*", + "excluded_paths": "", "permissions": "{role}admin", - "virtualHost": "", - "sortOrder": 0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_host": "", + "sort_order": 0, + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } ], "total": 5 @@ -117,8 +117,8 @@ HTTP 상태 코드 등)에 대해서는 :doc:`api-admin-overview` 를 참조하 .. note:: - 각 설정 객체에는 감사용 ``createdBy`` / ``createdTime`` / ``updatedBy`` / - ``updatedTime`` 과 낙관적 잠금용 ``versionNo`` 도 포함됩니다(값이 ``null`` 인 + 각 설정 객체에는 감사용 ``created_by`` / ``created_time`` / ``updated_by`` / + ``updated_time`` 과 낙관적 잠금용 ``version_no`` 도 포함됩니다(값이 ``null`` 인 필드는 생략됩니다). ``response`` 객체에는 제품 버전을 나타내는 ``version`` 이 항상 포함되지만, 이후 예시에서는 간결함을 위해 생략하는 경우가 있습니다. @@ -144,16 +144,16 @@ HTTP 상태 코드 등)에 대해서는 :doc:`api-admin-overview` 를 참조하 "id": "label_id_1", "name": "Documentation", "value": "docs", - "includedPaths": ".*docs\\.example\\.com.*", - "excludedPaths": "", + "included_paths": ".*docs\\.example\\.com.*", + "excluded_paths": "", "permissions": "{role}admin", - "virtualHost": "", - "sortOrder": 0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_host": "", + "sort_order": 0, + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } @@ -177,9 +177,9 @@ HTTP 상태 코드 등)에 대해서는 :doc:`api-admin-overview` 를 참조하 { "name": "News", "value": "news", - "includedPaths": ".*news\\.example\\.com.*\n.*example\\.com/news/.*", - "excludedPaths": ".*/(archive|old)/.*", - "sortOrder": 1, + "included_paths": ".*news\\.example\\.com.*\n.*example\\.com/news/.*", + "excluded_paths": ".*/(archive|old)/.*", + "sort_order": 1, "permissions": "{role}guest" } @@ -202,11 +202,11 @@ HTTP 상태 코드 등)에 대해서는 :doc:`api-admin-overview` 를 참조하 - String - 예 - 라벨 값(검색 시 ``label`` 파라미터로 사용). 영숫자와 언더스코어(``_``)만 사용 가능하며, 정규 표현식 ``^[a-zA-Z0-9_]+$`` 에 일치해야 합니다(최대 100자). - * - ``includedPaths`` + * - ``included_paths`` - String - 아니요 - 라벨 대상 경로의 정규 표현식. 여러 개 지정 시 줄바꿈(``\n``)으로 구분합니다. - * - ``excludedPaths`` + * - ``excluded_paths`` - String - 아니요 - 라벨 대상에서 제외할 경로의 정규 표현식. 여러 개 지정 시 줄바꿈(``\n``)으로 구분합니다. @@ -214,18 +214,18 @@ HTTP 상태 코드 등)에 대해서는 :doc:`api-admin-overview` 를 참조하 - String - 아니요 - 접근을 허용할 역할/그룹/사용자(예: ``{role}admin``). 여러 개 지정 시 줄바꿈(``\n``)으로 구분합니다. - * - ``sortOrder`` + * - ``sort_order`` - Integer - 아니요 - 표시 순서(0 이상의 정수). 지정하지 않으면 ``0`` 입니다. - * - ``virtualHost`` + * - ``virtual_host`` - String - 아니요 - 가상 호스트(최대 1000자). .. note:: - ``createdBy`` / ``createdTime`` 등의 감사 필드는 서버 측에서 자동으로 설정되므로 + ``created_by`` / ``created_time`` 등의 감사 필드는 서버 측에서 자동으로 설정되므로 요청에서 지정할 필요가 없습니다. 응답 @@ -263,11 +263,11 @@ HTTP 상태 코드 등)에 대해서는 :doc:`api-admin-overview` 를 참조하 "id": "existing_label_id", "name": "News Articles", "value": "news", - "includedPaths": ".*news\\.example\\.com.*\n.*example\\.com/(news|articles)/.*", - "excludedPaths": ".*/(archive|old|draft)/.*", - "sortOrder": 1, + "included_paths": ".*news\\.example\\.com.*\n.*example\\.com/(news|articles)/.*", + "excluded_paths": ".*/(archive|old|draft)/.*", + "sort_order": 1, "permissions": "{role}guest", - "versionNo": 1 + "version_no": 1 } 업데이트 시에는 생성 시의 필드에 더해 다음 필드가 필수입니다. @@ -284,10 +284,10 @@ HTTP 상태 코드 등)에 대해서는 :doc:`api-admin-overview` 를 참조하 - String - 예 - 업데이트 대상 라벨 타입 ID. - * - ``versionNo`` + * - ``version_no`` - Integer - 예 - - 낙관적 잠금용 버전 번호. 조회 시 응답에 포함된 ``versionNo`` 를 지정합니다. 지정한 버전이 현재 버전과 일치하지 않으면 업데이트가 실패합니다. + - 낙관적 잠금용 버전 번호. 조회 시 응답에 포함된 ``version_no`` 를 지정합니다. 지정한 버전이 현재 버전과 일치하지 않으면 업데이트가 실패합니다. 응답 ---------- @@ -339,8 +339,8 @@ HTTP 상태 코드 등)에 대해서는 :doc:`api-admin-overview` 를 참조하 -d '{ "name": "Technical Documentation", "value": "tech_docs", - "includedPaths": ".*docs\\.example\\.com.*\n.*example\\.com/documentation/.*", - "sortOrder": 0, + "included_paths": ".*docs\\.example\\.com.*\n.*example\\.com/documentation/.*", + "sort_order": 0, "permissions": "{role}guest" }' diff --git a/ko/15.9/api/admin/api-admin-overview.rst b/ko/15.9/api/admin/api-admin-overview.rst index 32c316a19..7e8013d06 100644 --- a/ko/15.9/api/admin/api-admin-overview.rst +++ b/ko/15.9/api/admin/api-admin-overview.rst @@ -515,22 +515,22 @@ Web 크롤링 설정 만들기 -d '{ "name": "Example Site", "urls": "https://example.com/", - "includedUrls": ".*example.com.*", - "excludedUrls": "", - "userAgent": "Mozilla/5.0 (compatible; Fess)", - "numOfThread": 1, - "intervalTime": 1000, + "included_urls": ".*example.com.*", + "excluded_urls": "", + "user_agent": "Mozilla/5.0 (compatible; Fess)", + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, - "maxAccessCount": 1000, + "max_access_count": 1000, "depth": 3, - "sortOrder": 1, + "sort_order": 1, "available": "true" }' .. note:: - Web 크롤링 설정 만들기에서는 ``name``, ``urls``, ``userAgent``, ``numOfThread``, - ``intervalTime``, ``boost``, ``available``, ``sortOrder`` 가 필수입니다. 이들을 + Web 크롤링 설정 만들기에서는 ``name``, ``urls``, ``user_agent``, ``num_of_thread``, + ``interval_time``, ``boost``, ``available``, ``sort_order`` 가 필수입니다. 이들을 생략하면 검증 오류(``status: 1``)가 됩니다. ``available`` 은 문자열로 지정하며, ``"true"`` 또는 ``"false"`` 를 설정합니다. diff --git a/ko/15.9/api/admin/api-admin-relatedcontent.rst b/ko/15.9/api/admin/api-admin-relatedcontent.rst index 04f8a04bc..e181e05a1 100644 --- a/ko/15.9/api/admin/api-admin-relatedcontent.rst +++ b/ko/15.9/api/admin/api-admin-relatedcontent.rst @@ -93,13 +93,13 @@ RelatedContent API는 |Fess| 의 관련 콘텐츠를 관리하기 위한 API입 "id": "content_id_1", "term": "fess", "content": "
Fess is an open source search server.
", - "virtualHost": "", - "sortOrder": 0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_host": "", + "sort_order": 0, + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } ], "total": 5 @@ -109,10 +109,10 @@ RelatedContent API는 |Fess| 의 관련 콘텐츠를 관리하기 위한 API입 .. note:: ``settings`` 의 각 요소 및 단일 조회 엔드포인트가 반환하는 ``setting`` 객체에는 - 저장된 엔티티의 필드가 그대로 포함됩니다. ``term``, ``content``, ``sortOrder``, - ``virtualHost`` 외에도 감사 필드인 ``createdBy``, ``createdTime``, ``updatedBy``, - ``updatedTime`` 과 낙관적 잠금 필드인 ``versionNo`` 도 반환됩니다. ``createdTime`` - 및 ``updatedTime`` 은 에포크 기준 밀리초(숫자)로 표현됩니다. 값이 설정되지 않은 + 저장된 엔티티의 필드가 그대로 포함됩니다. ``term``, ``content``, ``sort_order``, + ``virtual_host`` 외에도 감사 필드인 ``created_by``, ``created_time``, ``updated_by``, + ``updated_time`` 과 낙관적 잠금 필드인 ``version_no`` 도 반환됩니다. ``created_time`` + 및 ``updated_time`` 은 에포크 기준 밀리초(숫자)로 표현됩니다. 값이 설정되지 않은 (null) 필드는 응답에서 생략됩니다. 또한 모든 응답의 ``response`` 객체에는 제품 버전을 나타내는 ``version`` 이 항상 포함됩니다 (자세한 내용은 :doc:`api-admin-overview` 를 참조하십시오). @@ -140,20 +140,20 @@ RelatedContent API는 |Fess| 의 관련 콘텐츠를 관리하기 위한 API입 "id": "content_id_1", "term": "fess", "content": "
Fess is an open source search server.
", - "virtualHost": "", - "sortOrder": 0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_host": "", + "sort_order": 0, + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } .. note:: - 업데이트(PUT) 시 필요한 ``versionNo`` 는 이 조회 응답에 포함된 값을 지정합니다. + 업데이트(PUT) 시 필요한 ``version_no`` 는 이 조회 응답에 포함된 값을 지정합니다. 관련 콘텐츠 만들기 ================== @@ -174,8 +174,8 @@ RelatedContent API는 |Fess| 의 관련 콘텐츠를 관리하기 위한 API입 { "term": "search", "content": "

About Search

Learn more about search features...

", - "sortOrder": 0, - "virtualHost": "" + "sort_order": 0, + "virtual_host": "" } 필드 설명 @@ -194,10 +194,10 @@ RelatedContent API는 |Fess| 의 관련 콘텐츠를 관리하기 위한 API입 * - ``content`` - **예** - 표시할 HTML 콘텐츠 (최대 10000자) - * - ``sortOrder`` + * - ``sort_order`` - **아니오** - 표시 순서 (0 이상 2147483647 이하의 정수) - * - ``virtualHost`` + * - ``virtual_host`` - **아니오** - 가상 호스트 (최대 1000자) @@ -235,9 +235,9 @@ RelatedContent API는 |Fess| 의 관련 콘텐츠를 관리하기 위한 API입 "id": "existing_content_id", "term": "search", "content": "

About Search

Updated information...

", - "sortOrder": 0, - "virtualHost": "", - "versionNo": 1 + "sort_order": 0, + "virtual_host": "", + "version_no": 1 } 필드 설명 @@ -259,13 +259,13 @@ RelatedContent API는 |Fess| 의 관련 콘텐츠를 관리하기 위한 API입 * - ``content`` - **예** - 표시할 HTML 콘텐츠 (최대 10000자) - * - ``sortOrder`` + * - ``sort_order`` - **아니오** - 표시 순서 (0 이상 2147483647 이하의 정수) - * - ``virtualHost`` + * - ``virtual_host`` - **아니오** - 가상 호스트 (최대 1000자) - * - ``versionNo`` + * - ``version_no`` - **예** - 낙관적 잠금용 버전 번호. ``setting/{id}`` 의 조회 응답에 포함된 값을 지정합니다. @@ -285,8 +285,8 @@ RelatedContent API는 |Fess| 의 관련 콘텐츠를 관리하기 위한 API입 .. note:: - ``createdBy``, ``createdTime``, ``updatedBy``, ``updatedTime`` 등의 감사 필드나 - ``crudMode`` 를 요청 본문에 포함해도 서버 측에서 자동으로 설정되므로 무시됩니다. + ``created_by``, ``created_time``, ``updated_by``, ``updated_time`` 등의 감사 필드나 + ``crud_mode`` 를 요청 본문에 포함해도 서버 측에서 자동으로 설정되므로 무시됩니다. 만들기 또는 업데이트 시 지정할 필요는 없습니다. 관련 콘텐츠 삭제 @@ -325,7 +325,7 @@ RelatedContent API는 |Fess| 의 관련 콘텐츠를 관리하기 위한 API입 -d '{ "term": "product", "content": "

Our Products

", - "sortOrder": 0 + "sort_order": 0 }' 지원 정보 관련 콘텐츠 @@ -339,7 +339,7 @@ RelatedContent API는 |Fess| 의 관련 콘텐츠를 관리하기 위한 API입 -d '{ "term": "support", "content": "

Need help? Contact: support@example.com

", - "sortOrder": 0 + "sort_order": 0 }' 참고 정보 diff --git a/ko/15.9/api/admin/api-admin-relatedquery.rst b/ko/15.9/api/admin/api-admin-relatedquery.rst index a7b50f100..18df1184e 100644 --- a/ko/15.9/api/admin/api-admin-relatedquery.rst +++ b/ko/15.9/api/admin/api-admin-relatedquery.rst @@ -90,7 +90,7 @@ RelatedQuery API는 |Fess| 의 관련 쿼리를 관리하기 위한 API입니다 "id": "query_id_1", "term": "fess", "queries": "fess tutorial\nfess installation\nfess configuration", - "versionNo": 1 + "version_no": 1 } ], "total": 5 @@ -99,9 +99,9 @@ RelatedQuery API는 |Fess| 의 관련 쿼리를 관리하기 위한 API입니다 .. note:: - 각 설정에는 ``versionNo`` (낙관적 잠금용 버전 번호)가 포함됩니다. ``virtualHost`` - 및 감사용 필드(``createdBy``, ``createdTime``, ``updatedBy``, ``updatedTime``)는 - 값이 설정된 경우에만 포함됩니다. 값이 비어 있는 ``virtualHost`` 는 응답에 포함되지 않습니다. + 각 설정에는 ``version_no`` (낙관적 잠금용 버전 번호)가 포함됩니다. ``virtual_host`` + 및 감사용 필드(``created_by``, ``created_time``, ``updated_by``, ``updated_time``)는 + 값이 설정된 경우에만 포함됩니다. 값이 비어 있는 ``virtual_host`` 는 응답에 포함되지 않습니다. 관련 쿼리 조회 ============== @@ -126,8 +126,8 @@ RelatedQuery API는 |Fess| 의 관련 쿼리를 관리하기 위한 API입니다 "id": "query_id_1", "term": "fess", "queries": "fess tutorial\nfess installation\nfess configuration", - "virtualHost": "site1.example.com", - "versionNo": 1 + "virtual_host": "site1.example.com", + "version_no": 1 } } } @@ -151,7 +151,7 @@ RelatedQuery API는 |Fess| 의 관련 쿼리를 관리하기 위한 API입니다 { "term": "search", "queries": "search tutorial\nsearch syntax\nadvanced search", - "virtualHost": "" + "virtual_host": "" } 필드 설명 @@ -170,13 +170,13 @@ RelatedQuery API는 |Fess| 의 관련 쿼리를 관리하기 위한 API입니다 * - ``queries`` - 예 - 관련 쿼리. 한 줄에 한 건씩 작성한 줄바꿈 구분 문자열입니다 (빈 줄은 무시됩니다. 최대 10000자) - * - ``virtualHost`` + * - ``virtual_host`` - 아니오 - 가상 호스트 (최대 1000자) .. note:: - ``crudMode`` 는 API 측에서 자동으로 설정되므로 요청 본문에 포함할 필요가 없습니다. + ``crud_mode`` 는 API 측에서 자동으로 설정되므로 요청 본문에 포함할 필요가 없습니다. 응답 ---- @@ -212,8 +212,8 @@ RelatedQuery API는 |Fess| 의 관련 쿼리를 관리하기 위한 API입니다 "id": "existing_query_id", "term": "search", "queries": "search tutorial\nsearch syntax\nadvanced search\nsearch tips", - "virtualHost": "", - "versionNo": 1 + "virtual_host": "", + "version_no": 1 } 필드 설명 @@ -235,10 +235,10 @@ RelatedQuery API는 |Fess| 의 관련 쿼리를 관리하기 위한 API입니다 * - ``queries`` - 예 - 관련 쿼리. 한 줄에 한 건씩 작성한 줄바꿈 구분 문자열입니다 (빈 줄은 무시됩니다. 최대 10000자) - * - ``virtualHost`` + * - ``virtual_host`` - 아니오 - 가상 호스트 (최대 1000자) - * - ``versionNo`` + * - ``version_no`` - 예 - 낙관적 잠금용 버전 번호. 조회 시 응답에 포함된 값을 지정합니다 diff --git a/ko/15.9/api/admin/api-admin-role.rst b/ko/15.9/api/admin/api-admin-role.rst index ace3a076a..ce0f5a443 100644 --- a/ko/15.9/api/admin/api-admin-role.rst +++ b/ko/15.9/api/admin/api-admin-role.rst @@ -87,12 +87,12 @@ Role API는 |Fess| 의 역할을 관리하기 위한 API입니다. { "id": "role_id_1", "name": "admin", - "versionNo": 1 + "version_no": 1 }, { "id": "role_id_2", "name": "user", - "versionNo": 1 + "version_no": 1 } ], "total": 5 @@ -120,7 +120,7 @@ Role API는 |Fess| 의 역할을 관리하기 위한 API입니다. "setting": { "id": "role_id_1", "name": "admin", - "versionNo": 1 + "version_no": 1 } } } @@ -194,7 +194,7 @@ Role API는 |Fess| 의 역할을 관리하기 위한 API입니다. { "id": "existing_role_id", "name": "editor_updated", - "versionNo": 1 + "version_no": 1 } 필드 설명 @@ -216,9 +216,9 @@ Role API는 |Fess| 의 역할을 관리하기 위한 API입니다. * - ``attributes`` - 아니오 - 속성의 맵. 값은 문자열로 지정합니다 - * - ``versionNo`` + * - ``version_no`` - 예 - - 낙관적 잠금을 위한 버전 번호. 역할 조회에서 얻은 ``versionNo`` 값을 지정합니다 + - 낙관적 잠금을 위한 버전 번호. 역할 조회에서 얻은 ``version_no`` 값을 지정합니다 응답 ---------- diff --git a/ko/15.9/api/admin/api-admin-scheduler.rst b/ko/15.9/api/admin/api-admin-scheduler.rst index c8bfb8f82..f5ef4ba35 100644 --- a/ko/15.9/api/admin/api-admin-scheduler.rst +++ b/ko/15.9/api/admin/api-admin-scheduler.rst @@ -91,14 +91,14 @@ Scheduler API는 |Fess| 의 스케줄 작업을 관리하기 위한 API입니다 "id": "job_id_1", "name": "Default Crawler", "target": "all", - "cronExpression": "0 0 0 * * ?", - "scriptType": "javascript", - "scriptData": "...", - "jobLogging": "true", + "cron_expression": "0 0 0 * * ?", + "script_type": "javascript", + "script_data": "...", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 0, - "versionNo": 1, + "sort_order": 0, + "version_no": 1, "running": false } ], @@ -112,7 +112,7 @@ Scheduler API는 |Fess| 의 스케줄 작업을 관리하기 위한 API입니다 .. note:: - 응답의 ``jobLogging`` / ``crawler`` / ``available`` 은 문자열（``"true"`` / ``"false"``）로 반환됩니다. ``running`` 은 불리언 값으로, 작업이 현재 실행 중인지 여부를 나타내는 응답 전용 필드입니다（요청에서는 지정할 수 없습니다）。\ ``total`` 은 조건에 일치하는 전체 작업 수입니다. + 응답의 ``job_logging`` / ``crawler`` / ``available`` 은 문자열（``"true"`` / ``"false"``）로 반환됩니다. ``running`` 은 불리언 값으로, 작업이 현재 실행 중인지 여부를 나타내는 응답 전용 필드입니다（요청에서는 지정할 수 없습니다）。\ ``total`` 은 조건에 일치하는 전체 작업 수입니다. 스케줄 작업 조회 ====================== @@ -136,14 +136,14 @@ Scheduler API는 |Fess| 의 스케줄 작업을 관리하기 위한 API입니다 "id": "job_id_1", "name": "Default Crawler", "target": "all", - "cronExpression": "0 0 0 * * ?", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "jobLogging": "true", + "cron_expression": "0 0 0 * * ?", + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 0, - "versionNo": 1, + "sort_order": 0, + "version_no": 1, "running": false } } @@ -168,13 +168,13 @@ Scheduler API는 |Fess| 의 스케줄 작업을 관리하기 위한 API입니다 { "name": "Daily Crawler", "target": "all", - "cronExpression": "0 0 2 * * ?", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "jobLogging": "true", + "cron_expression": "0 0 2 * * ?", + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 1 + "sort_order": 1 } 필드 설명 @@ -193,16 +193,16 @@ Scheduler API는 |Fess| 의 스케줄 작업을 관리하기 위한 API입니다 * - ``target`` - 예 - 실행 대상（최대 100자）。\ ``all`` 또는 특정 대상 이름을 지정합니다 - * - ``cronExpression`` + * - ``cron_expression`` - 아니오 - Cron 표현식（초 분 시 일 월 요일）。최대 100자이며 Cron 표현식으로 검증됩니다. 비어 있으면 스케줄 실행되지 않고 수동으로만 시작할 수 있습니다 - * - ``scriptType`` + * - ``script_type`` - 예 - 스크립트 타입（최대 100자）。``javascript``（신규 작업의 기본값. ``job.default.script`` 속성으로 결정）또는 ``groovy``（``fess-script-groovy`` 플러그인 필요）를 지정합니다 - * - ``scriptData`` + * - ``script_data`` - 아니오 - 실행 스크립트。최대 크기는 ``fess_config.properties`` 의 ``form.admin.max.input.size`` 에 따릅니다 - * - ``jobLogging`` + * - ``job_logging`` - 아니오 - 작업 로그 기록 활성화（문자열） * - ``crawler`` @@ -211,17 +211,17 @@ Scheduler API는 |Fess| 의 스케줄 작업을 관리하기 위한 API입니다 * - ``available`` - 아니오 - 활성화/비활성화（문자열） - * - ``sortOrder`` + * - ``sort_order`` - 예 - 표시 순서（0〜2147483647의 정수） .. note:: - ``jobLogging`` / ``crawler`` / ``available`` 은 문자열 필드입니다. 요청에서 ``"on"`` 또는 ``"true"``\ （대소문자 구분 없음）를 지정하면 활성화되며, 그 외의 값（``"false"``, 빈 문자열, 미지정 등）은 비활성화로 처리됩니다. 응답에서는 ``"true"`` / ``"false"`` 로 반환됩니다. + ``job_logging`` / ``crawler`` / ``available`` 은 문자열 필드입니다. 요청에서 ``"on"`` 또는 ``"true"``\ （대소문자 구분 없음）를 지정하면 활성화되며, 그 외의 값（``"false"``, 빈 문자열, 미지정 등）은 비활성화로 처리됩니다. 응답에서는 ``"true"`` / ``"false"`` 로 반환됩니다. .. note:: - ``crudMode`` 는 서버 측에서 자동으로 설정되므로 요청에서 지정할 필요가 없습니다. ``createdBy`` / ``createdTime`` 등의 감사 필드도 서버 측에서 설정됩니다. + ``crud_mode`` 는 서버 측에서 자동으로 설정되므로 요청에서 지정할 필요가 없습니다. ``created_by`` / ``created_time`` 등의 감사 필드도 서버 측에서 설정됩니다. 응답 ---------- @@ -274,19 +274,19 @@ Cron 표현식 예시 "id": "existing_job_id", "name": "Updated Crawler", "target": "all", - "cronExpression": "0 0 3 * * ?", - "scriptType": "javascript", - "scriptData": "...", - "jobLogging": "true", + "cron_expression": "0 0 3 * * ?", + "script_type": "javascript", + "script_data": "...", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 1, - "versionNo": 1 + "sort_order": 1, + "version_no": 1 } .. note:: - 업데이트 시 ``id``\ （최대 1000자）와 ``versionNo`` 는 필수입니다. ``versionNo`` 는 낙관적 잠금에 사용되며, 조회 시 응답에 포함된 값을 지정합니다. 값이 일치하지 않으면 업데이트가 실패합니다. 그 밖의 필수 필드（``name`` / ``target`` / ``scriptType`` / ``sortOrder``）는 작성 시와 동일합니다. + 업데이트 시 ``id``\ （최대 1000자）와 ``version_no`` 는 필수입니다. ``version_no`` 는 낙관적 잠금에 사용되며, 조회 시 응답에 포함된 값을 지정합니다. 값이 일치하지 않으면 업데이트가 실패합니다. 그 밖의 필수 필드（``name`` / ``target`` / ``script_type`` / ``sort_order``）는 작성 시와 동일합니다. 응답 ---------- @@ -344,7 +344,7 @@ Cron 표현식 예시 { "response": { "status": 0, - "jobLogId": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6" + "job_log_id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6" } } @@ -357,15 +357,15 @@ Cron 표현식 예시 * - 필드 - 설명 - * - ``jobLogId`` - - 시작된 작업의 작업 로그 ID. 작업 로그가 활성화된 경우에 발행됩니다. 작업 로그가 비활성화된 경우에는 ``null`` 이 됩니다. + * - ``job_log_id`` + - 시작된 작업의 작업 로그 ID. 작업 로그가 활성화된 경우에 발행됩니다. 작업 로그가 비활성화된 경우에는 응답에 포함되지 않습니다. 주의 사항 -------- - 작업이 이미 실행 중인 경우 시작에 실패하고 오류（``status`` 가 ``0`` 이 아닌 값）가 반환됩니다 - 작업이 비활성화（``available`` 이 활성화되지 않은）된 경우에도 마찬가지로 시작에 실패하고 오류가 반환됩니다 -- ``jobLogId`` 는 작업 로그가 활성화（``jobLogging`` 이 활성화）된 경우에만 발행됩니다 +- ``job_log_id`` 는 작업 로그가 활성화（``job_logging`` 이 활성화）된 경우에만 발행됩니다 작업 중지 ========== @@ -405,13 +405,13 @@ Cron 표현식 예시 -d '{ "name": "Hourly Crawler", "target": "all", - "cronExpression": "0 0 * * * ?", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "jobLogging": "true", + "cron_expression": "0 0 * * * ?", + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 1 + "sort_order": 1 }' # 작업을 즉시 실행 diff --git a/ko/15.9/api/admin/api-admin-suggest.rst b/ko/15.9/api/admin/api-admin-suggest.rst index 185e92a53..7eaea519b 100644 --- a/ko/15.9/api/admin/api-admin-suggest.rst +++ b/ko/15.9/api/admin/api-admin-suggest.rst @@ -77,9 +77,9 @@ Suggest API는 |Fess| 의 서제스트 기능에서 사용되는 서제스트 "version": "15.9.0", "status": 0, "setting": { - "totalWordsNum": 1500, - "documentWordsNum": 1200, - "queryWordsNum": 450 + "total_words_num": 1500, + "document_words_num": 1200, + "query_words_num": 450 } } } @@ -93,18 +93,18 @@ Suggest API는 |Fess| 의 서제스트 기능에서 사용되는 서제스트 * - 필드 - 설명 - * - ``setting.totalWordsNum`` + * - ``setting.total_words_num`` - 서제스트 워드의 총수(서제스트 인덱스에 등록된 서제스트 워드의 건수) - * - ``setting.documentWordsNum`` + * - ``setting.document_words_num`` - 문서에서 유래한 서제스트 워드 수(문서 빈도가 1 이상인 서제스트 워드의 건수) - * - ``setting.queryWordsNum`` + * - ``setting.query_words_num`` - 검색 쿼리에서 유래한 서제스트 워드 수(쿼리 빈도가 1 이상인 서제스트 워드의 건수) .. note:: - ``documentWordsNum`` 과 ``queryWordsNum`` 은 배타적이지 않습니다. 하나의 서제스트 워드가 + ``document_words_num`` 과 ``query_words_num`` 은 배타적이지 않습니다. 하나의 서제스트 워드가 문서와 검색 쿼리 양쪽에서 유래한 경우, 양쪽 건수에 모두 포함됩니다. 이로 인해 - ``documentWordsNum`` 과 ``queryWordsNum`` 의 합계가 ``totalWordsNum`` 과 일치하지 않을 수 있습니다. + ``document_words_num`` 과 ``query_words_num`` 의 합계가 ``total_words_num`` 과 일치하지 않을 수 있습니다. 전체 서제스트 워드 삭제 ======================== diff --git a/ko/15.9/api/admin/api-admin-systeminfo.rst b/ko/15.9/api/admin/api-admin-systeminfo.rst index 1693ea1fc..ce89c154d 100644 --- a/ko/15.9/api/admin/api-admin-systeminfo.rst +++ b/ko/15.9/api/admin/api-admin-systeminfo.rst @@ -57,22 +57,22 @@ SystemInfo API는 |Fess| 의 시스템 정보를 조회하기 위한 API입니 "response": { "version": "15.9.0", "status": 0, - "envProps": [ + "env_props": [ {"label": "JAVA_HOME", "value": "/usr/lib/jvm/java-21"}, {"label": "FESS_DICTIONARY_PATH", "value": "/var/lib/fess/dict"} ], - "systemProps": [ + "system_props": [ {"label": "java.version", "value": "21.0.1"}, {"label": "java.vendor", "value": "Oracle Corporation"}, {"label": "os.name", "value": "Linux"}, {"label": "user.dir", "value": "/opt/fess"} ], - "fessProps": [ + "fess_props": [ {"label": "crawler.document.max.site.length", "value": "100"}, {"label": "indexer.thread.dump.enabled", "value": "true"}, {"label": "app.cipher.key", "value": "XXXXXXXX"} ], - "bugReportProps": [ + "bug_report_props": [ {"label": "os.name", "value": "Linux"}, {"label": "java.vm.version", "value": "21.0.1+12"} ] @@ -92,24 +92,24 @@ SystemInfo API는 |Fess| 의 시스템 정보를 조회하기 위한 API입니 - |Fess| 의 제품 버전 (예: ``15.9.0``). * - ``status`` - 처리 결과를 나타내는 코드. ``0`` 은 정상 종료를 의미합니다. - * - ``envProps`` + * - ``env_props`` - 환경 변수 목록 (``label`` / ``value`` 의 배열). ``System.getenv()`` 로 취득한 값이 그대로 반환됩니다. - * - ``systemProps`` + * - ``system_props`` - Java의 시스템 프로퍼티 목록 (``label`` / ``value`` 의 배열). ``System.getProperties()`` 로 취득한 값이 그대로 반환됩니다. - * - ``fessProps`` + * - ``fess_props`` - |Fess| 의 설정 프로퍼티 목록 (``label`` / ``value`` 의 배열). ``fess_config.properties`` 의 설정값과 관리 화면에서 설정된 시스템 프로퍼티가 포함됩니다. 민감한 항목은 마스킹됩니다 (아래 주의 사항 참조). - * - ``bugReportProps`` + * - ``bug_report_props`` - 버그 리포트용으로 수집되는 정보 목록 (``label`` / ``value`` 의 배열). OS 및 Java 실행 환경에 관한 주요 시스템 프로퍼티 (``os.name``, ``os.version``, ``java.vm.version`` 등) 와 |Fess| 의 시스템 프로퍼티 설정값이 포함됩니다. .. note:: - ``fessProps`` 에서는 다음 민감한 설정값이 마스킹되어 ``XXXXXXXX`` 로 반환됩니다: + ``fess_props`` 에서는 다음 민감한 설정값이 마스킹되어 ``XXXXXXXX`` 로 반환됩니다: ``http.proxy.password``, ``ldap.admin.security.credentials``, ``spnego.preauth.password``, ``app.cipher.key``, ``oic.client.id``, ``oic.client.secret``. .. warning:: - ``envProps`` (환경 변수) 와 ``systemProps`` (Java 시스템 프로퍼티) 는 마스킹되지 않으며, + ``env_props`` (환경 변수) 와 ``system_props`` (Java 시스템 프로퍼티) 는 마스킹되지 않으며, 설정된 값이 그대로 반환됩니다. 환경 변수나 시스템 프로퍼티에 인증 정보 등의 민감한 정보가 포함된 경우, 해당 값들이 응답에 포함되는 점에 주의하십시오. diff --git a/ko/15.9/api/admin/api-admin-user.rst b/ko/15.9/api/admin/api-admin-user.rst index affe3a62d..a8bd2420a 100644 --- a/ko/15.9/api/admin/api-admin-user.rst +++ b/ko/15.9/api/admin/api-admin-user.rst @@ -105,7 +105,7 @@ User API는 |Fess| 의 사용자 계정을 관리하기 위한 REST API입니다 }, "roles": ["admin"], "groups": [], - "versionNo": 1 + "version_no": 1 } ], "total": 10 @@ -150,7 +150,7 @@ User API는 |Fess| 의 사용자 계정을 관리하기 위한 REST API입니다 }, "roles": ["admin"], "groups": [], - "versionNo": 1 + "version_no": 1 } } } @@ -179,7 +179,7 @@ User API는 |Fess| 의 사용자 계정을 관리하기 위한 REST API입니다 { "name": "testuser", "password": "securepassword", - "confirmPassword": "securepassword", + "confirm_password": "securepassword", "attributes": { "surname": "Test", "givenName": "User", @@ -205,7 +205,7 @@ User API는 |Fess| 의 사용자 계정을 관리하기 위한 REST API입니다 * - ``password`` - 아니오 - 비밀번호 - * - ``confirmPassword`` + * - ``confirm_password`` - 아니오 - 확인용 비밀번호 * - ``attributes`` @@ -220,9 +220,9 @@ User API는 |Fess| 의 사용자 계정을 관리하기 위한 REST API입니다 .. note:: - REST API에서는 비밀번호 필수 확인, ``password`` 와 ``confirmPassword`` 의 일치 확인, + REST API에서는 비밀번호 필수 확인, ``password`` 와 ``confirm_password`` 의 일치 확인, 비밀번호 정책 검증을 수행하지 않습니다 (이것들은 관리 UI에서만 적용됩니다). - 실제 운용 시, ``password`` 의 값이 ``confirmPassword`` 와 일치하는 유효한 값을 지정하는 것을 권장합니다. + 실제 운용 시, ``password`` 의 값이 ``confirm_password`` 와 일치하는 유효한 값을 지정하는 것을 권장합니다. ``attributes`` 의 키에는 사용자 엔티티의 속성명 (LDAP 스키마에서 유래한 항목명)을 지정합니다. 대표적인 키는 다음과 같습니다. @@ -277,7 +277,7 @@ User API는 |Fess| 의 사용자 계정을 관리하기 위한 REST API입니다 "id": "existing_user_id", "name": "testuser", "password": "newpassword", - "confirmPassword": "newpassword", + "confirm_password": "newpassword", "attributes": { "surname": "Test", "givenName": "User Updated", @@ -285,7 +285,7 @@ User API는 |Fess| 의 사용자 계정을 관리하기 위한 REST API입니다 }, "roles": ["user", "editor"], "groups": ["group_id_1", "group_id_2"], - "versionNo": 1 + "version_no": 1 } 필드 설명 @@ -304,13 +304,13 @@ User API는 |Fess| 의 사용자 계정을 관리하기 위한 REST API입니다 * - ``name`` - 예 - 사용자명 (로그인 ID) - * - ``versionNo`` + * - ``version_no`` - 예 - 버전 번호 (낙관적 잠금용) * - ``password`` - 아니오 - 새 비밀번호 (지정한 경우에만 업데이트) - * - ``confirmPassword`` + * - ``confirm_password`` - 아니오 - 확인용 비밀번호 * - ``attributes`` @@ -325,8 +325,8 @@ User API는 |Fess| 의 사용자 계정을 관리하기 위한 REST API입니다 .. note:: - 업데이트 시 ``id``, ``name``, ``versionNo`` 는 필수입니다. - ``versionNo`` 는 대상 사용자 조회(GET) 시 반환되는 값이며, OpenSearch 문서의 버전에 대응합니다. + 업데이트 시 ``id``, ``name``, ``version_no`` 는 필수입니다. + ``version_no`` 는 대상 사용자 조회(GET) 시 반환되는 값이며, OpenSearch 문서의 버전에 대응합니다. 현재 버전과 일치하지 않으면 충돌로 판단되어 업데이트가 거부됩니다. 응답 @@ -391,7 +391,7 @@ User API는 |Fess| 의 사용자 계정을 관리하기 위한 REST API입니다 -d '{ "name": "john.doe", "password": "SecureP@ss123", - "confirmPassword": "SecureP@ss123", + "confirm_password": "SecureP@ss123", "attributes": { "surname": "Doe", "givenName": "John", @@ -413,7 +413,7 @@ User API는 |Fess| 의 사용자 계정을 관리하기 위한 REST API입니다 "id": "user_id_123", "name": "john.doe", "roles": ["user", "editor", "admin"], - "versionNo": 1 + "version_no": 1 }' 참고 정보 diff --git a/ko/15.9/api/admin/api-admin-webconfig.rst b/ko/15.9/api/admin/api-admin-webconfig.rst index 01662c887..0d73aa668 100644 --- a/ko/15.9/api/admin/api-admin-webconfig.rst +++ b/ko/15.9/api/admin/api-admin-webconfig.rst @@ -106,21 +106,21 @@ WebConfig API는 |Fess| 의 웹 크롤링 설정을 관리하기 위한 API입 "name": "Example Site", "description": "샘플 사이트", "urls": "https://example.com/", - "includedUrls": ".*example\\.com.*", - "excludedUrls": ".*\\.(pdf|zip)$", - "includedDocUrls": "", - "excludedDocUrls": "", - "configParameter": "", + "included_urls": ".*example\\.com.*", + "excluded_urls": ".*\\.(pdf|zip)$", + "included_doc_urls": "", + "excluded_doc_urls": "", + "config_parameter": "", "depth": 3, - "maxAccessCount": 1000, - "userAgent": "Mozilla/5.0", - "numOfThread": 1, - "intervalTime": 1000, + "max_access_count": 1000, + "user_agent": "Mozilla/5.0", + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, "available": "true", "permissions": "{role}admin", - "virtualHosts": "", - "sortOrder": 0 + "virtual_hosts": "", + "sort_order": 0 } ], "total": 5 @@ -152,35 +152,35 @@ WebConfig API는 |Fess| 의 웹 크롤링 설정을 관리하기 위한 API입 "name": "Example Site", "description": "샘플 사이트", "urls": "https://example.com/", - "includedUrls": ".*example\\.com.*", - "excludedUrls": ".*\\.(pdf|zip)$", - "includedDocUrls": "", - "excludedDocUrls": "", - "configParameter": "", + "included_urls": ".*example\\.com.*", + "excluded_urls": ".*\\.(pdf|zip)$", + "included_doc_urls": "", + "excluded_doc_urls": "", + "config_parameter": "", "depth": 3, - "maxAccessCount": 1000, - "userAgent": "Mozilla/5.0", - "numOfThread": 1, - "intervalTime": 1000, + "max_access_count": 1000, + "user_agent": "Mozilla/5.0", + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin", - "virtualHosts": "", - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_hosts": "", + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } .. note:: - 응답에는 등록 및 업데이트 시 자동으로 설정되는 ``createdBy``, ``createdTime``, - ``updatedBy``, ``updatedTime``, ``versionNo`` 가 포함됩니다. - ``versionNo`` 는 업데이트 시 필요합니다 (아래의 「웹 크롤링 설정 업데이트」를 참조). + 응답에는 등록 및 업데이트 시 자동으로 설정되는 ``created_by``, ``created_time``, + ``updated_by``, ``updated_time``, ``version_no`` 가 포함됩니다. + ``version_no`` 는 업데이트 시 필요합니다 (아래의 「웹 크롤링 설정 업데이트」를 참조). 웹 크롤링 설정 생성 ==================== @@ -201,14 +201,14 @@ WebConfig API는 |Fess| 의 웹 크롤링 설정을 관리하기 위한 API입 { "name": "Corporate Site", "urls": "https://www.example.com/", - "includedUrls": ".*www\\.example\\.com.*", - "excludedUrls": ".*\\.(pdf|zip|exe)$", - "userAgent": "Mozilla/5.0", - "numOfThread": 3, - "intervalTime": 500, + "included_urls": ".*www\\.example\\.com.*", + "excluded_urls": ".*\\.(pdf|zip|exe)$", + "user_agent": "Mozilla/5.0", + "num_of_thread": 3, + "interval_time": 500, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin\n{role}user" } @@ -231,34 +231,34 @@ WebConfig API는 |Fess| 의 웹 크롤링 설정을 관리하기 위한 API입 * - ``urls`` - 예 - 크롤링 시작 URL (여러 개인 경우 줄바꿈으로 구분). ``http:`` 또는 ``https:`` 로 지정합니다 - * - ``includedUrls`` + * - ``included_urls`` - 아니오 - 크롤링 대상 URL의 정규 표현식 패턴 - * - ``excludedUrls`` + * - ``excluded_urls`` - 아니오 - 크롤링 제외 URL의 정규 표현식 패턴 - * - ``includedDocUrls`` + * - ``included_doc_urls`` - 아니오 - 인덱스 대상 URL의 정규 표현식 패턴 - * - ``excludedDocUrls`` + * - ``excluded_doc_urls`` - 아니오 - 인덱스 제외 URL의 정규 표현식 패턴 - * - ``configParameter`` + * - ``config_parameter`` - 아니오 - 추가 설정 파라미터 (``key=value`` 형식, 한 줄에 한 항목) * - ``depth`` - 아니오 - 크롤링 깊이 (0 이상) - * - ``maxAccessCount`` + * - ``max_access_count`` - 아니오 - 최대 접근 수 (0 이상) - * - ``userAgent`` + * - ``user_agent`` - 예 - User-Agent 문자열 (최대 200자) - * - ``numOfThread`` + * - ``num_of_thread`` - 예 - 병렬 스레드 수 (1 이상) - * - ``intervalTime`` + * - ``interval_time`` - 예 - 접근 간격 (밀리초, 0 이상) * - ``boost`` @@ -267,19 +267,19 @@ WebConfig API는 |Fess| 의 웹 크롤링 설정을 관리하기 위한 API입 * - ``available`` - 예 - 활성화/비활성화 (문자열 ``"true"`` / ``"false"``) - * - ``sortOrder`` + * - ``sort_order`` - 예 - 표시 순서 (0 이상) * - ``permissions`` - 아니오 - 접근 허용 역할 (여러 개인 경우 줄바꿈으로 구분) - * - ``virtualHosts`` + * - ``virtual_hosts`` - 아니오 - 가상 호스트 (여러 개인 경우 줄바꿈으로 구분) .. note:: - ``createdBy``, ``createdTime``, ``updatedBy``, ``updatedTime`` 등의 감사용 필드는 + ``created_by``, ``created_time``, ``updated_by``, ``updated_time`` 등의 감사용 필드는 서버 측에서 자동으로 설정되므로 요청 본문에 지정할 필요가 없습니다. 응답 @@ -309,8 +309,8 @@ WebConfig API는 |Fess| 의 웹 크롤링 설정을 관리하기 위한 API입 요청 본문 ~~~~~~~~~~~~~~~~ -업데이트 시에는 생성 시의 필드에 더하여, 업데이트 대상을 식별하는 ``id`` 와 버전 번호 ``versionNo`` 가 필수입니다. -``versionNo`` 에는 조회 API (GET)의 응답에 포함된 현재 값을 지정합니다. +업데이트 시에는 생성 시의 필드에 더하여, 업데이트 대상을 식별하는 ``id`` 와 버전 번호 ``version_no`` 가 필수입니다. +``version_no`` 에는 조회 API (GET)의 응답에 포함된 현재 값을 지정합니다. .. code-block:: json @@ -318,17 +318,17 @@ WebConfig API는 |Fess| 의 웹 크롤링 설정을 관리하기 위한 API입 "id": "existing_webconfig_id", "name": "Updated Corporate Site", "urls": "https://www.example.com/", - "includedUrls": ".*www\\.example\\.com.*", - "excludedUrls": ".*\\.(pdf|zip|exe|dmg)$", - "userAgent": "Mozilla/5.0", + "included_urls": ".*www\\.example\\.com.*", + "excluded_urls": ".*\\.(pdf|zip|exe|dmg)$", + "user_agent": "Mozilla/5.0", "depth": 10, - "maxAccessCount": 10000, - "numOfThread": 5, - "intervalTime": 300, + "max_access_count": 10000, + "num_of_thread": 5, + "interval_time": 300, "boost": 1.2, "available": "true", - "sortOrder": 0, - "versionNo": 1 + "sort_order": 0, + "version_no": 1 } 업데이트 시 추가 필드 @@ -344,9 +344,9 @@ WebConfig API는 |Fess| 의 웹 크롤링 설정을 관리하기 위한 API입 * - ``id`` - 예 - 업데이트 대상의 설정 ID (최대 1000자) - * - ``versionNo`` + * - ``version_no`` - 예 - - 업데이트 대상의 현재 버전 번호. 조회 API (GET)의 응답에 포함된 ``versionNo`` 를 지정합니다 + - 업데이트 대상의 현재 버전 번호. 조회 API (GET)의 응답에 포함된 ``version_no`` 를 지정합니다 응답 ---------- @@ -385,7 +385,7 @@ WebConfig API는 |Fess| 의 웹 크롤링 설정을 관리하기 위한 API입 URL 패턴 예시 =============== -``includedUrls`` / ``excludedUrls`` / ``includedDocUrls`` / ``excludedDocUrls`` 에는 정규 표현식을 지정합니다. +``included_urls`` / ``excluded_urls`` / ``included_doc_urls`` / ``excluded_doc_urls`` 에는 정규 표현식을 지정합니다. .. list-table:: :header-rows: 1 @@ -418,16 +418,16 @@ URL 패턴 예시 -d '{ "name": "Corporate Website", "urls": "https://www.example.com/", - "includedUrls": ".*www\\.example\\.com.*", - "excludedUrls": ".*/(login|admin|api)/.*", - "userAgent": "Mozilla/5.0", + "included_urls": ".*www\\.example\\.com.*", + "excluded_urls": ".*/(login|admin|api)/.*", + "user_agent": "Mozilla/5.0", "depth": 5, - "maxAccessCount": 10000, - "numOfThread": 3, - "intervalTime": 500, + "max_access_count": 10000, + "num_of_thread": 3, + "interval_time": 500, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}guest" }' @@ -442,15 +442,15 @@ URL 패턴 예시 -d '{ "name": "Documentation Site", "urls": "https://docs.example.com/", - "includedUrls": ".*docs\\.example\\.com.*", - "includedDocUrls": ".*\\.(html|htm)$", - "userAgent": "Mozilla/5.0", - "maxAccessCount": 50000, - "numOfThread": 5, - "intervalTime": 200, + "included_urls": ".*docs\\.example\\.com.*", + "included_doc_urls": ".*\\.(html|htm)$", + "user_agent": "Mozilla/5.0", + "max_access_count": 50000, + "num_of_thread": 5, + "interval_time": 200, "boost": 1.5, "available": "true", - "sortOrder": 0 + "sort_order": 0 }' 참고 정보 diff --git a/zh-cn/15.9/api/admin/api-admin-accesstoken.rst b/zh-cn/15.9/api/admin/api-admin-accesstoken.rst index 710eb7cb6..6afee06a9 100644 --- a/zh-cn/15.9/api/admin/api-admin-accesstoken.rst +++ b/zh-cn/15.9/api/admin/api-admin-accesstoken.rst @@ -98,14 +98,14 @@ HTTP状态码），请参阅 :doc:`api-admin-overview` 。 "id": "token_id_1", "name": "API Token 1", "token": "abcd1234efgh5678", - "parameterName": "permission", + "parameter_name": "permission", "permissions": "{role}admin-api", "expires": "2026-01-01T00:00:00", - "createdBy": "admin", - "createdTime": 1735689600000, - "updatedBy": "admin", - "updatedTime": 1735689600000, - "versionNo": 1 + "created_by": "admin", + "created_time": 1735689600000, + "updated_by": "admin", + "updated_time": 1735689600000, + "version_no": 1 } ], "total": 5 @@ -114,9 +114,9 @@ HTTP状态码），请参阅 :doc:`api-admin-overview` 。 .. note:: - 每个令牌对象中还包含 ``createdBy`` 、 ``createdTime`` 、 ``updatedBy`` 、 - ``updatedTime`` 、 ``versionNo`` 等审计信息和版本信息。 - ``createdTime`` 和 ``updatedTime`` 以自纪元起的毫秒数（数值）表示。 + 每个令牌对象中还包含 ``created_by`` 、 ``created_time`` 、 ``updated_by`` 、 + ``updated_time`` 、 ``version_no`` 等审计信息和版本信息。 + ``created_time`` 和 ``updated_time`` 以自纪元起的毫秒数（数值）表示。 值为 ``null`` 的字段将从响应中排除。 ``permissions`` 以换行符（ ``\n`` ）分隔的字符串形式返回。 @@ -142,14 +142,14 @@ HTTP状态码），请参阅 :doc:`api-admin-overview` 。 "id": "token_id_1", "name": "API Token 1", "token": "abcd1234efgh5678", - "parameterName": "permission", + "parameter_name": "permission", "permissions": "{role}admin-api", "expires": "2026-01-01T00:00:00", - "createdBy": "admin", - "createdTime": 1735689600000, - "updatedBy": "admin", - "updatedTime": 1735689600000, - "versionNo": 1 + "created_by": "admin", + "created_time": 1735689600000, + "updated_by": "admin", + "updated_time": 1735689600000, + "version_no": 1 } } } @@ -192,7 +192,7 @@ HTTP状态码），请参阅 :doc:`api-admin-overview` 。 * - ``permissions`` - 否 - 授予此令牌的权限。可使用换行符（ ``\n`` ）分隔指定多个权限（例如： ``{role}admin-api`` ）。调用Admin API的令牌需要具有与 ``api.admin.access.permissions`` （默认值 ``{role}admin-api`` ）匹配的权限。 - * - ``parameterName`` + * - ``parameter_name`` - 否 - 用于传递附加权限的请求参数名称。当使用此令牌认证的请求中包含此处指定名称的参数时，该参数值将被追加到 ``permissions`` 中。省略时不进行设置。 * - ``expires`` @@ -239,7 +239,7 @@ HTTP状态码），请参阅 :doc:`api-admin-overview` 。 "name": "Updated API Token", "permissions": "{role}admin-api\n{role}user", "expires": "2026-01-01T00:00:00", - "versionNo": 1 + "version_no": 1 } 字段说明 @@ -257,9 +257,9 @@ HTTP状态码），请参阅 :doc:`api-admin-overview` 。 * - ``id`` - 是 - 待更新的令牌ID - * - ``versionNo`` + * - ``version_no`` - 是 - - 用于乐观锁的版本号。请指定预先获取的令牌的 ``versionNo`` 。 + - 用于乐观锁的版本号。请指定预先获取的令牌的 ``version_no`` 。 .. note:: diff --git a/zh-cn/15.9/api/admin/api-admin-badword.rst b/zh-cn/15.9/api/admin/api-admin-badword.rst index 2fab6fde6..6545c9b5d 100644 --- a/zh-cn/15.9/api/admin/api-admin-badword.rst +++ b/zh-cn/15.9/api/admin/api-admin-badword.rst @@ -92,7 +92,7 @@ BadWord API是用于管理 |Fess| 屏蔽词（不适当的建议词排除）的A "settings": [ { "id": "badword_id_1", - "suggestWord": "inappropriate_word" + "suggest_word": "inappropriate_word" } ], "total": 5 @@ -119,7 +119,7 @@ BadWord API是用于管理 |Fess| 屏蔽词（不适当的建议词排除）的A "status": 0, "setting": { "id": "badword_id_1", - "suggestWord": "inappropriate_word" + "suggest_word": "inappropriate_word" } } } @@ -141,7 +141,7 @@ BadWord API是用于管理 |Fess| 屏蔽词（不适当的建议词排除）的A .. code-block:: json { - "suggestWord": "spam_keyword" + "suggest_word": "spam_keyword" } 字段说明 @@ -154,7 +154,7 @@ BadWord API是用于管理 |Fess| 屏蔽词（不适当的建议词排除）的A * - 字段 - 必需 - 说明 - * - ``suggestWord`` + * - ``suggest_word`` - 是 - 要排除的关键词（不能包含空白字符） @@ -189,8 +189,8 @@ BadWord API是用于管理 |Fess| 屏蔽词（不适当的建议词排除）的A { "id": "existing_badword_id", - "suggestWord": "updated_spam_keyword", - "versionNo": 1 + "suggest_word": "updated_spam_keyword", + "version_no": 1 } 响应 @@ -260,7 +260,7 @@ CSV格式 ~~~~~~~ - 第一行作为标题行被跳过（列名可任意指定，下载时会输出 ``BadWord``）。 -- 从第二行开始，每行将一个屏蔽词作为 ``suggestWord`` 写入。 +- 从第二行开始，每行将一个屏蔽词作为 ``suggest_word`` 写入。 - 值为空白的行将被忽略。 - 在单词前加上 ``--`` 即可删除该单词（例如：``--spam`` 会删除 ``spam``）。 - 指定已注册的单词时，将被视为更新（更新者和更新时间会被重置）。 @@ -306,7 +306,7 @@ CSV格式 -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "suggestWord": "spam" + "suggest_word": "spam" }' 上传CSV文件 diff --git a/zh-cn/15.9/api/admin/api-admin-boostdoc.rst b/zh-cn/15.9/api/admin/api-admin-boostdoc.rst index 19030f2ed..84a43a368 100644 --- a/zh-cn/15.9/api/admin/api-admin-boostdoc.rst +++ b/zh-cn/15.9/api/admin/api-admin-boostdoc.rst @@ -10,18 +10,18 @@ BoostDoc API是用于管理 |Fess| 文档提升设置的API。 使其更容易出现在搜索结果的靠前位置。 提升在索引创建时（爬取时）应用于每个文档。 -条件（``urlExpr``）和提升值（``boostExpr``）按 ``scriptType`` 字段所指定脚本引擎的表达式进行求值。 -``scriptType`` 可指定为 ``javascript`` 或 ``groovy`` （需要 ``fess-script-groovy`` 插件）。管理界面的新建 -画面会预填 ``scriptType`` 为 ``javascript`` ，但如果本API的请求体省略了 ``scriptType`` ，则不会自动补全， +条件（``url_expr``）和提升值（``boost_expr``）按 ``script_type`` 字段所指定脚本引擎的表达式进行求值。 +``script_type`` 可指定为 ``javascript`` 或 ``groovy`` （需要 ``fess-script-groovy`` 插件）。管理界面的新建 +画面会预填 ``script_type`` 为 ``javascript`` ，但如果本API的请求体省略了 ``script_type`` ，则不会自动补全， 将按 Groovy 求值。 -多个规则按 ``sortOrder`` 升序依次求值，仅应用第一个条件匹配规则的提升值 +多个规则按 ``sort_order`` 升序依次求值，仅应用第一个条件匹配规则的提升值 （找到匹配规则后，后续规则将不再求值）。 .. note:: - 在管理界面中，``urlExpr`` 显示为"条件"，``boostExpr`` 显示为"提升值表达式"，``scriptType`` 显示为"脚本 - 类型"。``scriptType`` 仅出现在创建、更新、获取（列表与详情）的请求体和响应中，不出现在列表获取的过滤 - 参数（``urlExpr``、``boostExpr``）中。 + 在管理界面中，``url_expr`` 显示为"条件"，``boost_expr`` 显示为"提升值表达式"，``script_type`` 显示为"脚本 + 类型"。``script_type`` 仅出现在创建、更新、获取（列表与详情）的请求体和响应中，不出现在列表获取的过滤 + 参数（``url_expr``、``boost_expr``）中。 有关配置项的详细信息，请参阅 :doc:`../../admin/boostdoc-guide`。 基础URL @@ -92,11 +92,11 @@ BoostDoc API是用于管理 |Fess| 文档提升设置的API。 - Integer - 否 - 页码（从1开始。默认：1） - * - ``urlExpr`` + * - ``url_expr`` - String - 否 - 按条件表达式筛选（部分匹配） - * - ``boostExpr`` + * - ``boost_expr`` - String - 否 - 按提升值表达式筛选（部分匹配） @@ -112,11 +112,11 @@ BoostDoc API是用于管理 |Fess| 文档提升设置的API。 "settings": [ { "id": "boostdoc_id_1", - "urlExpr": "url.startsWith(\"https://docs.example.com/\")", - "boostExpr": "3.0", - "scriptType": "javascript", - "sortOrder": 1, - "versionNo": 1 + "url_expr": "url.startsWith(\"https://docs.example.com/\")", + "boost_expr": "3.0", + "script_type": "javascript", + "sort_order": 1, + "version_no": 1 } ], "total": 5 @@ -125,8 +125,8 @@ BoostDoc API是用于管理 |Fess| 文档提升设置的API。 .. note:: - 除上述字段外，响应中每条设置对象还包含创建/更新元数据（``createdBy``、``createdTime``、``updatedBy``、``updatedTime``）。 - ``versionNo`` 在更新（PUT）时为必填项，请在更新前通过获取单条或列表API取得当前值。 + 除上述字段外，响应中每条设置对象还包含创建/更新元数据（``created_by``、``created_time``、``updated_by``、``updated_time``）。 + ``version_no`` 在更新（PUT）时为必填项，请在更新前通过获取单条或列表API取得当前值。 获取文档提升 ============ @@ -148,11 +148,11 @@ BoostDoc API是用于管理 |Fess| 文档提升设置的API。 "status": 0, "setting": { "id": "boostdoc_id_1", - "urlExpr": "url.startsWith(\"https://docs.example.com/\")", - "boostExpr": "3.0", - "scriptType": "javascript", - "sortOrder": 1, - "versionNo": 1 + "url_expr": "url.startsWith(\"https://docs.example.com/\")", + "boost_expr": "3.0", + "script_type": "javascript", + "sort_order": 1, + "version_no": 1 } } } @@ -174,10 +174,10 @@ BoostDoc API是用于管理 |Fess| 文档提升设置的API。 .. code-block:: json { - "urlExpr": "url.startsWith(\"https://important.example.com/\")", - "boostExpr": "5.0", - "scriptType": "javascript", - "sortOrder": 0 + "url_expr": "url.startsWith(\"https://important.example.com/\")", + "boost_expr": "5.0", + "script_type": "javascript", + "sort_order": 0 } 字段说明 @@ -190,16 +190,16 @@ BoostDoc API是用于管理 |Fess| 文档提升设置的API。 * - 字段 - 必需 - 说明 - * - ``urlExpr`` + * - ``url_expr`` - 是 - 条件表达式。用于判断提升目标文档的脚本表达式，返回 ``Boolean`` 值。对应管理界面的"条件"（最多10000个字符）。 - * - ``boostExpr`` + * - ``boost_expr`` - 是 - 提升值表达式。返回提升值（数值）的脚本表达式。也可指定如 ``3.0`` 这样的固定值。对应管理界面的"提升值表达式"（最多10000个字符）。 - * - ``scriptType`` + * - ``script_type`` - 否 - - 用于对 ``urlExpr`` 和 ``boostExpr`` 求值的脚本引擎。可指定 ``javascript`` 或 ``groovy`` （需要 ``fess-script-groovy`` 插件）。对应管理界面的"脚本类型"（最多100个字符）。省略时按 Groovy 求值。 - * - ``sortOrder`` + - 用于对 ``url_expr`` 和 ``boost_expr`` 求值的脚本引擎。可指定 ``javascript`` 或 ``groovy`` （需要 ``fess-script-groovy`` 插件）。对应管理界面的"脚本类型"（最多100个字符）。省略时按 Groovy 求值。 + * - ``sort_order`` - 是 - 应用顺序。规则按升序依次求值，应用第一个条件匹配规则的提升值（表单初始值：0，须为0以上的整数）。 @@ -234,15 +234,15 @@ BoostDoc API是用于管理 |Fess| 文档提升设置的API。 { "id": "existing_boostdoc_id", - "urlExpr": "url.startsWith(\"https://important.example.com/\")", - "boostExpr": "10.0", - "scriptType": "javascript", - "sortOrder": 0, - "versionNo": 1 + "url_expr": "url.startsWith(\"https://important.example.com/\")", + "boost_expr": "10.0", + "script_type": "javascript", + "sort_order": 0, + "version_no": 1 } -更新时，除创建时的字段外，还需提供 ``id``\ （目标规则的ID，最多1000个字符）和 ``versionNo``\ （用于乐观锁的版本号）。 -``versionNo`` 请通过获取单条或列表API的响应取得当前值后再指定。 +更新时，除创建时的字段外，还需提供 ``id``\ （目标规则的ID，最多1000个字符）和 ``version_no``\ （用于乐观锁的版本号）。 +``version_no`` 请通过获取单条或列表API的响应取得当前值后再指定。 若版本号不匹配，更新将会失败。 响应 @@ -282,12 +282,12 @@ BoostDoc API是用于管理 |Fess| 文档提升设置的API。 关于条件表达式与提升值表达式 ============================ -``urlExpr``\ （条件）和 ``boostExpr``\ （提升值表达式）按 ``scriptType``\ （默认：Groovy；仅管理界面的 +``url_expr``\ （条件）和 ``boost_expr``\ （提升值表达式）按 ``script_type``\ （默认：Groovy；仅管理界面的 新建画面会预填 ``javascript`` ）所指定脚本引擎的表达式进行求值。 在表达式中，可以通过字段名变量引用索引目标文档的字段值。 -- ``urlExpr`` 必须返回 ``Boolean`` 值（例：``url.startsWith("https://docs.example.com/")``）。单纯的正则表达式字符串（例：``.*docs\.example\.com.*``）作为脚本表达式不返回 ``Boolean``，因此无法作为条件使用。若需使用正则表达式，请使用 ``String#matches`` 方法（Groovy 与 JavaScript 写法相同）。 -- ``boostExpr`` 必须返回数值。结果将被转换为 ``float``，仅当大于0时才会应用提升。 +- ``url_expr`` 必须返回 ``Boolean`` 值（例：``url.startsWith("https://docs.example.com/")``）。单纯的正则表达式字符串（例：``.*docs\.example\.com.*``）作为脚本表达式不返回 ``Boolean``，因此无法作为条件使用。若需使用正则表达式，请使用 ``String#matches`` 方法（Groovy 与 JavaScript 写法相同）。 +- ``boost_expr`` 必须返回数值。结果将被转换为 ``float``，仅当大于0时才会应用提升。 .. note:: @@ -296,7 +296,7 @@ BoostDoc API是用于管理 |Fess| 文档提升设置的API。 ``indexer.favorite.count.enabled``\ （均默认启用）的情况下可引用。 OpenSearch的日期计算语法（如 ``now - 7d``）在Groovy和JavaScript中均无法使用。 -条件表达式（``urlExpr``）示例 +条件表达式（``url_expr``）示例 ------------------------------ .. list-table:: @@ -312,7 +312,7 @@ BoostDoc API是用于管理 |Fess| 文档提升设置的API。 * - ``title.contains("发布说明")`` - 以标题中包含特定词语的文档为目标 -提升值表达式（``boostExpr``）示例 +提升值表达式（``boost_expr``）示例 ----------------------------------- .. list-table:: @@ -340,9 +340,9 @@ BoostDoc API是用于管理 |Fess| 文档提升设置的API。 -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "urlExpr": "url.startsWith(\"https://docs.example.com/\")", - "boostExpr": "5.0", - "sortOrder": 0 + "url_expr": "url.startsWith(\"https://docs.example.com/\")", + "boost_expr": "5.0", + "sort_order": 0 }' 点击量高的内容提升 @@ -354,9 +354,9 @@ BoostDoc API是用于管理 |Fess| 文档提升设置的API。 -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "urlExpr": "url.startsWith(\"https://www.example.com/\")", - "boostExpr": "click_count * 0.1 + 1", - "sortOrder": 10 + "url_expr": "url.startsWith(\"https://www.example.com/\")", + "boost_expr": "click_count * 0.1 + 1", + "sort_order": 10 }' 参考信息 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 e106cc7d6..40e8830eb 100644 --- a/zh-cn/15.9/api/admin/api-admin-crawlinginfo.rst +++ b/zh-cn/15.9/api/admin/api-admin-crawlinginfo.rst @@ -67,7 +67,7 @@ CrawlingInfo API是用于查看和管理 |Fess| 爬虫信息（爬虫会话） - Integer - 否 - 页码（从1开始，默认: 1） - * - ``sessionId`` + * - ``session_id`` - String - 否 - 会话ID过滤（部分匹配） @@ -83,17 +83,17 @@ CrawlingInfo API是用于查看和管理 |Fess| 爬虫信息（爬虫会话） "logs": [ { "id": "crawling_info_id_1", - "sessionId": "20250129100000", + "session_id": "20250129100000", "name": "Default Crawler", - "expiredTime": "1738200000000", - "createdTime": 1738108800000 + "expired_time": "1738200000000", + "created_time": 1738108800000 }, { "id": "crawling_info_id_2", - "sessionId": "20250128100000", + "session_id": "20250128100000", "name": "Default Crawler", - "expiredTime": "1738113600000", - "createdTime": 1738022400000 + "expired_time": "1738113600000", + "created_time": 1738022400000 } ], "total": 10 @@ -111,18 +111,18 @@ CrawlingInfo API是用于查看和管理 |Fess| 爬虫信息（爬虫会话） - 说明 * - ``id`` - 爬虫信息ID - * - ``sessionId`` + * - ``session_id`` - 会话ID * - ``name`` - 会话名称 - * - ``expiredTime`` + * - ``expired_time`` - 有效期限（epoch毫秒；以字符串形式返回） - * - ``createdTime`` + * - ``created_time`` - 创建时刻（epoch毫秒；以数值形式返回） .. note:: - 响应中每个日志对象还包含一个内部字段 ``crudMode`` + 响应中每个日志对象还包含一个内部字段 ``crud_mode`` （表示CRUD操作模式的整数值，在读取操作时始终为 ``0``）。 客户端可安全忽略此字段。 @@ -146,10 +146,10 @@ CrawlingInfo API是用于查看和管理 |Fess| 爬虫信息（爬虫会话） "status": 0, "log": { "id": "crawling_info_id_1", - "sessionId": "20250129100000", + "session_id": "20250129100000", "name": "Default Crawler", - "expiredTime": "1738200000000", - "createdTime": 1738108800000 + "expired_time": "1738200000000", + "created_time": 1738108800000 } } } diff --git a/zh-cn/15.9/api/admin/api-admin-dataconfig.rst b/zh-cn/15.9/api/admin/api-admin-dataconfig.rst index 1c2b34a9d..8eb4de80b 100644 --- a/zh-cn/15.9/api/admin/api-admin-dataconfig.rst +++ b/zh-cn/15.9/api/admin/api-admin-dataconfig.rst @@ -74,7 +74,7 @@ DataConfig API是用于管理 |Fess| 数据存储设置的API。 - String - 否 - 按配置名称过滤 - * - ``handlerName`` + * - ``handler_name`` - String - 否 - 按处理器名称过滤 @@ -96,14 +96,14 @@ DataConfig API是用于管理 |Fess| 数据存储设置的API。 "id": "dataconfig_id_1", "name": "Database Crawler", "description": "数据库爬虫", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/mydb", - "handlerScript": "...", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/mydb", + "handler_script": "...", "boost": 1.0, "available": "true", "permissions": "{role}admin", - "virtualHosts": "", - "sortOrder": 0 + "virtual_hosts": "", + "sort_order": 0 } ], "total": 5 @@ -132,14 +132,14 @@ DataConfig API是用于管理 |Fess| 数据存储设置的API。 "id": "dataconfig_id_1", "name": "Database Crawler", "description": "数据库爬虫", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/mydb\nusername=dbuser\npassword=dbpass", - "handlerScript": "...", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/mydb\nusername=dbuser\npassword=dbpass", + "handler_script": "...", "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin", - "virtualHosts": "" + "virtual_hosts": "" } } } @@ -162,12 +162,12 @@ DataConfig API是用于管理 |Fess| 数据存储设置的API。 { "name": "Product Database", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/products\nusername=user\npassword=pass", - "handlerScript": "url=\"https://example.com/product/\" + product_id\ntitle=product_name\ncontent=description", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/products\nusername=user\npassword=pass", + "handler_script": "url=\"https://example.com/product/\" + product_id\ntitle=product_name\ncontent=description", "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin\n{role}user" } @@ -187,13 +187,13 @@ DataConfig API是用于管理 |Fess| 数据存储设置的API。 * - ``description`` - 否 - 设置的说明 - * - ``handlerName`` + * - ``handler_name`` - 是 - 数据存储处理器名称 - * - ``handlerParameter`` + * - ``handler_parameter`` - 否 - 处理器参数（连接信息等） - * - ``handlerScript`` + * - ``handler_script`` - 否 - 数据转换脚本 * - ``boost`` @@ -202,13 +202,13 @@ DataConfig API是用于管理 |Fess| 数据存储设置的API。 * - ``available`` - 是 - 启用/禁用（字符串 ``"true"`` / ``"false"``） - * - ``sortOrder`` + * - ``sort_order`` - 是 - 显示顺序 * - ``permissions`` - 否 - 访问权限角色（多个时以换行分隔） - * - ``virtualHosts`` + * - ``virtual_hosts`` - 否 - 虚拟主机（多个时以换行分隔） @@ -244,16 +244,16 @@ DataConfig API是用于管理 |Fess| 数据存储设置的API。 { "id": "existing_dataconfig_id", "name": "Updated Product Database", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/products\nusername=user\npassword=newpass", - "handlerScript": "url=\"https://example.com/product/\" + product_id\ntitle=product_name\ncontent=description + \" \" + features", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/products\nusername=user\npassword=newpass", + "handler_script": "url=\"https://example.com/product/\" + product_id\ntitle=product_name\ncontent=description + \" \" + features", "boost": 1.5, "available": "true", - "sortOrder": 0, - "versionNo": 1 + "sort_order": 0, + "version_no": 1 } -更新请求需要与创建时相同的必填字段（``name``、``handlerName``、``boost``、``available``、``sortOrder``），以及以下字段： +更新请求需要与创建时相同的必填字段（``name``、``handler_name``、``boost``、``available``、``sort_order``），以及以下字段： .. list-table:: :header-rows: 1 @@ -265,7 +265,7 @@ DataConfig API是用于管理 |Fess| 数据存储设置的API。 * - ``id`` - 是 - 要更新的配置 ID - * - ``versionNo`` + * - ``version_no`` - 是 - 用于乐观锁的版本号（指定获取设置时返回的值） @@ -340,12 +340,12 @@ DataConfig API是用于管理 |Fess| 数据存储设置的API。 -H "Content-Type: application/json" \ -d '{ "name": "User Database", - "handlerName": "DatabaseDataStore", - "handlerParameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/userdb\nusername=dbuser\npassword=dbpass\nsql=SELECT * FROM users WHERE active=true", - "handlerScript": "url=\"https://example.com/user/\" + user_id\ntitle=username\ncontent=profile", + "handler_name": "DatabaseDataStore", + "handler_parameter": "driver=org.postgresql.Driver\nurl=jdbc:postgresql://localhost/userdb\nusername=dbuser\npassword=dbpass\nsql=SELECT * FROM users WHERE active=true", + "handler_script": "url=\"https://example.com/user/\" + user_id\ntitle=username\ncontent=profile", "boost": 1.0, "available": "true", - "sortOrder": 0 + "sort_order": 0 }' 参考信息 diff --git a/zh-cn/15.9/api/admin/api-admin-dict.rst b/zh-cn/15.9/api/admin/api-admin-dict.rst index 29d2dfcd3..87d8ceee5 100644 --- a/zh-cn/15.9/api/admin/api-admin-dict.rst +++ b/zh-cn/15.9/api/admin/api-admin-dict.rst @@ -179,7 +179,7 @@ Dict API是用于管理 |Fess| 词典的API。 "settings": [ { "id": 1, - "dictId": "ZjA5...synonym.txt", + "dict_id": "ZjA5...synonym.txt", "inputs": "検索,サーチ", "outputs": "検索,サーチ,リサーチ" } @@ -233,7 +233,7 @@ Dict API是用于管理 |Fess| 词典的API。 "status": 0, "setting": { "id": 1, - "dictId": "ZjA5...synonym.txt", + "dict_id": "ZjA5...synonym.txt", "inputs": "検索,サーチ", "outputs": "検索,サーチ,リサーチ" } @@ -406,7 +406,7 @@ Dict API是用于管理 |Fess| 词典的API。 ==================== 词典项目的创建·更新请求体以及响应的字段因词典类型而异。 -``id`` （项目ID）和 ``dictId`` （词典ID）在响应中是共通的。 +``id`` （项目ID）和 ``dict_id`` （词典ID）在响应中是共通的。 .. list-table:: :header-rows: 1 diff --git a/zh-cn/15.9/api/admin/api-admin-elevateword.rst b/zh-cn/15.9/api/admin/api-admin-elevateword.rst index 149ff422f..e6abfab79 100644 --- a/zh-cn/15.9/api/admin/api-admin-elevateword.rst +++ b/zh-cn/15.9/api/admin/api-admin-elevateword.rst @@ -92,11 +92,11 @@ ElevateWord API是用于管理 |Fess| 提升词（特定关键词的搜索排名 "settings": [ { "id": "elevate_id_1", - "suggestWord": "fess", + "suggest_word": "fess", "reading": "", "permissions": "{role}guest", "boost": 100.0, - "labelTypeIds": [] + "label_type_ids": [] } ], "total": 5 @@ -123,11 +123,11 @@ ElevateWord API是用于管理 |Fess| 提升词（特定关键词的搜索排名 "status": 0, "setting": { "id": "elevate_id_1", - "suggestWord": "fess", + "suggest_word": "fess", "reading": "", "permissions": "{role}guest", "boost": 100.0, - "labelTypeIds": [] + "label_type_ids": [] } } } @@ -149,11 +149,11 @@ ElevateWord API是用于管理 |Fess| 提升词（特定关键词的搜索排名 .. code-block:: json { - "suggestWord": "documentation", + "suggest_word": "documentation", "reading": "", "permissions": "{role}guest", "boost": 100.0, - "labelTypeIds": ["label1"] + "label_type_ids": ["label1"] } 字段说明 @@ -166,7 +166,7 @@ ElevateWord API是用于管理 |Fess| 提升词（特定关键词的搜索排名 * - 字段 - 必需 - 说明 - * - ``suggestWord`` + * - ``suggest_word`` - 是 - 提升目标的关键词 * - ``reading`` @@ -178,7 +178,7 @@ ElevateWord API是用于管理 |Fess| 提升词（特定关键词的搜索排名 * - ``boost`` - 是 - 提升值（表单初始值：100.0） - * - ``labelTypeIds`` + * - ``label_type_ids`` - 否 - 目标标签ID（字符串数组） @@ -213,12 +213,12 @@ ElevateWord API是用于管理 |Fess| 提升词（特定关键词的搜索排名 { "id": "existing_elevate_id", - "suggestWord": "documentation", + "suggest_word": "documentation", "reading": "", "permissions": "{role}guest\n{role}user", "boost": 100.0, - "labelTypeIds": ["label1"], - "versionNo": 1 + "label_type_ids": ["label1"], + "version_no": 1 } .. note:: @@ -226,7 +226,7 @@ ElevateWord API是用于管理 |Fess| 提升词（特定关键词的搜索排名 更新时，除创建时所需的字段外，还需要以下字段。 - ``id`` - 要更新的提升词ID - - ``versionNo`` - 用于乐观锁的版本号。请指定通过 ``GET /setting/{id}`` 获取的值。 + - ``version_no`` - 用于乐观锁的版本号。请指定通过 ``GET /setting/{id}`` 获取的值。 响应 ---- @@ -326,7 +326,7 @@ ElevateWord API是用于管理 |Fess| 提升词（特定关键词的搜索排名 -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "suggestWord": "Product X", + "suggest_word": "Product X", "boost": 100.0, "permissions": "{role}guest" }' @@ -340,9 +340,9 @@ ElevateWord API是用于管理 |Fess| 提升词（特定关键词的搜索排名 -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "suggestWord": "API reference", + "suggest_word": "API reference", "boost": 100.0, - "labelTypeIds": ["technical_docs"], + "label_type_ids": ["technical_docs"], "permissions": "{role}guest" }' 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 79771f17f..027e9bee3 100644 --- a/zh-cn/15.9/api/admin/api-admin-failureurl.rst +++ b/zh-cn/15.9/api/admin/api-admin-failureurl.rst @@ -71,15 +71,15 @@ FailureUrl API是用于管理 |Fess| 爬虫失败URL的API。 - String - 否 - URL过滤（支持通配符 ``*`` ``?``） - * - ``errorCountMin`` + * - ``error_count_min`` - Integer - 否 - 错误次数的下限（大于等于指定值） - * - ``errorCountMax`` + * - ``error_count_max`` - Integer - 否 - 错误次数的上限（小于等于指定值） - * - ``errorName`` + * - ``error_name`` - String - 否 - 错误名称过滤（对存储的完全限定类名进行通配符匹配；支持 ``*`` ``?``） @@ -96,22 +96,22 @@ FailureUrl API是用于管理 |Fess| 爬虫失败URL的API。 { "id": "failure_id_1", "url": "https://example.com/broken-page", - "threadName": "Crawler-1", - "errorName": "java.net.ConnectException", - "errorLog": "Connection refused: connect", - "errorCount": "3", - "lastAccessTime": "1738144800000", - "configId": "webConfig_id_1" + "thread_name": "Crawler-1", + "error_name": "java.net.ConnectException", + "error_log": "Connection refused: connect", + "error_count": "3", + "last_access_time": "1738144800000", + "config_id": "webConfig_id_1" }, { "id": "failure_id_2", "url": "https://example.com/not-found", - "threadName": "Crawler-2", - "errorName": "org.codelibs.fess.exception.ContentNotFoundException", - "errorLog": "Not found: https://example.com/not-found", - "errorCount": "1", - "lastAccessTime": "1738143000000", - "configId": "webConfig_id_1" + "thread_name": "Crawler-2", + "error_name": "org.codelibs.fess.exception.ContentNotFoundException", + "error_log": "Not found: https://example.com/not-found", + "error_count": "1", + "last_access_time": "1738143000000", + "config_id": "webConfig_id_1" } ], "total": 45 @@ -131,22 +131,22 @@ FailureUrl API是用于管理 |Fess| 爬虫失败URL的API。 - 失败URL ID * - ``url`` - 失败的URL - * - ``threadName`` + * - ``thread_name`` - 线程名称 - * - ``errorName`` + * - ``error_name`` - 错误名称（发生的异常的完全限定类名；例如 ``java.net.ConnectException``） - * - ``errorLog`` + * - ``error_log`` - 错误日志（异常消息或堆栈跟踪） - * - ``errorCount`` + * - ``error_count`` - 错误发生次数（以字符串形式返回的数值） - * - ``lastAccessTime`` + * - ``last_access_time`` - 最后访问时刻（以字符串形式返回的epoch毫秒值） - * - ``configId`` + * - ``config_id`` - 爬虫配置ID .. note:: - 所有响应字段均以字符串形式返回（JSON string）。\ ``errorCount`` 是以字符串表示的数值，``lastAccessTime`` 是以字符串表示的epoch毫秒值。 + 所有响应字段均以字符串形式返回（JSON string）。\ ``error_count`` 是以字符串表示的数值，``last_access_time`` 是以字符串表示的epoch毫秒值。 获取失败URL =========== @@ -169,12 +169,12 @@ FailureUrl API是用于管理 |Fess| 爬虫失败URL的API。 "log": { "id": "failure_id_1", "url": "https://example.com/broken-page", - "threadName": "Crawler-1", - "errorName": "java.net.ConnectException", - "errorLog": "Connection refused: connect", - "errorCount": "3", - "lastAccessTime": "1738144800000", - "configId": "webConfig_id_1" + "thread_name": "Crawler-1", + "error_name": "java.net.ConnectException", + "error_log": "Connection refused: connect", + "error_count": "3", + "last_access_time": "1738144800000", + "config_id": "webConfig_id_1" } } } @@ -226,7 +226,7 @@ FailureUrl API是用于管理 |Fess| 爬虫失败URL的API。 错误类型 ======== -``errorName`` 存储爬虫过程中发生的异常的完全限定类名，与捕获时的内容完全一致。它不是固定的枚举值；根据实际抛出的异常，可能出现任意类名。以下是一些典型示例。 +``error_name`` 存储爬虫过程中发生的异常的完全限定类名，与捕获时的内容完全一致。它不是固定的枚举值；根据实际抛出的异常，可能出现任意类名。以下是一些典型示例。 .. list-table:: :header-rows: 1 @@ -310,7 +310,7 @@ FailureUrl API是用于管理 |Fess| 爬虫失败URL的API。 # 按错误类型计数 curl -X GET "http://localhost:8080/api/admin/failureurl/logs?size=1000" \ -H "Authorization: Bearer YOUR_TOKEN" | \ - jq '[.response.logs[].errorName] | group_by(.) | map({error: .[0], count: length})' + jq '[.response.logs[].error_name] | group_by(.) | map({error: .[0], count: length})' 参考信息 ======== diff --git a/zh-cn/15.9/api/admin/api-admin-fileconfig.rst b/zh-cn/15.9/api/admin/api-admin-fileconfig.rst index 897583bf6..3feee7d35 100644 --- a/zh-cn/15.9/api/admin/api-admin-fileconfig.rst +++ b/zh-cn/15.9/api/admin/api-admin-fileconfig.rst @@ -106,20 +106,20 @@ FileConfig API是用于管理 |Fess| 文件爬虫设置的API。 "name": "Shared Documents", "description": "共享文档", "paths": "smb://server/share/documents", - "includedPaths": ".*\\.pdf$", - "excludedPaths": ".*/(temp|cache)/.*", - "includedDocPaths": "", - "excludedDocPaths": "", - "configParameter": "", + "included_paths": ".*\\.pdf$", + "excluded_paths": ".*/(temp|cache)/.*", + "included_doc_paths": "", + "excluded_doc_paths": "", + "config_parameter": "", "depth": 10, - "maxAccessCount": 1000, - "numOfThread": 1, - "intervalTime": 1000, + "max_access_count": 1000, + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, "available": "true", "permissions": "{role}admin", - "virtualHosts": "", - "sortOrder": 0 + "virtual_hosts": "", + "sort_order": 0 } ], "total": 5 @@ -151,34 +151,34 @@ FileConfig API是用于管理 |Fess| 文件爬虫设置的API。 "name": "Shared Documents", "description": "共享文档", "paths": "smb://server/share/documents", - "includedPaths": ".*\\.pdf$", - "excludedPaths": ".*/(temp|cache)/.*", - "includedDocPaths": "", - "excludedDocPaths": "", - "configParameter": "", + "included_paths": ".*\\.pdf$", + "excluded_paths": ".*/(temp|cache)/.*", + "included_doc_paths": "", + "excluded_doc_paths": "", + "config_parameter": "", "depth": 10, - "maxAccessCount": 1000, - "numOfThread": 1, - "intervalTime": 1000, + "max_access_count": 1000, + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin", - "virtualHosts": "", - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_hosts": "", + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } .. note:: - 响应中包含在注册和更新时由服务器自动设置的 ``createdBy`` 、 ``createdTime`` 、 - ``updatedBy`` 、 ``updatedTime`` 、 ``versionNo`` 字段。 - ``versionNo`` 在更新时为必填项（请参阅后述的"更新文件爬虫设置"）。 + 响应中包含在注册和更新时由服务器自动设置的 ``created_by`` 、 ``created_time`` 、 + ``updated_by`` 、 ``updated_time`` 、 ``version_no`` 字段。 + ``version_no`` 在更新时为必填项（请参阅后述的"更新文件爬虫设置"）。 创建文件爬虫设置 ================ @@ -199,13 +199,13 @@ FileConfig API是用于管理 |Fess| 文件爬虫设置的API。 { "name": "Local Files", "paths": "file:///data/documents", - "includedPaths": ".*\\.(pdf|doc|docx|xls|xlsx)$", - "excludedPaths": ".*/(temp|backup)/.*", - "numOfThread": 2, - "intervalTime": 500, + "included_paths": ".*\\.(pdf|doc|docx|xls|xlsx)$", + "excluded_paths": ".*/(temp|backup)/.*", + "num_of_thread": 2, + "interval_time": 500, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin\n{role}user" } @@ -228,31 +228,31 @@ FileConfig API是用于管理 |Fess| 文件爬虫设置的API。 * - ``paths`` - 是 - 爬虫起始路径（多个路径用换行符分隔）。使用 ``file:`` 、 ``smb:`` 、 ``smb1:`` 、 ``ftp:`` 、 ``s3:`` 、 ``gcs:`` 中的一种协议指定 - * - ``includedPaths`` + * - ``included_paths`` - 否 - 爬虫目标路径的正则表达式模式 - * - ``excludedPaths`` + * - ``excluded_paths`` - 否 - 排除爬虫路径的正则表达式模式 - * - ``includedDocPaths`` + * - ``included_doc_paths`` - 否 - 索引目标路径的正则表达式模式 - * - ``excludedDocPaths`` + * - ``excluded_doc_paths`` - 否 - 排除索引路径的正则表达式模式 - * - ``configParameter`` + * - ``config_parameter`` - 否 - 附加配置参数（ ``key=value`` 格式，每行一项） * - ``depth`` - 否 - 爬虫深度（0以上） - * - ``maxAccessCount`` + * - ``max_access_count`` - 否 - 最大访问数（0以上） - * - ``numOfThread`` + * - ``num_of_thread`` - 是 - 并行线程数（1以上） - * - ``intervalTime`` + * - ``interval_time`` - 是 - 访问间隔（毫秒，0以上） * - ``boost`` @@ -261,19 +261,19 @@ FileConfig API是用于管理 |Fess| 文件爬虫设置的API。 * - ``available`` - 是 - 启用/禁用（字符串 ``"true"`` / ``"false"``） - * - ``sortOrder`` + * - ``sort_order`` - 是 - 显示顺序（0以上） * - ``permissions`` - 否 - 访问权限角色（多个时用换行符分隔） - * - ``virtualHosts`` + * - ``virtual_hosts`` - 否 - 虚拟主机（多个时用换行符分隔） .. note:: - ``createdBy`` 、 ``createdTime`` 、 ``updatedBy`` 、 ``updatedTime`` 等审计字段 + ``created_by`` 、 ``created_time`` 、 ``updated_by`` 、 ``updated_time`` 等审计字段 由服务器自动设置，无需在请求体中指定。 响应 @@ -303,8 +303,8 @@ FileConfig API是用于管理 |Fess| 文件爬虫设置的API。 请求体 ~~~~~~ -更新时，除创建时的字段外，还需要指定用于确定更新目标的 ``id`` 和版本号 ``versionNo`` 。 -``versionNo`` 需填写获取API（GET）响应中包含的当前值。 +更新时，除创建时的字段外，还需要指定用于确定更新目标的 ``id`` 和版本号 ``version_no`` 。 +``version_no`` 需填写获取API（GET）响应中包含的当前值。 .. code-block:: json @@ -312,16 +312,16 @@ FileConfig API是用于管理 |Fess| 文件爬虫设置的API。 "id": "existing_fileconfig_id", "name": "Updated Local Files", "paths": "file:///data/documents", - "includedPaths": ".*\\.(pdf|doc|docx|xls|xlsx|ppt|pptx)$", - "excludedPaths": ".*/(temp|backup|archive)/.*", + "included_paths": ".*\\.(pdf|doc|docx|xls|xlsx|ppt|pptx)$", + "excluded_paths": ".*/(temp|backup|archive)/.*", "depth": 10, - "maxAccessCount": 10000, - "numOfThread": 3, - "intervalTime": 300, + "max_access_count": 10000, + "num_of_thread": 3, + "interval_time": 300, "boost": 1.2, "available": "true", - "sortOrder": 0, - "versionNo": 1 + "sort_order": 0, + "version_no": 1 } 更新时的附加字段 @@ -337,9 +337,9 @@ FileConfig API是用于管理 |Fess| 文件爬虫设置的API。 * - ``id`` - 是 - 更新目标的设置ID（最多1000个字符） - * - ``versionNo`` + * - ``version_no`` - 是 - - 更新目标的当前版本号。填写获取API（GET）响应中包含的 ``versionNo`` 值 + - 更新目标的当前版本号。填写获取API（GET）响应中包含的 ``version_no`` 值 响应 ---- @@ -418,13 +418,13 @@ FileConfig API是用于管理 |Fess| 文件爬虫设置的API。 -d '{ "name": "Local Files", "paths": "file:///data/documents", - "includedPaths": ".*\\.(pdf|doc|docx)$", - "excludedPaths": ".*/(temp|backup)/.*", - "numOfThread": 2, - "intervalTime": 500, + "included_paths": ".*\\.(pdf|doc|docx)$", + "excluded_paths": ".*/(temp|backup)/.*", + "num_of_thread": 2, + "interval_time": 500, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}guest" }' @@ -439,14 +439,14 @@ SMB共享爬虫设置 -d '{ "name": "SMB Share", "paths": "smb://server/documents", - "includedPaths": ".*\\.(pdf|doc|docx)$", - "excludedPaths": ".*/(temp|private)/.*", - "maxAccessCount": 50000, - "numOfThread": 3, - "intervalTime": 200, + "included_paths": ".*\\.(pdf|doc|docx)$", + "excluded_paths": ".*/(temp|private)/.*", + "max_access_count": 50000, + "num_of_thread": 3, + "interval_time": 200, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}guest" }' diff --git a/zh-cn/15.9/api/admin/api-admin-general.rst b/zh-cn/15.9/api/admin/api-admin-general.rst index b9c450d18..c4be98099 100644 --- a/zh-cn/15.9/api/admin/api-admin-general.rst +++ b/zh-cn/15.9/api/admin/api-admin-general.rst @@ -64,37 +64,36 @@ General API是用于管理 |Fess| 常规设置（系统整体配置）的API。 "version": "15.9.0", "status": 0, "setting": { - "incrementalCrawling": "true", - "dayForCleanup": -1, - "crawlingThreadCount": 5, - "searchLog": "true", - "userInfo": "true", - "userFavorite": "false", - "webApiJson": "true", - "defaultLabelValue": "", - "defaultSortValue": "", - "appendQueryParameter": "false", - "loginRequired": "false", + "incremental_crawling": "true", + "day_for_cleanup": -1, + "crawling_thread_count": 5, + "search_log": "true", + "user_info": "true", + "user_favorite": "false", + "web_api_json": "true", + "default_label_value": "", + "default_sort_value": "", + "append_query_parameter": "false", + "login_required": "false", "thumbnail": "true", - "failureCountThreshold": -1, - "popularWord": "true", - "csvFileEncoding": "UTF-8", - "purgeSearchLogDay": 30, - "purgeJobLogDay": 30, - "purgeUserInfoDay": 30, - "purgeSuggestSearchLogDay": 30, - "notificationTo": "", - "suggestSearchLog": "true", - "suggestDocuments": "true", - "ldapProviderUrl": "ldap://localhost:389/", - "ldapBaseDn": "dc=example,dc=com", - "ldapAdminSecurityPrincipal": "cn=admin,dc=example,dc=com", - "ldapAdminSecurityCredentials": null, - "logLevel": "", - "ssoType": "none", - "storageType": "", - "notificationLogin": "", - "notificationSearchTop": "" + "failure_count_threshold": -1, + "popular_word": "true", + "csv_file_encoding": "UTF-8", + "purge_search_log_day": 30, + "purge_job_log_day": 30, + "purge_user_info_day": 30, + "purge_suggest_search_log_day": 30, + "notification_to": "", + "suggest_search_log": "true", + "suggest_documents": "true", + "ldap_provider_url": "ldap://localhost:389/", + "ldap_base_dn": "dc=example,dc=com", + "ldap_admin_security_principal": "cn=admin,dc=example,dc=com", + "log_level": "", + "sso_type": "none", + "storage_type": "", + "notification_login": "", + "notification_search_top": "" } } } @@ -108,10 +107,10 @@ General API是用于管理 |Fess| 常规设置（系统整体配置）的API。 出于安全原因，包含凭据的字段不会以实际值返回。 - - LDAP管理员密码 ``ldapAdminSecurityCredentials`` 始终以 ``null`` 返回。 - - 其他机密字段（``storageAccessKey`` / ``storageSecretKey`` / - ``oicClientId`` / ``oicClientSecret`` / ``spnegoPreauthPassword`` / - ``entraidClientId`` / ``entraidClientSecret``）在已设置的情况下 + - LDAP管理员密码 ``ldap_admin_security_credentials`` 始终不包含在响应中。 + - 其他机密字段（``storage_access_key`` / ``storage_secret_key`` / + ``oic_client_id`` / ``oic_client_secret`` / ``spnego_preauth_password`` / + ``entraid_client_id`` / ``entraid_client_secret``）在已设置的情况下 以掩码值 ``"**********"`` 返回，未设置时以空字符串（``""``）返回。 更新常规设置 @@ -136,10 +135,10 @@ General API是用于管理 |Fess| 常规设置（系统整体配置）的API。 以下四个字段为必需字段，**每次** PUT请求中都必须包含这些字段， 即使是部分更新也是如此。 - - ``dayForCleanup`` - - ``crawlingThreadCount`` - - ``failureCountThreshold`` - - ``csvFileEncoding`` + - ``day_for_cleanup`` + - ``crawling_thread_count`` + - ``failure_count_threshold`` + - ``csv_file_encoding`` 如果缺少其中任何一个，请求将验证失败，API将返回 HTTP 400， 并附带 ``status: 1`` 和错误 ``message``\ 。由于发送的值会覆盖现有设置， @@ -162,12 +161,12 @@ General API是用于管理 |Fess| 常规设置（系统整体配置）的API。 .. code-block:: json { - "incrementalCrawling": "true", - "dayForCleanup": -1, - "crawlingThreadCount": 10, - "failureCountThreshold": 100, - "csvFileEncoding": "UTF-8", - "popularWord": "true" + "incremental_crawling": "true", + "day_for_cleanup": -1, + "crawling_thread_count": 10, + "failure_count_threshold": 100, + "csv_file_encoding": "UTF-8", + "popular_word": "true" } 主要字段 @@ -184,124 +183,124 @@ General API是用于管理 |Fess| 常规设置（系统整体配置）的API。 * - 字段 - 必需 - 说明 - * - ``incrementalCrawling`` + * - ``incremental_crawling`` - 否 - 增量爬取的启用/禁用 - * - ``dayForCleanup`` + * - ``day_for_cleanup`` - 是 - 保留已爬取文档的天数（-1=禁用清理；取值范围：-1 至 1000） - * - ``crawlingThreadCount`` + * - ``crawling_thread_count`` - 是 - 爬取使用的线程数（取值范围：0 至 100） - * - ``failureCountThreshold`` + * - ``failure_count_threshold`` - 是 - 停止URL爬取的失败次数阈值（-1=禁用；取值范围：-1 至 10000） - * - ``csvFileEncoding`` + * - ``csv_file_encoding`` - 是 - CSV导出的编码 - * - ``searchLog`` + * - ``search_log`` - 否 - 搜索查询日志的启用/禁用 - * - ``userInfo`` + * - ``user_info`` - 否 - 用户信息记录的启用/禁用 - * - ``userFavorite`` + * - ``user_favorite`` - 否 - 收藏功能的启用/禁用 - * - ``webApiJson`` + * - ``web_api_json`` - 否 - JSON Web API的启用/禁用 - * - ``appValue`` + * - ``app_value`` - 否 - 应用程序专用的附加配置值 - * - ``virtualHostValue`` + * - ``virtual_host_value`` - 否 - 虚拟主机配置（用于多租户环境） - * - ``popularWord`` + * - ``popular_word`` - 否 - 热门词汇的统计与显示的启用/禁用 - * - ``defaultLabelValue`` + * - ``default_label_value`` - 否 - 默认标签值 - * - ``defaultSortValue`` + * - ``default_sort_value`` - 否 - 默认排序顺序 - * - ``appendQueryParameter`` + * - ``append_query_parameter`` - 否 - 向搜索结果URL附加查询参数 - * - ``loginRequired`` + * - ``login_required`` - 否 - 搜索是否需要登录 - * - ``loginLink`` + * - ``login_link`` - 否 - 搜索页面上登录链接显示的启用/禁用 * - ``thumbnail`` - 否 - 缩略图生成的启用/禁用 - * - ``resultCollapsed`` + * - ``result_collapsed`` - 否 - 搜索结果中折叠相似文档的启用/禁用 - * - ``ignoreFailureType`` + * - ``ignore_failure_type`` - 否 - 要忽略的爬取失败类型 - * - ``crawlingUserAgent`` + * - ``crawling_user_agent`` - 否 - 爬取时发送的User-Agent字符串 - * - ``purgeSearchLogDay`` + * - ``purge_search_log_day`` - 否 - 保留搜索日志的天数（-1=禁用；取值范围：-1 至 100000） - * - ``purgeJobLogDay`` + * - ``purge_job_log_day`` - 否 - 保留作业日志的天数（-1=禁用；取值范围：-1 至 100000） - * - ``purgeUserInfoDay`` + * - ``purge_user_info_day`` - 否 - 保留用户信息的天数（-1=禁用；取值范围：-1 至 100000） - * - ``purgeSuggestSearchLogDay`` + * - ``purge_suggest_search_log_day`` - 否 - 保留建议搜索日志的天数（0=禁用；取值范围：0 至 100000） - * - ``purgeByBots`` + * - ``purge_by_bots`` - 否 - 要丢弃搜索日志的机器人User-Agent - * - ``notificationTo`` + * - ``notification_to`` - 否 - 系统通知的接收邮箱地址 - * - ``notificationLogin`` + * - ``notification_login`` - 否 - 在登录页面显示的通知消息 - * - ``notificationSearchTop`` + * - ``notification_search_top`` - 否 - 在搜索首页显示的通知消息 - * - ``notificationAdvanceSearch`` + * - ``notification_advance_search`` - 否 - 在高级搜索页面显示的通知消息 - * - ``suggestSearchLog`` + * - ``suggest_search_log`` - 否 - 来自搜索日志的建议的启用/禁用 - * - ``suggestDocuments`` + * - ``suggest_documents`` - 否 - 来自文档的建议的启用/禁用 - * - ``logLevel`` + * - ``log_level`` - 否 - 系统日志的日志级别 - * - ``logNotificationEnabled`` + * - ``log_notification_enabled`` - 否 - ERROR/WARN日志通知的启用/禁用 - * - ``logNotificationLevel`` + * - ``log_notification_level`` - 否 - 日志通知级别 - * - ``slackWebhookUrls`` + * - ``slack_webhook_urls`` - 否 - 用于通知的Slack Webhook URL - * - ``googleChatWebhookUrls`` + * - ``google_chat_webhook_urls`` - 否 - 用于通知的Google Chat Webhook URL - * - ``searchUseBrowserLocale`` + * - ``search_use_browser_locale`` - 否 - 搜索时是否使用浏览器语言区域设置 - * - ``ragLlmName`` + * - ``rag_llm_name`` - 否 - RAG所使用的LLM提供商名称 - * - ``llmLogLevel`` + * - ``llm_log_level`` - 否 - LLM相关包的日志级别 @@ -317,29 +316,29 @@ LDAP以及SSO（OpenID Connect、SAML、SPNEGO、Entra ID）相关的设置也 * - 字段 - 说明 - * - ``ldapProviderUrl`` + * - ``ldap_provider_url`` - LDAP连接URL - * - ``ldapBaseDn`` + * - ``ldap_base_dn`` - LDAP基础DN - * - ``ldapSecurityPrincipal`` + * - ``ldap_security_principal`` - 用于LDAP绑定的安全主体 - * - ``ldapAdminSecurityPrincipal`` + * - ``ldap_admin_security_principal`` - 用于LDAP管理操作的安全主体 - * - ``ldapAdminSecurityCredentials`` - - LDAP管理员密码（在响应中替换为 ``null``） - * - ``ldapAccountFilter`` / ``ldapGroupFilter`` + * - ``ldap_admin_security_credentials`` + - LDAP管理员密码（不包含在响应中） + * - ``ldap_account_filter`` / ``ldap_group_filter`` - 用户/组搜索过滤器 - * - ``ldapMemberofAttribute`` + * - ``ldap_memberof_attribute`` - 表示组成员关系的LDAP属性名 - * - ``ssoType`` + * - ``sso_type`` - SSO类型（``none`` / ``oic`` / ``saml`` / ``spnego`` / ``entraid``） - * - ``oicClientId`` / ``oicClientSecret`` / ``oicAuthServerUrl`` 等 + * - ``oic_client_id`` / ``oic_client_secret`` / ``oic_auth_server_url`` 等 - OpenID Connect的设置 - * - ``samlIdpEntityid`` / ``samlSpEntityid`` 等 + * - ``saml_idp_entityid`` / ``saml_sp_entityid`` 等 - SAML的设置 - * - ``spnegoKrb5Conf`` / ``spnegoLoginConf`` 等 + * - ``spnego_krb5_conf`` / ``spnego_login_conf`` 等 - SPNEGO的设置 - * - ``entraidClientId`` / ``entraidTenant`` 等 + * - ``entraid_client_id`` / ``entraid_tenant`` 等 - Microsoft Entra ID的设置 存储相关字段 @@ -353,24 +352,24 @@ LDAP以及SSO（OpenID Connect、SAML、SPNEGO、Entra ID）相关的设置也 * - 字段 - 说明 - * - ``storageType`` + * - ``storage_type`` - 存储类型（``auto`` / ``s3`` / ``gcs``） - * - ``storageEndpoint`` + * - ``storage_endpoint`` - 存储的端点URL - * - ``storageAccessKey`` / ``storageSecretKey`` + * - ``storage_access_key`` / ``storage_secret_key`` - 用于认证的访问密钥/私密密钥 - * - ``storageBucket`` + * - ``storage_bucket`` - 存储桶名称 - * - ``storageRegion`` + * - ``storage_region`` - S3的区域 - * - ``storageProjectId`` / ``storageCredentialsPath`` + * - ``storage_project_id`` / ``storage_credentials_path`` - GCS的项目ID / 凭据文件路径 .. note:: - ``ldapAdminSecurityCredentials``、``storageAccessKey`` / ``storageSecretKey``、 - ``oicClientId`` / ``oicClientSecret``、``entraidClientId`` / ``entraidClientSecret``、 - ``spnegoPreauthPassword`` 等机密字段，如果将掩码值 ``"**********"`` 原样发送， + ``ldap_admin_security_credentials``、``storage_access_key`` / ``storage_secret_key``、 + ``oic_client_id`` / ``oic_client_secret``、``entraid_client_id`` / ``entraid_client_secret``、 + ``spnego_preauth_password`` 等机密字段，如果将掩码值 ``"**********"`` 原样发送， 该值不会被更新，已保存的值将继续保留。只有在需要更改时，才发送实际值。 由于此判断基于去除星号后的字符串是否为空，发送空字符串（``""``）或仅由星号 @@ -399,8 +398,8 @@ LDAP以及SSO（OpenID Connect、SAML、SPNEGO、Entra ID）相关的设置也 .. note:: - 以下示例包含必需字段（``dayForCleanup``、``crawlingThreadCount``、 - ``failureCountThreshold``、``csvFileEncoding``）。由于这些字段无论修改内容如何 + 以下示例包含必需字段（``day_for_cleanup``、``crawling_thread_count``、 + ``failure_count_threshold``、``csv_file_encoding``）。由于这些字段无论修改内容如何 都必须始终发送，实际操作中请通过 ``GET`` 获取当前值后再包含这些字段 （以下示例使用默认值）。 @@ -413,11 +412,11 @@ LDAP以及SSO（OpenID Connect、SAML、SPNEGO、Entra ID）相关的设置也 -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "incrementalCrawling": "true", - "crawlingThreadCount": 10, - "failureCountThreshold": 100, - "dayForCleanup": -1, - "csvFileEncoding": "UTF-8" + "incremental_crawling": "true", + "crawling_thread_count": 10, + "failure_count_threshold": 100, + "day_for_cleanup": -1, + "csv_file_encoding": "UTF-8" }' 更新日志保留期限 @@ -429,13 +428,13 @@ LDAP以及SSO（OpenID Connect、SAML、SPNEGO、Entra ID）相关的设置也 -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "dayForCleanup": -1, - "crawlingThreadCount": 5, - "failureCountThreshold": -1, - "csvFileEncoding": "UTF-8", - "purgeSearchLogDay": 90, - "purgeJobLogDay": 90, - "purgeUserInfoDay": 90 + "day_for_cleanup": -1, + "crawling_thread_count": 5, + "failure_count_threshold": -1, + "csv_file_encoding": "UTF-8", + "purge_search_log_day": 90, + "purge_job_log_day": 90, + "purge_user_info_day": 90 }' 更新建议设置 @@ -447,12 +446,12 @@ LDAP以及SSO（OpenID Connect、SAML、SPNEGO、Entra ID）相关的设置也 -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "dayForCleanup": -1, - "crawlingThreadCount": 5, - "failureCountThreshold": -1, - "csvFileEncoding": "UTF-8", - "suggestSearchLog": "true", - "suggestDocuments": "true" + "day_for_cleanup": -1, + "crawling_thread_count": 5, + "failure_count_threshold": -1, + "csv_file_encoding": "UTF-8", + "suggest_search_log": "true", + "suggest_documents": "true" }' 参考信息 diff --git a/zh-cn/15.9/api/admin/api-admin-group.rst b/zh-cn/15.9/api/admin/api-admin-group.rst index 5ef0e8b55..2607ee063 100644 --- a/zh-cn/15.9/api/admin/api-admin-group.rst +++ b/zh-cn/15.9/api/admin/api-admin-group.rst @@ -90,7 +90,7 @@ Group API是用于管理 |Fess| 组的API。 "attributes": { "gidNumber": "1000" }, - "versionNo": 1 + "version_no": 1 }, { "id": "group_id_2", @@ -98,7 +98,7 @@ Group API是用于管理 |Fess| 组的API。 "attributes": { "gidNumber": "1001" }, - "versionNo": 1 + "version_no": 1 } ], "total": 5 @@ -129,7 +129,7 @@ Group API是用于管理 |Fess| 组的API。 "attributes": { "gidNumber": "1000" }, - "versionNo": 1 + "version_no": 1 } } } @@ -209,7 +209,7 @@ Group API是用于管理 |Fess| 组的API。 "attributes": { "gidNumber": "1002" }, - "versionNo": 1 + "version_no": 1 } 字段说明 @@ -231,9 +231,9 @@ Group API是用于管理 |Fess| 组的API。 * - ``attributes`` - 否 - 属性的映射（包含 ``gidNumber`` 等LDAP属性）。值以字符串指定 - * - ``versionNo`` + * - ``version_no`` - 是 - - 乐观锁的版本号。指定从获取组获得的 ``versionNo`` 值 + - 乐观锁的版本号。指定从获取组获得的 ``version_no`` 值 响应 ---- 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 28ff75ddd..f4f6adc81 100644 --- a/zh-cn/15.9/api/admin/api-admin-joblog.rst +++ b/zh-cn/15.9/api/admin/api-admin-joblog.rst @@ -80,25 +80,25 @@ JobLog API是用于查看和管理 |Fess| 作业执行日志的API。 "logs": [ { "id": "joblog_id_1", - "jobName": "Default Crawler", - "jobStatus": "ok", + "job_name": "Default Crawler", + "job_status": "ok", "target": "all", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "scriptResult": "Job completed successfully", - "startTime": "1738116000000", - "endTime": "1738118723000" + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "script_result": "Job completed successfully", + "start_time": "1738116000000", + "end_time": "1738118723000" }, { "id": "joblog_id_2", - "jobName": "Default Crawler", - "jobStatus": "fail", + "job_name": "Default Crawler", + "job_status": "fail", "target": "all", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "scriptResult": "Error: Connection timeout", - "startTime": "1738029600000", - "endTime": "1738030215000" + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "script_result": "Error: Connection timeout", + "start_time": "1738029600000", + "end_time": "1738030215000" } ], "total": 100 @@ -116,26 +116,26 @@ JobLog API是用于查看和管理 |Fess| 作业执行日志的API。 - 说明 * - ``id`` - 作业日志ID - * - ``jobName`` + * - ``job_name`` - 作业名称 - * - ``jobStatus`` + * - ``job_status`` - 作业状态（``ok``: 成功、``fail``: 失败、``running``: 执行中） * - ``target`` - 执行目标（调度器的目标名称，默认值为 ``all``） - * - ``scriptType`` + * - ``script_type`` - 脚本类型（例: ``javascript``） - * - ``scriptData`` + * - ``script_data`` - 执行脚本 - * - ``scriptResult`` + * - ``script_result`` - 执行结果 - * - ``startTime`` + * - ``start_time`` - 开始时刻（epoch毫秒；以字符串形式返回） - * - ``endTime`` + * - ``end_time`` - 结束时刻（epoch毫秒；以字符串形式返回）。执行中的作业不返回此字段。 .. note:: - 响应中每个日志对象还包含一个内部字段 ``crudMode`` + 响应中每个日志对象还包含一个内部字段 ``crud_mode`` （表示CRUD操作模式的整数值，在读取操作时始终为 ``0``）。 客户端可安全忽略此字段。 @@ -159,14 +159,14 @@ JobLog API是用于查看和管理 |Fess| 作业执行日志的API。 "status": 0, "log": { "id": "joblog_id_1", - "jobName": "Default Crawler", - "jobStatus": "ok", + "job_name": "Default Crawler", + "job_status": "ok", "target": "all", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "scriptResult": "Crawl completed successfully.\nDocuments indexed: 1234\nDocuments updated: 567\nDocuments deleted: 12\nErrors: 0", - "startTime": "1738116000000", - "endTime": "1738118723000" + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "script_result": "Crawl completed successfully.\nDocuments indexed: 1234\nDocuments updated: 567\nDocuments deleted: 12\nErrors: 0", + "start_time": "1738116000000", + "end_time": "1738118723000" } } } diff --git a/zh-cn/15.9/api/admin/api-admin-keymatch.rst b/zh-cn/15.9/api/admin/api-admin-keymatch.rst index 555f9aafb..2b4dcee66 100644 --- a/zh-cn/15.9/api/admin/api-admin-keymatch.rst +++ b/zh-cn/15.9/api/admin/api-admin-keymatch.rst @@ -92,9 +92,9 @@ KeyMatch API是用于管理 |Fess| 关键词匹配（搜索关键词与结果的 "id": "keymatch_id_1", "term": "download", "query": "title:download OR content:download", - "maxSize": 10, + "max_size": 10, "boost": 10.0, - "versionNo": 1 + "version_no": 1 } ], "total": 5 @@ -104,8 +104,8 @@ KeyMatch API是用于管理 |Fess| 关键词匹配（搜索关键词与结果的 .. note:: ``total`` 中设置的是符合筛选条件的总记录数（而非当前页的记录数）。 - 各设置对象除上述字段外，若有值则还会包含 ``virtualHost`` 、 - ``createdBy`` 、 ``createdTime`` 、 ``updatedBy`` 、 ``updatedTime`` 。 + 各设置对象除上述字段外，若有值则还会包含 ``virtual_host`` 、 + ``created_by`` 、 ``created_time`` 、 ``updated_by`` 、 ``updated_time`` 。 获取关键词匹配 ============== @@ -129,21 +129,21 @@ KeyMatch API是用于管理 |Fess| 关键词匹配（搜索关键词与结果的 "id": "keymatch_id_1", "term": "download", "query": "title:download OR content:download", - "maxSize": 10, + "max_size": 10, "boost": 10.0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } .. note:: - ``versionNo`` 是用于乐观锁的版本号。更新关键词匹配时，请在请求体中指定获取时得到的 - ``versionNo`` 。若指定的ID不存在，则返回错误。 + ``version_no`` 是用于乐观锁的版本号。更新关键词匹配时，请在请求体中指定获取时得到的 + ``version_no`` 。若指定的ID不存在，则返回错误。 创建关键词匹配 ============== @@ -164,7 +164,7 @@ KeyMatch API是用于管理 |Fess| 关键词匹配（搜索关键词与结果的 { "term": "pricing", "query": "url:*/pricing* OR title:pricing", - "maxSize": 5, + "max_size": 5, "boost": 20.0 } @@ -187,7 +187,7 @@ KeyMatch API是用于管理 |Fess| 关键词匹配（搜索关键词与结果的 - String - 是 - 匹配条件查询（最大长度取决于 ``form.admin.max.input.size`` 的设置值） - * - ``maxSize`` + * - ``max_size`` - Integer - 是 - 最大显示数量（0以上的整数，管理界面初始值为10） @@ -195,16 +195,16 @@ KeyMatch API是用于管理 |Fess| 关键词匹配（搜索关键词与结果的 - Float - 是 - 提升值（管理界面初始值为100.0） - * - ``virtualHost`` + * - ``virtual_host`` - String - 否 - 虚拟主机名（最大1000个字符，用于按虚拟主机切换关键词匹配时指定） .. note:: - ``maxSize`` 和 ``boost`` 在通过API调用时为必填项。初始值是管理界面表单中显示的值， + ``max_size`` 和 ``boost`` 在通过API调用时为必填项。初始值是管理界面表单中显示的值， 不适用于API。若省略则会返回验证错误。 - 另外，即使在请求中指定了 ``createdBy`` 和 ``createdTime`` ，服务器端也会将其覆盖。 + 另外，即使在请求中指定了 ``created_by`` 和 ``created_time`` ，服务器端也会将其覆盖。 响应 ---- @@ -239,15 +239,15 @@ KeyMatch API是用于管理 |Fess| 关键词匹配（搜索关键词与结果的 "id": "existing_keymatch_id", "term": "pricing", "query": "url:*/pricing* OR title:pricing OR content:price", - "maxSize": 10, + "max_size": 10, "boost": 15.0, - "versionNo": 1 + "version_no": 1 } 字段说明 ~~~~~~~~ -在创建时的字段（ ``term`` 、 ``query`` 、 ``maxSize`` 、 ``boost`` 、 ``virtualHost`` ）基础上， +在创建时的字段（ ``term`` 、 ``query`` 、 ``max_size`` 、 ``boost`` 、 ``virtual_host`` ）基础上， 还需指定以下字段。 .. list-table:: @@ -262,7 +262,7 @@ KeyMatch API是用于管理 |Fess| 关键词匹配（搜索关键词与结果的 - String - 是 - 待更新的关键词匹配ID（最大1000个字符） - * - ``versionNo`` + * - ``version_no`` - Integer - 是 - 乐观锁用版本号，请指定获取时得到的值 @@ -315,7 +315,7 @@ KeyMatch API是用于管理 |Fess| 关键词匹配（搜索关键词与结果的 -d '{ "term": "product features", "query": "url:*/products/* AND (title:features OR content:features)", - "maxSize": 10, + "max_size": 10, "boost": 15.0 }' @@ -330,7 +330,7 @@ KeyMatch API是用于管理 |Fess| 关键词匹配（搜索关键词与结果的 -d '{ "term": "help", "query": "url:*/support/* OR url:*/help/* OR url:*/faq/*", - "maxSize": 5, + "max_size": 5, "boost": 20.0 }' 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 062225cc9..f64960f10 100644 --- a/zh-cn/15.9/api/admin/api-admin-labeltype.rst +++ b/zh-cn/15.9/api/admin/api-admin-labeltype.rst @@ -99,16 +99,16 @@ HTTP状态码等），请参阅 :doc:`api-admin-overview`。 "id": "label_id_1", "name": "Documentation", "value": "docs", - "includedPaths": ".*docs\\.example\\.com.*", - "excludedPaths": "", + "included_paths": ".*docs\\.example\\.com.*", + "excluded_paths": "", "permissions": "{role}admin", - "virtualHost": "", - "sortOrder": 0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_host": "", + "sort_order": 0, + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } ], "total": 5 @@ -117,8 +117,8 @@ HTTP状态码等），请参阅 :doc:`api-admin-overview`。 .. note:: - 每个设置对象中还包含用于审计的 ``createdBy`` / ``createdTime`` / ``updatedBy`` / - ``updatedTime``，以及用于乐观锁的 ``versionNo``\ （值为 ``null`` 的 + 每个设置对象中还包含用于审计的 ``created_by`` / ``created_time`` / ``updated_by`` / + ``updated_time``，以及用于乐观锁的 ``version_no``\ （值为 ``null`` 的 字段将被省略）。\ ``response`` 对象中始终包含表示产品版本的 ``version``，但为简洁起见，后续示例中可能省略该字段。 @@ -144,16 +144,16 @@ HTTP状态码等），请参阅 :doc:`api-admin-overview`。 "id": "label_id_1", "name": "Documentation", "value": "docs", - "includedPaths": ".*docs\\.example\\.com.*", - "excludedPaths": "", + "included_paths": ".*docs\\.example\\.com.*", + "excluded_paths": "", "permissions": "{role}admin", - "virtualHost": "", - "sortOrder": 0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_host": "", + "sort_order": 0, + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } @@ -177,9 +177,9 @@ HTTP状态码等），请参阅 :doc:`api-admin-overview`。 { "name": "News", "value": "news", - "includedPaths": ".*news\\.example\\.com.*\n.*example\\.com/news/.*", - "excludedPaths": ".*/(archive|old)/.*", - "sortOrder": 1, + "included_paths": ".*news\\.example\\.com.*\n.*example\\.com/news/.*", + "excluded_paths": ".*/(archive|old)/.*", + "sort_order": 1, "permissions": "{role}guest" } @@ -202,11 +202,11 @@ HTTP状态码等），请参阅 :doc:`api-admin-overview`。 - String - 是 - 标签值（搜索时通过 ``label`` 参数使用）。只能使用半角英数字和下划线（``_``），且须符合正则表达式 ``^[a-zA-Z0-9_]+$``\ （最多100个字符）。 - * - ``includedPaths`` + * - ``included_paths`` - String - 否 - 作为标签目标的路径正则表达式。指定多个时用换行符（``\n``）分隔。 - * - ``excludedPaths`` + * - ``excluded_paths`` - String - 否 - 从标签目标中排除的路径正则表达式。指定多个时用换行符（``\n``）分隔。 @@ -214,18 +214,18 @@ HTTP状态码等），请参阅 :doc:`api-admin-overview`。 - String - 否 - 允许访问的角色/组/用户（例如：``{role}admin``）。指定多个时用换行符（``\n``）分隔。 - * - ``sortOrder`` + * - ``sort_order`` - Integer - 否 - 显示顺序（0以上的整数）。未指定时默认为 ``0``\ 。 - * - ``virtualHost`` + * - ``virtual_host`` - String - 否 - 虚拟主机（最多1000个字符）。 .. note:: - ``createdBy`` / ``createdTime`` 等审计字段由服务器端自动设置， + ``created_by`` / ``created_time`` 等审计字段由服务器端自动设置， 无需在请求中指定。 响应 @@ -263,11 +263,11 @@ HTTP状态码等），请参阅 :doc:`api-admin-overview`。 "id": "existing_label_id", "name": "News Articles", "value": "news", - "includedPaths": ".*news\\.example\\.com.*\n.*example\\.com/(news|articles)/.*", - "excludedPaths": ".*/(archive|old|draft)/.*", - "sortOrder": 1, + "included_paths": ".*news\\.example\\.com.*\n.*example\\.com/(news|articles)/.*", + "excluded_paths": ".*/(archive|old|draft)/.*", + "sort_order": 1, "permissions": "{role}guest", - "versionNo": 1 + "version_no": 1 } 更新时，除创建时的字段外，还需要以下必填字段。 @@ -284,10 +284,10 @@ HTTP状态码等），请参阅 :doc:`api-admin-overview`。 - String - 是 - 要更新的标签类型ID。 - * - ``versionNo`` + * - ``version_no`` - Integer - 是 - - 用于乐观锁的版本号。请指定获取时响应中包含的 ``versionNo``\ 。若指定的版本与当前版本不一致，更新将失败。 + - 用于乐观锁的版本号。请指定获取时响应中包含的 ``version_no``\ 。若指定的版本与当前版本不一致，更新将失败。 响应 ---- @@ -339,8 +339,8 @@ HTTP状态码等），请参阅 :doc:`api-admin-overview`。 -d '{ "name": "Technical Documentation", "value": "tech_docs", - "includedPaths": ".*docs\\.example\\.com.*\n.*example\\.com/documentation/.*", - "sortOrder": 0, + "included_paths": ".*docs\\.example\\.com.*\n.*example\\.com/documentation/.*", + "sort_order": 0, "permissions": "{role}guest" }' 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 56209933b..1765522d7 100644 --- a/zh-cn/15.9/api/admin/api-admin-overview.rst +++ b/zh-cn/15.9/api/admin/api-admin-overview.rst @@ -514,22 +514,22 @@ Admin API在大多数情况下返回 HTTP 状态 ``200``，处理结果通过响 -d '{ "name": "Example Site", "urls": "https://example.com/", - "includedUrls": ".*example.com.*", - "excludedUrls": "", - "userAgent": "Mozilla/5.0 (compatible; Fess)", - "numOfThread": 1, - "intervalTime": 1000, + "included_urls": ".*example.com.*", + "excluded_urls": "", + "user_agent": "Mozilla/5.0 (compatible; Fess)", + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, - "maxAccessCount": 1000, + "max_access_count": 1000, "depth": 3, - "sortOrder": 1, + "sort_order": 1, "available": "true" }' .. note:: - 创建Web爬虫设置时，``name``、``urls``、``userAgent``、``numOfThread``、 - ``intervalTime``、``boost``、``available``、``sortOrder`` 为必填项。如果省略 + 创建Web爬虫设置时，``name``、``urls``、``user_agent``、``num_of_thread``、 + ``interval_time``、``boost``、``available``、``sort_order`` 为必填项。如果省略 这些字段，将产生验证错误（``status: 1``）。\ ``available`` 以字符串指定， 设置为 ``"true"`` 或 ``"false"``\ 。 diff --git a/zh-cn/15.9/api/admin/api-admin-relatedcontent.rst b/zh-cn/15.9/api/admin/api-admin-relatedcontent.rst index 61f125b47..52d64e4d7 100644 --- a/zh-cn/15.9/api/admin/api-admin-relatedcontent.rst +++ b/zh-cn/15.9/api/admin/api-admin-relatedcontent.rst @@ -93,13 +93,13 @@ RelatedContent API是用于管理 |Fess| 相关内容的API。 "id": "content_id_1", "term": "fess", "content": "
Fess is an open source search server.
", - "virtualHost": "", - "sortOrder": 0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_host": "", + "sort_order": 0, + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } ], "total": 5 @@ -109,10 +109,10 @@ RelatedContent API是用于管理 |Fess| 相关内容的API。 .. note:: ``settings`` 的各元素以及单个获取端点返回的 ``setting`` 对象中，包含所存储实体的字段原始值。除 - ``term``、``content``、``sortOrder``、``virtualHost`` 之外，审计字段 - ``createdBy``、``createdTime``、``updatedBy``、``updatedTime`` 以及 - 乐观锁字段 ``versionNo`` 也会一并返回。\ ``createdTime`` 和 - ``updatedTime`` 以自纪元以来的毫秒数（数值）表示。未设置（null）的字段 + ``term``、``content``、``sort_order``、``virtual_host`` 之外，审计字段 + ``created_by``、``created_time``、``updated_by``、``updated_time`` 以及 + 乐观锁字段 ``version_no`` 也会一并返回。\ ``created_time`` 和 + ``updated_time`` 以自纪元以来的毫秒数（数值）表示。未设置（null）的字段 将从响应中省略。此外，所有响应的 ``response`` 对象中始终包含表示 产品版本的 ``version``\ （详情请参阅 :doc:`api-admin-overview`）。 @@ -139,20 +139,20 @@ RelatedContent API是用于管理 |Fess| 相关内容的API。 "id": "content_id_1", "term": "fess", "content": "
Fess is an open source search server.
", - "virtualHost": "", - "sortOrder": 0, - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_host": "", + "sort_order": 0, + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } .. note:: - 更新（PUT）时所需的 ``versionNo``，请指定此获取响应中包含的值。 + 更新（PUT）时所需的 ``version_no``，请指定此获取响应中包含的值。 创建相关内容 ============ @@ -173,8 +173,8 @@ RelatedContent API是用于管理 |Fess| 相关内容的API。 { "term": "search", "content": "

About Search

Learn more about search features...

", - "sortOrder": 0, - "virtualHost": "" + "sort_order": 0, + "virtual_host": "" } 字段说明 @@ -193,10 +193,10 @@ RelatedContent API是用于管理 |Fess| 相关内容的API。 * - ``content`` - 是 - 要显示的HTML内容（最多10000个字符） - * - ``sortOrder`` + * - ``sort_order`` - 否 - 显示顺序（0到2147483647之间的整数） - * - ``virtualHost`` + * - ``virtual_host`` - 否 - 虚拟主机（最多1000个字符） @@ -234,9 +234,9 @@ RelatedContent API是用于管理 |Fess| 相关内容的API。 "id": "existing_content_id", "term": "search", "content": "

About Search

Updated information...

", - "sortOrder": 0, - "virtualHost": "", - "versionNo": 1 + "sort_order": 0, + "virtual_host": "", + "version_no": 1 } 字段说明 @@ -258,13 +258,13 @@ RelatedContent API是用于管理 |Fess| 相关内容的API。 * - ``content`` - 是 - 要显示的HTML内容（最多10000个字符） - * - ``sortOrder`` + * - ``sort_order`` - 否 - 显示顺序（0到2147483647之间的整数） - * - ``virtualHost`` + * - ``virtual_host`` - 否 - 虚拟主机（最多1000个字符） - * - ``versionNo`` + * - ``version_no`` - 是 - 乐观锁用的版本号。请指定 ``setting/{id}`` 响应中包含的值。 @@ -284,8 +284,8 @@ RelatedContent API是用于管理 |Fess| 相关内容的API。 .. note:: - 即使在请求体中包含 ``createdBy``、``createdTime``、``updatedBy``、 - ``updatedTime`` 等审计字段以及 ``crudMode``，由于这些字段在服务器端 + 即使在请求体中包含 ``created_by``、``created_time``、``updated_by``、 + ``updated_time`` 等审计字段以及 ``crud_mode``，由于这些字段在服务器端 自动设置，因此会被忽略。创建或更新时无需指定这些字段。 删除相关内容 @@ -324,7 +324,7 @@ RelatedContent API是用于管理 |Fess| 相关内容的API。 -d '{ "term": "product", "content": "

Our Products

", - "sortOrder": 0 + "sort_order": 0 }' 支持信息相关内容 @@ -338,7 +338,7 @@ RelatedContent API是用于管理 |Fess| 相关内容的API。 -d '{ "term": "support", "content": "

Need help? Contact: support@example.com

", - "sortOrder": 0 + "sort_order": 0 }' 参考信息 diff --git a/zh-cn/15.9/api/admin/api-admin-relatedquery.rst b/zh-cn/15.9/api/admin/api-admin-relatedquery.rst index 723a2e95b..cacb79632 100644 --- a/zh-cn/15.9/api/admin/api-admin-relatedquery.rst +++ b/zh-cn/15.9/api/admin/api-admin-relatedquery.rst @@ -89,7 +89,7 @@ RelatedQuery API是用于管理 |Fess| 相关查询的API。 "id": "query_id_1", "term": "fess", "queries": "fess tutorial\nfess installation\nfess configuration", - "versionNo": 1 + "version_no": 1 } ], "total": 5 @@ -98,9 +98,9 @@ RelatedQuery API是用于管理 |Fess| 相关查询的API。 .. note:: - 每条设置均包含 ``versionNo``\ （用于乐观锁的版本号）。\ ``virtualHost`` - 以及审计字段（``createdBy``、``createdTime``、``updatedBy``、``updatedTime``） - 仅在有值时才会包含在响应中。值为空的 ``virtualHost`` 不会包含在响应中。 + 每条设置均包含 ``version_no``\ （用于乐观锁的版本号）。\ ``virtual_host`` + 以及审计字段（``created_by``、``created_time``、``updated_by``、``updated_time``） + 仅在有值时才会包含在响应中。值为空的 ``virtual_host`` 不会包含在响应中。 获取相关查询 ============ @@ -125,8 +125,8 @@ RelatedQuery API是用于管理 |Fess| 相关查询的API。 "id": "query_id_1", "term": "fess", "queries": "fess tutorial\nfess installation\nfess configuration", - "virtualHost": "site1.example.com", - "versionNo": 1 + "virtual_host": "site1.example.com", + "version_no": 1 } } } @@ -150,7 +150,7 @@ RelatedQuery API是用于管理 |Fess| 相关查询的API。 { "term": "search", "queries": "search tutorial\nsearch syntax\nadvanced search", - "virtualHost": "" + "virtual_host": "" } 字段说明 @@ -169,13 +169,13 @@ RelatedQuery API是用于管理 |Fess| 相关查询的API。 * - ``queries`` - 是 - 相关查询。每行一条，以换行符分隔的字符串（空行将被忽略。最多10000个字符） - * - ``virtualHost`` + * - ``virtual_host`` - 否 - 虚拟主机（最多1000个字符） .. note:: - ``crudMode`` 由API端自动设置，无需包含在请求体中。 + ``crud_mode`` 由API端自动设置，无需包含在请求体中。 响应 ---- @@ -211,8 +211,8 @@ RelatedQuery API是用于管理 |Fess| 相关查询的API。 "id": "existing_query_id", "term": "search", "queries": "search tutorial\nsearch syntax\nadvanced search\nsearch tips", - "virtualHost": "", - "versionNo": 1 + "virtual_host": "", + "version_no": 1 } 字段说明 @@ -234,10 +234,10 @@ RelatedQuery API是用于管理 |Fess| 相关查询的API。 * - ``queries`` - 是 - 相关查询。每行一条，以换行符分隔的字符串（空行将被忽略。最多10000个字符） - * - ``virtualHost`` + * - ``virtual_host`` - 否 - 虚拟主机（最多1000个字符） - * - ``versionNo`` + * - ``version_no`` - 是 - 用于乐观锁的版本号。请指定获取时响应中包含的值 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 475d8772e..00da78cc6 100644 --- a/zh-cn/15.9/api/admin/api-admin-role.rst +++ b/zh-cn/15.9/api/admin/api-admin-role.rst @@ -87,12 +87,12 @@ Role API是用于管理 |Fess| 角色的API。 { "id": "role_id_1", "name": "admin", - "versionNo": 1 + "version_no": 1 }, { "id": "role_id_2", "name": "user", - "versionNo": 1 + "version_no": 1 } ], "total": 5 @@ -120,7 +120,7 @@ Role API是用于管理 |Fess| 角色的API。 "setting": { "id": "role_id_1", "name": "admin", - "versionNo": 1 + "version_no": 1 } } } @@ -194,7 +194,7 @@ Role API是用于管理 |Fess| 角色的API。 { "id": "existing_role_id", "name": "editor_updated", - "versionNo": 1 + "version_no": 1 } 字段说明 @@ -216,9 +216,9 @@ Role API是用于管理 |Fess| 角色的API。 * - ``attributes`` - 否 - 属性的映射。值以字符串指定 - * - ``versionNo`` + * - ``version_no`` - 是 - - 乐观锁的版本号。指定从获取角色获得的 ``versionNo`` 值 + - 乐观锁的版本号。指定从获取角色获得的 ``version_no`` 值 响应 ---- diff --git a/zh-cn/15.9/api/admin/api-admin-scheduler.rst b/zh-cn/15.9/api/admin/api-admin-scheduler.rst index 9793b59a6..84e008534 100644 --- a/zh-cn/15.9/api/admin/api-admin-scheduler.rst +++ b/zh-cn/15.9/api/admin/api-admin-scheduler.rst @@ -91,14 +91,14 @@ Scheduler API是用于管理 |Fess| 计划任务的API。 "id": "job_id_1", "name": "Default Crawler", "target": "all", - "cronExpression": "0 0 0 * * ?", - "scriptType": "javascript", - "scriptData": "...", - "jobLogging": "true", + "cron_expression": "0 0 0 * * ?", + "script_type": "javascript", + "script_data": "...", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 0, - "versionNo": 1, + "sort_order": 0, + "version_no": 1, "running": false } ], @@ -112,7 +112,7 @@ Scheduler API是用于管理 |Fess| 计划任务的API。 .. note:: - 响应中的 ``jobLogging`` / ``crawler`` / ``available`` 以字符串（``"true"`` / ``"false"``）形式返回。\ ``running`` 为布尔值，是仅响应中包含的字段，表示任务当前是否正在运行（不可在请求中指定）。\ ``total`` 为符合查询条件的任务总数。 + 响应中的 ``job_logging`` / ``crawler`` / ``available`` 以字符串（``"true"`` / ``"false"``）形式返回。\ ``running`` 为布尔值，是仅响应中包含的字段，表示任务当前是否正在运行（不可在请求中指定）。\ ``total`` 为符合查询条件的任务总数。 获取计划任务 ============ @@ -136,14 +136,14 @@ Scheduler API是用于管理 |Fess| 计划任务的API。 "id": "job_id_1", "name": "Default Crawler", "target": "all", - "cronExpression": "0 0 0 * * ?", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "jobLogging": "true", + "cron_expression": "0 0 0 * * ?", + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 0, - "versionNo": 1, + "sort_order": 0, + "version_no": 1, "running": false } } @@ -168,13 +168,13 @@ Scheduler API是用于管理 |Fess| 计划任务的API。 { "name": "Daily Crawler", "target": "all", - "cronExpression": "0 0 2 * * ?", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "jobLogging": "true", + "cron_expression": "0 0 2 * * ?", + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 1 + "sort_order": 1 } 字段说明 @@ -193,16 +193,16 @@ Scheduler API是用于管理 |Fess| 计划任务的API。 * - ``target`` - 是 - 执行目标（最大100字符）。指定 ``all`` 或特定目标名称 - * - ``cronExpression`` + * - ``cron_expression`` - 否 - Cron表达式（秒 分 时 日 月 星期）。最大100字符，将作为Cron表达式进行验证。若为空，则不进行定时执行，只能手动启动 - * - ``scriptType`` + * - ``script_type`` - 是 - 脚本类型（最大100字符）。可指定 ``javascript`` （新建作业的默认值，由 ``job.default.script`` 属性决定）或 ``groovy`` （需要 ``fess-script-groovy`` 插件） - * - ``scriptData`` + * - ``script_data`` - 否 - 执行脚本。最大大小遵循 ``fess_config.properties`` 中的 ``form.admin.max.input.size`` - * - ``jobLogging`` + * - ``job_logging`` - 否 - 启用任务日志记录（字符串） * - ``crawler`` @@ -211,17 +211,17 @@ Scheduler API是用于管理 |Fess| 计划任务的API。 * - ``available`` - 否 - 启用/禁用（字符串） - * - ``sortOrder`` + * - ``sort_order`` - 是 - 显示顺序（0～2147483647之间的整数） .. note:: - ``jobLogging`` / ``crawler`` / ``available`` 为字符串字段。在请求中，指定 ``"on"`` 或 ``"true"``\ （不区分大小写）时启用；其他值（``"false"``、空字符串或未指定）均视为禁用。在响应中以 ``"true"`` / ``"false"`` 形式返回。 + ``job_logging`` / ``crawler`` / ``available`` 为字符串字段。在请求中，指定 ``"on"`` 或 ``"true"``\ （不区分大小写）时启用；其他值（``"false"``、空字符串或未指定）均视为禁用。在响应中以 ``"true"`` / ``"false"`` 形式返回。 .. note:: - ``crudMode`` 由服务器端自动设置，无需在请求中指定。\ ``createdBy`` / ``createdTime`` 等审计字段也由服务器端设置。 + ``crud_mode`` 由服务器端自动设置，无需在请求中指定。\ ``created_by`` / ``created_time`` 等审计字段也由服务器端设置。 响应 ---- @@ -274,19 +274,19 @@ Cron表达式示例 "id": "existing_job_id", "name": "Updated Crawler", "target": "all", - "cronExpression": "0 0 3 * * ?", - "scriptType": "javascript", - "scriptData": "...", - "jobLogging": "true", + "cron_expression": "0 0 3 * * ?", + "script_type": "javascript", + "script_data": "...", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 1, - "versionNo": 1 + "sort_order": 1, + "version_no": 1 } .. note:: - 更新时，``id``\ （最大1000字符）和 ``versionNo`` 为必填项。\ ``versionNo`` 用于乐观锁，需指定获取响应中返回的值。若值不匹配，更新将失败。其他必填字段（``name`` / ``target`` / ``scriptType`` / ``sortOrder``）与创建时相同。 + 更新时，``id``\ （最大1000字符）和 ``version_no`` 为必填项。\ ``version_no`` 用于乐观锁，需指定获取响应中返回的值。若值不匹配，更新将失败。其他必填字段（``name`` / ``target`` / ``script_type`` / ``sort_order``）与创建时相同。 响应 ---- @@ -344,7 +344,7 @@ Cron表达式示例 { "response": { "status": 0, - "jobLogId": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6" + "job_log_id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6" } } @@ -357,15 +357,15 @@ Cron表达式示例 * - 字段 - 说明 - * - ``jobLogId`` - - 已启动任务的任务日志ID。在任务日志启用时发行。任务日志禁用时为 ``null``\ 。 + * - ``job_log_id`` + - 已启动任务的任务日志ID。在任务日志启用时发行。任务日志禁用时不包含在响应中。 注意事项 -------- - 如果任务已在运行中，启动将失败并返回错误（``status`` 非 ``0``）。 - 如果任务已禁用（``available`` 未启用），同样将启动失败并返回错误。 -- ``jobLogId`` 仅在任务日志已启用（``jobLogging`` 已启用）时才会发行。 +- ``job_log_id`` 仅在任务日志已启用（``job_logging`` 已启用）时才会发行。 停止任务 ======== @@ -405,13 +405,13 @@ Cron表达式示例 -d '{ "name": "Hourly Crawler", "target": "all", - "cronExpression": "0 0 * * * ?", - "scriptType": "javascript", - "scriptData": "return container.getComponent(\"crawlJob\").execute();", - "jobLogging": "true", + "cron_expression": "0 0 * * * ?", + "script_type": "javascript", + "script_data": "return container.getComponent(\"crawlJob\").execute();", + "job_logging": "true", "crawler": "true", "available": "true", - "sortOrder": 1 + "sort_order": 1 }' # 立即执行任务 diff --git a/zh-cn/15.9/api/admin/api-admin-suggest.rst b/zh-cn/15.9/api/admin/api-admin-suggest.rst index ff07d0e1b..f816640f2 100644 --- a/zh-cn/15.9/api/admin/api-admin-suggest.rst +++ b/zh-cn/15.9/api/admin/api-admin-suggest.rst @@ -75,9 +75,9 @@ Suggest API是用于管理 |Fess| 建议功能所使用的建议词的API。 "version": "15.9.0", "status": 0, "setting": { - "totalWordsNum": 1500, - "documentWordsNum": 1200, - "queryWordsNum": 450 + "total_words_num": 1500, + "document_words_num": 1200, + "query_words_num": 450 } } } @@ -91,18 +91,18 @@ Suggest API是用于管理 |Fess| 建议功能所使用的建议词的API。 * - 字段 - 说明 - * - ``setting.totalWordsNum`` + * - ``setting.total_words_num`` - 建议词总数（建议索引中已注册的建议词数量） - * - ``setting.documentWordsNum`` + * - ``setting.document_words_num`` - 来源于文档的建议词数（文档频率在1以上的建议词数量） - * - ``setting.queryWordsNum`` + * - ``setting.query_words_num`` - 来源于搜索查询的建议词数（查询频率在1以上的建议词数量） .. note:: - ``documentWordsNum`` 与 ``queryWordsNum`` 并非互斥。若一个建议词同时来源于文档和搜索查询， - 则会同时计入两者的数量。因此，``documentWordsNum`` 与 ``queryWordsNum`` 的合计值不一定 - 与 ``totalWordsNum`` 相等。 + ``document_words_num`` 与 ``query_words_num`` 并非互斥。若一个建议词同时来源于文档和搜索查询， + 则会同时计入两者的数量。因此，``document_words_num`` 与 ``query_words_num`` 的合计值不一定 + 与 ``total_words_num`` 相等。 删除所有建议词 ============== diff --git a/zh-cn/15.9/api/admin/api-admin-systeminfo.rst b/zh-cn/15.9/api/admin/api-admin-systeminfo.rst index 9b2c98db4..281b1d532 100644 --- a/zh-cn/15.9/api/admin/api-admin-systeminfo.rst +++ b/zh-cn/15.9/api/admin/api-admin-systeminfo.rst @@ -57,22 +57,22 @@ SystemInfo API是用于获取 |Fess| 系统信息的API。 "response": { "version": "15.9.0", "status": 0, - "envProps": [ + "env_props": [ {"label": "JAVA_HOME", "value": "/usr/lib/jvm/java-21"}, {"label": "FESS_DICTIONARY_PATH", "value": "/var/lib/fess/dict"} ], - "systemProps": [ + "system_props": [ {"label": "java.version", "value": "21.0.1"}, {"label": "java.vendor", "value": "Oracle Corporation"}, {"label": "os.name", "value": "Linux"}, {"label": "user.dir", "value": "/opt/fess"} ], - "fessProps": [ + "fess_props": [ {"label": "crawler.document.max.site.length", "value": "100"}, {"label": "indexer.thread.dump.enabled", "value": "true"}, {"label": "app.cipher.key", "value": "XXXXXXXX"} ], - "bugReportProps": [ + "bug_report_props": [ {"label": "os.name", "value": "Linux"}, {"label": "java.vm.version", "value": "21.0.1+12"} ] @@ -92,24 +92,24 @@ SystemInfo API是用于获取 |Fess| 系统信息的API。 - |Fess| 的产品版本（例如：``15.9.0``）。 * - ``status`` - 表示处理结果的状态码。\ ``0`` 表示正常结束。 - * - ``envProps`` + * - ``env_props`` - 环境变量列表（``label`` / ``value`` 的对象数组）。返回通过 ``System.getenv()`` 获取的值，不做任何修改。 - * - ``systemProps`` + * - ``system_props`` - Java系统属性列表（``label`` / ``value`` 的对象数组）。返回通过 ``System.getProperties()`` 获取的值，不做任何修改。 - * - ``fessProps`` + * - ``fess_props`` - |Fess| 配置属性列表（``label`` / ``value`` 的对象数组）。包含 ``fess_config.properties`` 中的配置值以及通过管理界面设置的系统属性。敏感项目将被屏蔽（参见下方注意事项）。 - * - ``bugReportProps`` + * - ``bug_report_props`` - 为错误报告收集的信息列表（``label`` / ``value`` 的对象数组）。包含与OS及Java运行环境相关的主要系统属性（``os.name``、``os.version``、``java.vm.version`` 等）以及 |Fess| 的系统属性设置值。 .. note:: - ``fessProps`` 中，以下敏感配置值将被屏蔽，以 ``XXXXXXXX`` 返回： + ``fess_props`` 中，以下敏感配置值将被屏蔽，以 ``XXXXXXXX`` 返回： ``http.proxy.password``、``ldap.admin.security.credentials``、``spnego.preauth.password``、 ``app.cipher.key``、``oic.client.id``、``oic.client.secret``\ 。 .. warning:: - ``envProps``\ （环境变量）和 ``systemProps``\ （Java系统属性）不会被屏蔽， + ``env_props``\ （环境变量）和 ``system_props``\ （Java系统属性）不会被屏蔽， 其值将原样返回。如果环境变量或系统属性中包含认证信息等敏感数据， 这些信息将出现在响应中，请注意。 diff --git a/zh-cn/15.9/api/admin/api-admin-user.rst b/zh-cn/15.9/api/admin/api-admin-user.rst index e60735128..7017167cb 100644 --- a/zh-cn/15.9/api/admin/api-admin-user.rst +++ b/zh-cn/15.9/api/admin/api-admin-user.rst @@ -105,7 +105,7 @@ User API是用于管理 |Fess| 用户账户的REST API。 }, "roles": ["admin"], "groups": [], - "versionNo": 1 + "version_no": 1 } ], "total": 10 @@ -150,7 +150,7 @@ User API是用于管理 |Fess| 用户账户的REST API。 }, "roles": ["admin"], "groups": [], - "versionNo": 1 + "version_no": 1 } } } @@ -179,7 +179,7 @@ User API是用于管理 |Fess| 用户账户的REST API。 { "name": "testuser", "password": "securepassword", - "confirmPassword": "securepassword", + "confirm_password": "securepassword", "attributes": { "surname": "Test", "givenName": "User", @@ -205,7 +205,7 @@ User API是用于管理 |Fess| 用户账户的REST API。 * - ``password`` - 否 - 密码 - * - ``confirmPassword`` + * - ``confirm_password`` - 否 - 确认密码 * - ``attributes`` @@ -220,8 +220,8 @@ User API是用于管理 |Fess| 用户账户的REST API。 .. note:: - REST API不执行密码必填检查、``password`` 与 ``confirmPassword`` 的一致性检查，以及密码策略验证（这些仅在管理界面中应用）。 - 实际使用中，建议指定有效的 ``password`` 且其值与 ``confirmPassword`` 一致。 + REST API不执行密码必填检查、``password`` 与 ``confirm_password`` 的一致性检查，以及密码策略验证（这些仅在管理界面中应用）。 + 实际使用中，建议指定有效的 ``password`` 且其值与 ``confirm_password`` 一致。 ``attributes`` 的键为用户实体的属性名（源自LDAP的模式项目名）。 常用的键如下： @@ -276,7 +276,7 @@ User API是用于管理 |Fess| 用户账户的REST API。 "id": "existing_user_id", "name": "testuser", "password": "newpassword", - "confirmPassword": "newpassword", + "confirm_password": "newpassword", "attributes": { "surname": "Test", "givenName": "User Updated", @@ -284,7 +284,7 @@ User API是用于管理 |Fess| 用户账户的REST API。 }, "roles": ["user", "editor"], "groups": ["group_id_1", "group_id_2"], - "versionNo": 1 + "version_no": 1 } 字段说明 @@ -303,13 +303,13 @@ User API是用于管理 |Fess| 用户账户的REST API。 * - ``name`` - 是 - 用户名（登录ID） - * - ``versionNo`` + * - ``version_no`` - 是 - 版本号（用于乐观锁） * - ``password`` - 否 - 新密码（仅在指定时更新） - * - ``confirmPassword`` + * - ``confirm_password`` - 否 - 确认密码 * - ``attributes`` @@ -324,8 +324,8 @@ User API是用于管理 |Fess| 用户账户的REST API。 .. note:: - 更新时，``id``、``name`` 和 ``versionNo`` 为必填项。 - ``versionNo`` 是获取目标用户（GET）时返回的值，对应OpenSearch文档的版本号。 + 更新时，``id``、``name`` 和 ``version_no`` 为必填项。 + ``version_no`` 是获取目标用户（GET）时返回的值，对应OpenSearch文档的版本号。 如果与当前版本不匹配，请求将被视为冲突并拒绝更新。 响应 @@ -390,7 +390,7 @@ User API是用于管理 |Fess| 用户账户的REST API。 -d '{ "name": "john.doe", "password": "SecureP@ss123", - "confirmPassword": "SecureP@ss123", + "confirm_password": "SecureP@ss123", "attributes": { "surname": "Doe", "givenName": "John", @@ -412,7 +412,7 @@ User API是用于管理 |Fess| 用户账户的REST API。 "id": "user_id_123", "name": "john.doe", "roles": ["user", "editor", "admin"], - "versionNo": 1 + "version_no": 1 }' 参考信息 diff --git a/zh-cn/15.9/api/admin/api-admin-webconfig.rst b/zh-cn/15.9/api/admin/api-admin-webconfig.rst index 505d890ce..e502578d9 100644 --- a/zh-cn/15.9/api/admin/api-admin-webconfig.rst +++ b/zh-cn/15.9/api/admin/api-admin-webconfig.rst @@ -106,21 +106,21 @@ WebConfig API是用于管理 |Fess| Web爬虫设置的API。 "name": "Example Site", "description": "示例站点", "urls": "https://example.com/", - "includedUrls": ".*example\\.com.*", - "excludedUrls": ".*\\.(pdf|zip)$", - "includedDocUrls": "", - "excludedDocUrls": "", - "configParameter": "", + "included_urls": ".*example\\.com.*", + "excluded_urls": ".*\\.(pdf|zip)$", + "included_doc_urls": "", + "excluded_doc_urls": "", + "config_parameter": "", "depth": 3, - "maxAccessCount": 1000, - "userAgent": "Mozilla/5.0", - "numOfThread": 1, - "intervalTime": 1000, + "max_access_count": 1000, + "user_agent": "Mozilla/5.0", + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, "available": "true", "permissions": "{role}admin", - "virtualHosts": "", - "sortOrder": 0 + "virtual_hosts": "", + "sort_order": 0 } ], "total": 5 @@ -152,35 +152,35 @@ WebConfig API是用于管理 |Fess| Web爬虫设置的API。 "name": "Example Site", "description": "示例站点", "urls": "https://example.com/", - "includedUrls": ".*example\\.com.*", - "excludedUrls": ".*\\.(pdf|zip)$", - "includedDocUrls": "", - "excludedDocUrls": "", - "configParameter": "", + "included_urls": ".*example\\.com.*", + "excluded_urls": ".*\\.(pdf|zip)$", + "included_doc_urls": "", + "excluded_doc_urls": "", + "config_parameter": "", "depth": 3, - "maxAccessCount": 1000, - "userAgent": "Mozilla/5.0", - "numOfThread": 1, - "intervalTime": 1000, + "max_access_count": 1000, + "user_agent": "Mozilla/5.0", + "num_of_thread": 1, + "interval_time": 1000, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin", - "virtualHosts": "", - "createdBy": "admin", - "createdTime": 1700000000000, - "updatedBy": "admin", - "updatedTime": 1700000000000, - "versionNo": 1 + "virtual_hosts": "", + "created_by": "admin", + "created_time": 1700000000000, + "updated_by": "admin", + "updated_time": 1700000000000, + "version_no": 1 } } } .. note:: - 响应中包含在注册和更新时由服务器自动设置的 ``createdBy`` 、 ``createdTime`` 、 - ``updatedBy`` 、 ``updatedTime`` 、 ``versionNo`` 字段。 - ``versionNo`` 在更新时为必填项（请参阅后述的"更新Web爬虫设置"）。 + 响应中包含在注册和更新时由服务器自动设置的 ``created_by`` 、 ``created_time`` 、 + ``updated_by`` 、 ``updated_time`` 、 ``version_no`` 字段。 + ``version_no`` 在更新时为必填项（请参阅后述的"更新Web爬虫设置"）。 创建Web爬虫设置 =============== @@ -201,14 +201,14 @@ WebConfig API是用于管理 |Fess| Web爬虫设置的API。 { "name": "Corporate Site", "urls": "https://www.example.com/", - "includedUrls": ".*www\\.example\\.com.*", - "excludedUrls": ".*\\.(pdf|zip|exe)$", - "userAgent": "Mozilla/5.0", - "numOfThread": 3, - "intervalTime": 500, + "included_urls": ".*www\\.example\\.com.*", + "excluded_urls": ".*\\.(pdf|zip|exe)$", + "user_agent": "Mozilla/5.0", + "num_of_thread": 3, + "interval_time": 500, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}admin\n{role}user" } @@ -231,34 +231,34 @@ WebConfig API是用于管理 |Fess| Web爬虫设置的API。 * - ``urls`` - 是 - 爬虫起始URL（多个URL用换行符分隔）。使用 ``http:`` 或 ``https:`` 协议指定 - * - ``includedUrls`` + * - ``included_urls`` - 否 - 爬虫目标URL的正则表达式模式 - * - ``excludedUrls`` + * - ``excluded_urls`` - 否 - 排除爬虫URL的正则表达式模式 - * - ``includedDocUrls`` + * - ``included_doc_urls`` - 否 - 索引目标URL的正则表达式模式 - * - ``excludedDocUrls`` + * - ``excluded_doc_urls`` - 否 - 排除索引URL的正则表达式模式 - * - ``configParameter`` + * - ``config_parameter`` - 否 - 附加配置参数（ ``key=value`` 格式，每行一项） * - ``depth`` - 否 - 爬虫深度（0以上） - * - ``maxAccessCount`` + * - ``max_access_count`` - 否 - 最大访问数（0以上） - * - ``userAgent`` + * - ``user_agent`` - 是 - User-Agent字符串（最多200个字符） - * - ``numOfThread`` + * - ``num_of_thread`` - 是 - 并行线程数（1以上） - * - ``intervalTime`` + * - ``interval_time`` - 是 - 访问间隔（毫秒，0以上） * - ``boost`` @@ -267,19 +267,19 @@ WebConfig API是用于管理 |Fess| Web爬虫设置的API。 * - ``available`` - 是 - 启用/禁用（字符串 ``"true"`` / ``"false"``） - * - ``sortOrder`` + * - ``sort_order`` - 是 - 显示顺序（0以上） * - ``permissions`` - 否 - 访问权限角色（多个时用换行符分隔） - * - ``virtualHosts`` + * - ``virtual_hosts`` - 否 - 虚拟主机（多个时用换行符分隔） .. note:: - ``createdBy`` 、 ``createdTime`` 、 ``updatedBy`` 、 ``updatedTime`` 等审计字段 + ``created_by`` 、 ``created_time`` 、 ``updated_by`` 、 ``updated_time`` 等审计字段 由服务器自动设置，无需在请求体中指定。 响应 @@ -309,8 +309,8 @@ WebConfig API是用于管理 |Fess| Web爬虫设置的API。 请求体 ~~~~~~ -更新时，除创建时的字段外，还需要指定用于确定更新目标的 ``id`` 和版本号 ``versionNo`` 。 -``versionNo`` 需填写获取API（GET）响应中包含的当前值。 +更新时，除创建时的字段外，还需要指定用于确定更新目标的 ``id`` 和版本号 ``version_no`` 。 +``version_no`` 需填写获取API（GET）响应中包含的当前值。 .. code-block:: json @@ -318,17 +318,17 @@ WebConfig API是用于管理 |Fess| Web爬虫设置的API。 "id": "existing_webconfig_id", "name": "Updated Corporate Site", "urls": "https://www.example.com/", - "includedUrls": ".*www\\.example\\.com.*", - "excludedUrls": ".*\\.(pdf|zip|exe|dmg)$", - "userAgent": "Mozilla/5.0", + "included_urls": ".*www\\.example\\.com.*", + "excluded_urls": ".*\\.(pdf|zip|exe|dmg)$", + "user_agent": "Mozilla/5.0", "depth": 10, - "maxAccessCount": 10000, - "numOfThread": 5, - "intervalTime": 300, + "max_access_count": 10000, + "num_of_thread": 5, + "interval_time": 300, "boost": 1.2, "available": "true", - "sortOrder": 0, - "versionNo": 1 + "sort_order": 0, + "version_no": 1 } 更新时的附加字段 @@ -344,9 +344,9 @@ WebConfig API是用于管理 |Fess| Web爬虫设置的API。 * - ``id`` - 是 - 更新目标的设置ID（最多1000个字符） - * - ``versionNo`` + * - ``version_no`` - 是 - - 更新目标的当前版本号。填写获取API（GET）响应中包含的 ``versionNo`` 值 + - 更新目标的当前版本号。填写获取API（GET）响应中包含的 ``version_no`` 值 响应 ---- @@ -385,7 +385,7 @@ WebConfig API是用于管理 |Fess| Web爬虫设置的API。 URL模式示例 =========== -``includedUrls`` / ``excludedUrls`` / ``includedDocUrls`` / ``excludedDocUrls`` 中可使用正则表达式。 +``included_urls`` / ``excluded_urls`` / ``included_doc_urls`` / ``excluded_doc_urls`` 中可使用正则表达式。 .. list-table:: :header-rows: 1 @@ -418,16 +418,16 @@ URL模式示例 -d '{ "name": "Corporate Website", "urls": "https://www.example.com/", - "includedUrls": ".*www\\.example\\.com.*", - "excludedUrls": ".*/(login|admin|api)/.*", - "userAgent": "Mozilla/5.0", + "included_urls": ".*www\\.example\\.com.*", + "excluded_urls": ".*/(login|admin|api)/.*", + "user_agent": "Mozilla/5.0", "depth": 5, - "maxAccessCount": 10000, - "numOfThread": 3, - "intervalTime": 500, + "max_access_count": 10000, + "num_of_thread": 3, + "interval_time": 500, "boost": 1.0, "available": "true", - "sortOrder": 0, + "sort_order": 0, "permissions": "{role}guest" }' @@ -442,15 +442,15 @@ URL模式示例 -d '{ "name": "Documentation Site", "urls": "https://docs.example.com/", - "includedUrls": ".*docs\\.example\\.com.*", - "includedDocUrls": ".*\\.(html|htm)$", - "userAgent": "Mozilla/5.0", - "maxAccessCount": 50000, - "numOfThread": 5, - "intervalTime": 200, + "included_urls": ".*docs\\.example\\.com.*", + "included_doc_urls": ".*\\.(html|htm)$", + "user_agent": "Mozilla/5.0", + "max_access_count": 50000, + "num_of_thread": 5, + "interval_time": 200, "boost": 1.5, "available": "true", - "sortOrder": 0 + "sort_order": 0 }' 参考信息