Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document audit logs for scheduled events #4237

Merged
merged 1 commit into from
Dec 14, 2021
Merged

Document audit logs for scheduled events #4237

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions docs/resources/Guild_Scheduled_Event.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ A representation of a scheduled event in a [guild](#DOCS_RESOURCES_GUILD/).

\* `creator_id` will be null and `creator` will not be included for events created before October 25th, 2021, when the concept of `creator_id` was introduced and tracked.

\** See [field requirements by entity type](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object-field-requirements-by-entity-type) to understand the relationship between `entity_type` and the following fields: `channel_id`, `entity_metadata`, and `scheduled_end_time`
\** See [field requirements by entity type](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object-field-requirements-by-entity-type) to understand the relationship between `entity_type` and the following fields: `channel_id`, `entity_metadata`, and `scheduled_end_time`

###### Guild Scheduled Event Privacy Level

Expand Down Expand Up @@ -88,7 +88,7 @@ SCHEDULED --> CANCELED
| ------------ | ------------------- | ---------------------------------------- |
| location? * | string | location of the event (1-100 characters) |

\* [required](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object-guild-scheduled-event-entity-metadata) for events with `'entity_type': EXTERNAL`
\* [required](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object-guild-scheduled-event-entity-metadata) for events with `'entity_type': EXTERNAL`

### Guild Scheduled Event User Object

Expand Down Expand Up @@ -118,6 +118,9 @@ Create a guild scheduled event in the guild. Returns a [guild scheduled event](#
> info
> A guild can have a maximum of 100 events with `SCHEDULED` or `ACTIVE` status at any time.

> info
> This endpoint supports the `X-Audit-Log-Reason` header.

###### JSON Params

| Field | Type | Description |
Expand Down Expand Up @@ -150,6 +153,9 @@ Modify a guild scheduled event. Returns the modified [guild scheduled event](#DO
> info
> To start or end an event, use this endpoint to modify the event's [status](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object-guild-scheduled-event-status) field.

> info
> This endpoint supports the `X-Audit-Log-Reason` header.

###### JSON Params

| Field | Type | Description |
Expand Down Expand Up @@ -256,4 +262,4 @@ NOTE: `entity_type` is expressed by name rather than value for readability

#### Read Permissions (GET)

* *No other permissions required*
* *No other permissions required*