Skip to content

docs: add missed fields for the GuildAuditLogEntry #1222

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

Merged
merged 2 commits into from
Jan 15, 2023
Merged

docs: add missed fields for the GuildAuditLogEntry #1222

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4681588
docs: add missed fields for the `GuildAuditLogEntry`
Damego Jan 14, 2023
da4f525
docs: Ed, are you kidding me?
Damego Jan 14, 2023
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
4 changes: 2 additions & 2 deletions interactions/api/models/audit_log.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,8 +234,8 @@ class AuditLogEntry(DictSerializerMixin):
:ivar Optional[Snowflake] user_id: User or app that made the changes
:ivar Snowflake id: ID of the entry
:ivar AuditLogEvents action_type: Type of action that occurred
:ivar OptionalAuditEntryInfo options: Additional info for certain event types
:ivar str reason: Reason for the change (1-512 characters)
:ivar Optional[AuditEntryInfo] options: Additional info for certain event types
:ivar Optional[str] reason: Reason for the change (1-512 characters)
"""

target_id: Optional[str] = field(default=None)
Expand Down
9 changes: 8 additions & 1 deletion interactions/api/models/gw.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,9 +214,16 @@ class GuildAuditLogEntry(AuditLogEntry):
.. versionadded:: 4.4.0

A class object representing the event ``GUILD_AUDIT_LOG_ENTRY_CREATE``.
A derivation of AuditLogEntry.
A derivation of :class:`.AuditLogEntry`.

:ivar Snowflake guild_id: The guild ID of event.
:ivar Optional[str] target_id: ID of the affected entity (webhook, user, role, etc.)
:ivar Optional[List[AuditLogChange]] changes: Changes made to the target_id
:ivar Optional[Snowflake] user_id: User or app that made the changes
:ivar Snowflake id: ID of the entry
:ivar AuditLogEvents action_type: Type of action that occurred
:ivar Optional[AuditEntryInfo] options: Additional info for certain event types
:ivar Optional[str] reason: Reason for the change (1-512 characters)
"""

guild_id: Snowflake = field(converter=Snowflake)
Expand Down