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

9
API/README.md
View File

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