-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7db45ac
commit 33b0e7b
Showing
8 changed files
with
247 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
34 changes: 34 additions & 0 deletions
34
data/requests/playermoderation/clearallplayermoderations.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# clearAllPlayerModerations | ||
|
||
## Request | ||
`DELETE https://vrchat.com/api/1/auth/user/playermoderations` | ||
|
||
| Header | Value | | ||
| ------ | ----- | | ||
| user-agent | `specification-test/@<unstable> https://github.com/vrchatapi/specification-test/issues/new` | | ||
| cookie | `auth=<redacted>; twoFactorAuth=<redacted>` | | ||
|
||
|
||
## Response | ||
`200 OK` | ||
|
||
| Header | Value | | ||
| ------ | ----- | | ||
| access-control-allow-credentials | `true` | | ||
| cache-control | `private, no-cache` | | ||
| connection | `keep-alive` | | ||
| content-length | `46` | | ||
| content-type | `application/json; charset=utf-8` | | ||
| pragma | `no-cache` | | ||
| server | `cloudflare` | | ||
| vary | `Authorization, Accept-Encoding` | | ||
| x-frame-options | `deny` | | ||
|
||
```jsonc | ||
{ | ||
"success": { | ||
"message": "OK", | ||
"status_code": 200 | ||
} | ||
} | ||
``` |
40 changes: 40 additions & 0 deletions
40
data/requests/playermoderation/getplayermoderations-with-filter.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# getPlayerModerations with filter | ||
|
||
## Request | ||
`GET https://vrchat.com/api/1/auth/user/playermoderations?type=unmute` | ||
|
||
| Header | Value | | ||
| ------ | ----- | | ||
| user-agent | `specification-test/@<unstable> https://github.com/vrchatapi/specification-test/issues/new` | | ||
| cookie | `auth=<redacted>; twoFactorAuth=<redacted>` | | ||
|
||
|
||
## Response | ||
`200 OK` | ||
|
||
| Header | Value | | ||
| ------ | ----- | | ||
| access-control-allow-credentials | `true` | | ||
| cache-control | `private, no-cache` | | ||
| connection | `keep-alive` | | ||
| content-type | `application/json; charset=utf-8` | | ||
| etag | `<redacted>` | | ||
| pragma | `no-cache` | | ||
| server | `cloudflare` | | ||
| transfer-encoding | `chunked` | | ||
| vary | `Authorization, Accept-Encoding` | | ||
| x-frame-options | `deny` | | ||
|
||
```jsonc | ||
[ | ||
{ | ||
"created": "<unstable>", | ||
"id": "oun_c1644b5b-3ca4-45b4-97c6-a2a0de70d469", | ||
"sourceDisplayName": "8cf3def6b8cea", | ||
"sourceUserId": "usr_9439f8cc-1c6b-4dca-9a07-d2eccb570701", | ||
"targetDisplayName": "tupper", | ||
"targetUserId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469", | ||
"type": "unmute" | ||
} | ||
] | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# getPlayerModerations | ||
|
||
## Request | ||
`GET https://vrchat.com/api/1/auth/user/playermoderations` | ||
|
||
| Header | Value | | ||
| ------ | ----- | | ||
| user-agent | `specification-test/@<unstable> https://github.com/vrchatapi/specification-test/issues/new` | | ||
| cookie | `auth=<redacted>; twoFactorAuth=<redacted>` | | ||
|
||
|
||
## Response | ||
`200 OK` | ||
|
||
| Header | Value | | ||
| ------ | ----- | | ||
| accept-ranges | `bytes` | | ||
| access-control-allow-credentials | `true` | | ||
| cache-control | `private, no-cache` | | ||
| connection | `keep-alive` | | ||
| content-length | `2` | | ||
| content-type | `application/json; charset=utf-8` | | ||
| etag | `<redacted>` | | ||
| pragma | `no-cache` | | ||
| server | `cloudflare` | | ||
| vary | `Authorization, Accept-Encoding` | | ||
| x-frame-options | `deny` | | ||
|
||
```jsonc | ||
[] | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# moderateUser | ||
|
||
## Request | ||
`POST https://vrchat.com/api/1/auth/user/playermoderations` | ||
|
||
| Header | Value | | ||
| ------ | ----- | | ||
| user-agent | `specification-test/@<unstable> https://github.com/vrchatapi/specification-test/issues/new` | | ||
| content-type | `application/json` | | ||
| cookie | `auth=<redacted>; twoFactorAuth=<redacted>` | | ||
|
||
```json | ||
{ | ||
"moderated": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469", | ||
"type": "unmute" | ||
} | ||
``` | ||
|
||
|
||
## Response | ||
`200 OK` | ||
|
||
| Header | Value | | ||
| ------ | ----- | | ||
| access-control-allow-credentials | `true` | | ||
| cache-control | `private, no-cache` | | ||
| connection | `keep-alive` | | ||
| content-type | `application/json; charset=utf-8` | | ||
| pragma | `no-cache` | | ||
| server | `cloudflare` | | ||
| transfer-encoding | `chunked` | | ||
| vary | `Authorization, Accept-Encoding` | | ||
| x-frame-options | `deny` | | ||
|
||
```jsonc | ||
{ | ||
"created": "<unstable: string>", | ||
"id": "oun_c1644b5b-3ca4-45b4-97c6-a2a0de70d469", | ||
"sourceDisplayName": "8cf3def6b8cea", | ||
"sourceUserId": "usr_9439f8cc-1c6b-4dca-9a07-d2eccb570701", | ||
"targetDisplayName": "tupper", | ||
"targetUserId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469", | ||
"type": "unmute" | ||
} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Playermoderation | ||
|
||
## Clear All Player Moderations | ||
⚠️ **This will delete every single player moderation you've ever made.** | ||
|
||
* [clearAllPlayerModerations](./clearallplayermoderations.md) | ||
## Search Player Moderations | ||
Returns a list of all player moderations made by **you**. | ||
|
||
This endpoint does not have pagination, and will return *all* results. Use query parameters to limit your query if needed. | ||
|
||
* [getPlayerModerations](./getplayermoderations.md) | ||
* [getPlayerModerations with filter](./getplayermoderations-with-filter.md) | ||
## Moderate User | ||
Moderate a user, e.g. unmute them or show their avatar. | ||
|
||
Please see the [Player Moderation docs](https://vrchatapi.github.io/docs/api/#tag--playermoderation) on what playerModerations are, and how they differ from staff moderations. | ||
|
||
* [moderateUser](./moderateuser.md) | ||
## Unmoderate User | ||
Removes a player moderation previously added through `moderateUser`. E.g if you previously have shown their avatar, but now want to reset it to default. | ||
|
||
> Missing coverage. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.