Skip to content

Commit

Permalink
Improve naming of response fields.
Browse files Browse the repository at this point in the history
  • Loading branch information
Gnuxie committed Sep 17, 2024
1 parent e204eaa commit 8f1900a
Showing 1 changed file with 14 additions and 6 deletions.
20 changes: 14 additions & 6 deletions proposals/4194-user-redaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,18 +106,24 @@ have not been because of the `limit` query parameter. If
`is_more_events` is true, then the server should expect that the
client can optionally call the endpoint again, to redact even more events.

`redacted_events`: `integer` - The number of events that have been redacted, including soft failed events.
`redacted_events`: `object` - An object with the following fields:

`soft_failed_events`: `integer` - The number of soft failed events that have been redacted.
* `total`: `integer` - The number of events that have been redacted,
including soft failed events.

* `soft_failed`: `integer` - The number of soft failed events that
have been redacted.

```
200 OK
Content-Type: application/json
{
"is_more_events": false,
"redacted_events": 5,
"soft_failed_events": 1
"redacted_events": {
"total": 5,
"soft_failed": 1
}
}
```

Expand All @@ -137,8 +143,10 @@ Content-Type: application/json
{
"is_more_events": true,
"redacted_events": 25,
"soft_failed_events": 3
"redacted_events": {
"total": 25,
"soft_failed": 3
}
}
```

Expand Down

0 comments on commit 8f1900a

Please sign in to comment.