zelo72
/
documentation
mirror of https://github.com/mastodon/documentation
1
0
Fork 0
Code Issues 6 Releases Wiki Activity

Add documentation for `hint` attribute of `Rule` entity in REST API (#1478)

This commit is contained in:
Claire 2024-07-16 01:42:47 +02:00 committed by GitHub
parent de8d6ac149
commit 8efb133f16
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
content/en/entities/Rule.md
View File

@ -17,26 +17,34 @@ aliases: [
```json
{
"id": "2",
"text": "No racism, sexism, homophobia, transphobia, xenophobia, or casteism"
"text": "No racism, sexism, homophobia, transphobia, ableism, xenophobia, or casteism.",
"hint": "Transphobic behavior such as intentional misgendering and deadnaming is strictly prohibited. Promotion of \"conversion therapy\" is strictly prohibited. Criticism of governments and religions is permissible unless being used as a proxy for discrimination."
}
```
## Attributes
### `id` {#name}
### `id` {#id}
**Description:** An identifier for the rule.\
**Type:** String (cast from integer, but not guaranteed to be a number)\
**Version history:**\
3.4.0 - added
### `text` {#url}
### `text` {#text}
**Description:** The rule to be followed.\
**Type:** String \
**Version history:**\
3.4.0 - added
### `hint` {#hint}
**Description:** Longer-form description of the rule.\
**Type:** String \
**Version history:**\
4.3.0 - added
## See also
{{< page-relref ref="methods/instance#rules" caption="GET /api/v1/instance/rules" >}}