Skip to content

docs(15.9): use the snake_case field names of the admin API #569

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

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

docs(15.9): use the snake_case field names of the admin API #569

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

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions de/15.9/api/admin/api-admin-accesstoken.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

Expand All @@ -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
}
}
}
Expand Down Expand Up @@ -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``
Expand Down Expand Up @@ -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
Expand All @@ -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::

Expand Down
16 changes: 8 additions & 8 deletions de/15.9/api/admin/api-admin-badword.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Response
"settings": [
{
"id": "badword_id_1",
"suggestWord": "inappropriate_word"
"suggest_word": "inappropriate_word"
}
],
"total": 5
Expand All @@ -119,7 +119,7 @@ Response
"status": 0,
"setting": {
"id": "badword_id_1",
"suggestWord": "inappropriate_word"
"suggest_word": "inappropriate_word"
}
}
}
Expand All @@ -141,7 +141,7 @@ Request-Body
.. code-block:: json

{
"suggestWord": "spam_keyword"
"suggest_word": "spam_keyword"
}

Feldbeschreibungen
Expand All @@ -154,7 +154,7 @@ Feldbeschreibungen
* - Feld
- Erforderlich
- Beschreibung
* - ``suggestWord``
* - ``suggest_word``
- Ja
- Das auszuschließende Schlüsselwort (darf keine Leerzeichen enthalten)

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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).
Expand Down Expand Up @@ -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
Expand Down
98 changes: 49 additions & 49 deletions de/15.9/api/admin/api-admin-boostdoc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand All @@ -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
Expand All @@ -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
======================
Expand All @@ -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
}
}
}
Expand All @@ -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
Expand All @@ -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).

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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::

Expand All @@ -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
Expand All @@ -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::
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down
Loading
Loading