BadWord API

Übersicht

Die BadWord API dient zur Verwaltung von verbotenen Wörtern (Bad Words) in Fess. Diese Wörter werden aus Suchvorschlägen ausgeschlossen.

Basis-URL

/api/admin/badword

Endpunktliste

Methode Pfad Beschreibung
GET/PUT /settings Bad Word Liste abrufen
GET /setting/{id} Bad Word abrufen
POST /setting Bad Word erstellen
PUT /setting Bad Word aktualisieren
DELETE /setting/{id} Bad Word löschen

Bad Word erstellen

Request

POST /api/admin/badword/setting
Content-Type: application/json

Request-Body

{
  "suggestWord": "inappropriate term"
}

Feldbeschreibungen

Feld Erforderlich Beschreibung
suggestWord Ja Das zu blockierende Wort

Verwendungsbeispiele

curl -X POST "http://localhost:8080/api/admin/badword/setting" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "suggestWord": "blocked term"
     }'

Referenzinformationen