Update rule_ids type in /v1/reports (#1467)
* Update rule_ids type in /v1/reports * add reference to the ID docs
This commit is contained in:
parent
dc78b2ad5f
commit
b780066232
|
@ -57,7 +57,7 @@ category
|
|||
: String. Specify if the report is due to `spam`, `legal` (illegal content), `violation` of enumerated instance rules, or some `other` reason. Defaults to `other`. Will be set to `violation` if `rule_ids[]` is provided (regardless of any category value you provide).
|
||||
|
||||
rule_ids[]
|
||||
: Array of Integer. For `violation` category reports, specify the ID of the exact rules broken. Rules and their IDs are available via [GET /api/v1/instance/rules]({{< relref "methods/instance#rules" >}}) and [GET /api/v1/instance]({{< relref "methods/instance#get" >}}).
|
||||
: Array of String. For `violation` category reports, specify the ID of the exact rules broken. Rules and their IDs are available via [GET /api/v1/instance/rules]({{< relref "methods/instance#rules" >}}) and [GET /api/v1/instance]({{< relref "methods/instance#get" >}}). See [Handling and sorting IDs]({{< relref "api/guidelines/#id" >}}) for more information.
|
||||
|
||||
#### Response
|
||||
##### 200: OK
|
||||
|
@ -153,4 +153,4 @@ Alternatively (Mastodon 3.5), the `category` was set to something other than `vi
|
|||
|
||||
## See also
|
||||
|
||||
{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/controllers/api/v1/reports_controller.rb" caption="app/controllers/api/v1/reports_controller.rb" >}}
|
||||
{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/controllers/api/v1/reports_controller.rb" caption="app/controllers/api/v1/reports_controller.rb" >}}
|
||||
|
|
Loading…
Reference in New Issue