fix: Add support for the X-Audit-Log-Reason header where it's missing #50
Conversation
This file contains hidden or 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
Zoddo
commented
Jun 1, 2025
| public async deleteWebhook(webhookId: string, token?: string): Promise<RESTDeleteAPIWebhookResult> { | ||
| if (token) return this.requestHandler.request(Endpoints.WEBHOOK_TOKEN(webhookId, token), {}, "delete", "json") as RESTDeleteAPIWebhookResult; | ||
| return this.requestHandler.request(Endpoints.WEBHOOK(webhookId), {}, "delete", "json") as RESTDeleteAPIWebhookResult; | ||
| public async deleteWebhook(webhookId: string, token?: string, reason?: string): Promise<RESTDeleteAPIWebhookResult> { |
Contributor
Author
There was a problem hiding this comment.
Taking a look at this again after sleeping, I'm not sure that's the best way to handle it here. I added it as a second optional argument to not make a breaking change.
However, you may want to set the reason without setting the token. It's technically possible by passing undefined for the token, but it looks a bit weird.
From a lib API perspective, I was wondering if something like that may be cleaner:
public async deleteWebhook(webhookId: string, token?: string): Promise<RESTDeleteAPIWebhookResult>;
public async deleteWebhook(webhookId: string, data?: {token?: string, reason?: string}): Promise<RESTDeleteAPIWebhookResult>;That way it's not a breaking change either, and we can support a data object with optional properties (instead of relying to optional method parameters that you may have to set to undefined).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I've checked all create/update/delete endpoints, they should all be covered now.