Skip to content

Commit

Permalink
Update admin/domain_blocks to include conflict response
Browse files Browse the repository at this point in the history
When creating a domain block, if there is already a domain block rule for the domain, then the existing block is returned. This documents that behavior.

I've also documented the `digest` property which was added in mastodon/mastodon#29092
  • Loading branch information
ThisIsMissEm authored Mar 12, 2024
1 parent 046da5d commit c2153cd
Showing 1 changed file with 31 additions and 5 deletions.
36 changes: 31 additions & 5 deletions content/en/methods/admin/domain_blocks.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ limit
{
"id": "1",
"domain": "example.com",
"digest": "a379a6f6eeafb9a55e378c118034e2751e682fab9f2d30ab13d2125586ce1947",
"created_at": "2022-11-16T08:15:34.238Z",
"severity": "noop",
"reject_media": false,
Expand Down Expand Up @@ -120,6 +121,7 @@ Authorization
{
"id": "1",
"domain": "example.com",
"digest": "a379a6f6eeafb9a55e378c118034e2751e682fab9f2d30ab13d2125586ce1947",
"created_at": "2022-11-16T08:15:34.238Z",
"severity": "noop",
"reject_media": false,
Expand All @@ -146,7 +148,7 @@ DomainBlock with the given ID does not exist

```json
{
"error": "Record not found"
"error": "Record not found"
}
```

Expand Down Expand Up @@ -205,6 +207,7 @@ Domain has been blocked from federating.
{
"id": "1",
"domain": "example.com",
"digest": "a379a6f6eeafb9a55e378c118034e2751e682fab9f2d30ab13d2125586ce1947",
"created_at": "2022-11-16T08:15:34.238Z",
"severity": "noop",
"reject_media": false,
Expand All @@ -225,13 +228,35 @@ Authorized user is not allowed to perform this action, or invalid or missing Aut
}
```

##### 422: Unprocessable entity
##### 422: Unprocessable entity - Missing Parameter

The domain parameter was not provided

```json
{
"error": "Validation failed: Domain can't be blank"
"error": "Validation failed: Domain can't be blank"
}
```

##### 422: Unprocessable entity - Existing Domain Block

The domain parameter already is covered by an existing domain block.

```json
{
"error": "You have already imposed stricter limits on example.com."
"existing_domain_block": {
"id": "1",
"domain": "example.com",
"digest": "a379a6f6eeafb9a55e378c118034e2751e682fab9f2d30ab13d2125586ce1947",
"created_at": "2022-11-16T08:15:34.238Z",
"severity": "noop",
"reject_media": false,
"reject_reports": false,
"private_comment": null,
"public_comment": null,
"obfuscate": false
}
}
```

Expand Down Expand Up @@ -292,6 +317,7 @@ Domain block has been updated
{
"id": "1",
"domain": "example.com",
"digest": "a379a6f6eeafb9a55e378c118034e2751e682fab9f2d30ab13d2125586ce1947",
"created_at": "2022-11-16T08:15:34.238Z",
"severity": "noop",
"reject_media": false,
Expand Down Expand Up @@ -368,12 +394,12 @@ DomainBlock with the given ID does not exist

```json
{
"error": "Record not found"
"error": "Record not found"
}
```

---

## See also

{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/controllers/api/v1/admin/domain_blocks_controller.rb" caption="app/controllers/api/v1/admin/domain_blocks_controller.rb" >}}
{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/controllers/api/v1/admin/domain_blocks_controller.rb" caption="app/controllers/api/v1/admin/domain_blocks_controller.rb" >}}

0 comments on commit c2153cd

Please sign in to comment.