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

API versioning #3

Open
ryanc-me opened this issue Aug 14, 2024 · 1 comment
Open

API versioning #3

ryanc-me opened this issue Aug 14, 2024 · 1 comment

Comments

@ryanc-me
Copy link
Owner

Right now, we aren't considering the Odoo version at all.

Because of that:

  1. We can't use the type system to guarantee that a particular API method is available.
  2. We can't have multiple versions of an API endpoint (e.g., if Odoo changed the call_kw method slightly)

I'm not actually sure this would be a desirable feature. A few downsides would be:

  1. Much more rigid - users would need to store a version-typed Client object, or else use match {} blocks to cover all possible Odoo versions
  2. More difficult to maintain
  3. How would we handle SaaS versions (like 16.3 and 16.4 which are actually closer to 16.0 and 17.0 respectively)

It does seem like the Odoo APIs are very stable (perhaps because they're used internally), so maybe this is all fine.

One option might be some runtime-checks - that would eliminate issues 1 & 3 above.

@ryanc-me
Copy link
Owner Author

If anyone has thoughts/ideas here, I'm keen to hear them!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant