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.

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

Better API #19

Open
kescobo opened this issue Oct 16, 2023 · 1 comment
Open

Better API #19

kescobo opened this issue Oct 16, 2023 · 1 comment
Labels
breaking change to API that requires major version bump enhancement New feature or request
Milestone

Comments

@kescobo
Copy link
Owner

kescobo commented Oct 16, 2023

After using this a bit more, I think the API could use some improvement.

Low-level API

I think that all of the basic API functions GET, POST etc should take an AirTable as the first argument, and the content (if applicable) as the second argument. Other stuff should be in kwargs.

Right now, the order of things is janky depending on the function, the basic idea is that they should be unified.

This means that content should not be handled in kwargs, since this may cause conflicts, instead, content /modifiers should be passed as pairs or nts, either as a positional argument, or to an explicit kwarg.

Credentials

It would be ideal to pass credentials as a kwarg.

@kescobo kescobo added the enhancement New feature or request label Oct 16, 2023
@kescobo kescobo added this to the Road to 1.0 milestone Oct 16, 2023
@kescobo kescobo added the breaking change to API that requires major version bump label Oct 16, 2023
@kescobo
Copy link
Owner Author

kescobo commented Jan 10, 2025

Maybe use https://github.com/tecosaur/RestClient.jl ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change to API that requires major version bump enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant