-
Notifications
You must be signed in to change notification settings - Fork 828
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.
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
REST methods cleanup #1217
Merged
Merged
REST methods cleanup #1217
Conversation
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
Refactor GuildRoleEdit to accept parameters using a Params struct. Therefore also allow partial edits.
Make GuildRoleCreate accept a struct with initial parameters for a role
Move funcitonality of ChannelEditComplex to ChannelEdit
* Make fields omitempty * Make `Enabled` field a pointer
Refactor GuildEmbedEdit to accept parameters through GuildEmbed struct
Move functionality fo GuildMemberEditComplex to GuildMemberEdit
Refactor GuildEmojiCreate to take parameters using EmojiParams struct.
Refactor GuildEmojiEdit to take parameters using EmojiParams struct.
Refactor GuildMemberAdd to take parameters using GuildMemberAddParams struct.
Refactor GuildTemplateEdit to take parameters using GuildTemplateParams struct.
Refactor GuildTemplateCreate to take parameters using GuildTemplateParams struct.
Refactor methods with Params struct to use pointers
FedorLap2006
commented
Aug 17, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
breaking changes
Contains breaking changes. Should be reflected in the changelog
feature
Major feature implementation
high priority
Issue or PR with high priority of merge
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.
We have been thinking on how to improve developer experience with the library and clean up some stuff.
One of the aspects that came to our attention is REST methods. Currently we don't have a consistent naming and signature style.
This PR addresses this problem.
It refactors REST methods to use structs where possible and removes some of the unnecessary helper methods.
This only affects older functions , functions that came after
v0.24.0
already are following this design.Here's how the usage will change:
Breaking changes
ChannelEdit
— will share same functional asChannelEditComplex
GuildMemberEdit
— will share same functional asGuildMemberEditComplex
GuildEmojiEdit
—name
androles
will be placed in a struct, to allow for partial editsGuildEmojiCreate
— same as forGuildEmojiEdit
GuildMemberAdd
—accessToken
,nick
,roles
,mute
anddeaf
will be placed in a structGuildRoleEdit
—name
,color
,hoist
,perms
,mention
will be placed in a struct to allow for partial editsGuildTemplateCreate
—name
anddescription
will be placed in a struct to allow for partial editsGuildTemplateEdit
— same as forGuildTemplateCreate
GuildEmbedEdit
—enabled
andchannel_id
will be places in a struct to allow for partial editsDeprecated functions
ChannelEditComplex
(renamed toChannelEdit
)GuildMemberEditComplex
(renamed toGuildMemberEdit
)🚧 The changes are still work in progress, therefore the list of functions might change.