Rainnny/TextPurify
1
0
Fork 0
Code Issues Pull Requests 1 Actions Activity

Update route docs
Some checks failed
Deploy / docker (17, 3.8.5) (push) Failing after 47s
Details

Browse Source
This commit is contained in:
Braydon 2024-06-21 00:22:13 -04:00
parent 43d0938f8f
commit c5c458b301
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
API/README.md
View File

@ -7,6 +7,7 @@ The backend API for TextPurify, responsible for the filtering and moderation of
This endpoint is used to filter text content. The request body should be an encoded form with the following fields:
| Field | Description | Required |
|---------------|--------------------------------------------------------|----------|
|---------------|---------------------------------------------------------------------------|----------|
| `content` | The text content to be filtered. | Yes |
| `replaceChar` | The character to use for filtered content replacement. | No |
| `ignoredTags` | The tags to ignore during filtering (E.g: `VULGARITY`, or `ADVERTISING`). | No |