Deprecate endpoint aliases #234
Merged
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
This includes payments.all (which is synonymous with payments.page); and payments.delete (which is synonymous with payments.cancel).
edorivai
approved these changes
Nov 9, 2021
Pimm
added a commit
that referenced
this pull request
Mar 10, 2023
These endpoint aliases were deprecated in #234. The first version to include this deprecation is 3.6.0, released on 10 February 2022. In the era of TypeScript, I feel the confusion caused by having two (or sometimes three) separate functions in the type definition outweighs the backwards compatibility. Consumers of an API expect every part of it to be significant.
Merged
Pimm
added a commit
that referenced
this pull request
May 25, 2023
These endpoint aliases were deprecated in #234. The first version to include this deprecation is 3.6.0, released on 10 February 2022. In the era of TypeScript, I feel the confusion caused by having two (or sometimes three) separate functions in the type definition outweighs the backwards compatibility. Consumers of an API expect every part of it to be significant.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Deprecated endpoint aliases such as:
client.payments.all(which is synonymous withclient.payments.page)client.payments.delete(which is synonymous withclient.payments.cancel)Con
This is another breaking change.
Pros
The pros of #233 apply here as well:
pagevsallorlistI've chosen
pageoverallorlist. I don't likeall, because the name is misleading: endpoints apply pagination, thereforeallsometimes returns "some" instead of "all".listis a decent name; butpagehas the advantages of being consistent with the PHP client, and making it even more obvious that there is pagination in effect.