diff --git a/changelog.d/20379.doc b/changelog.d/20379.doc new file mode 100644 index 0000000000..baffd79c68 --- /dev/null +++ b/changelog.d/20379.doc @@ -0,0 +1 @@ +Fix `complete` task status typo in `/redact_status` admin API docs. diff --git a/docs/admin_api/user_admin_api.md b/docs/admin_api/user_admin_api.md index ca82ccbecd..accc2b1db4 100644 --- a/docs/admin_api/user_admin_api.md +++ b/docs/admin_api/user_admin_api.md @@ -1601,7 +1601,7 @@ The following parameters should be set in the URL: The following fields are returned in the JSON response body: -- `status` - string - one of scheduled/active/completed/failed, indicating the status of the redaction job +- `status` - string - one of `scheduled`/`active`/`complete`/`failed`, indicating the status of the redaction job - `failed_redactions` - dictionary - the keys of the dict are event ids the process was unable to redact, if any, and the values are the corresponding error that caused the redaction to fail