aica-technology / api

AICA API resources
0 stars 0 forks source link

Define more detailed feature and function compatibility between versions #158

Closed eeberhard closed 1 month ago

eeberhard commented 1 month ago

Minor updates to the core API version (for example, from v3.0 to v3.1) introduce new endpoints and features. The Python client can correspondingly add new wrapper functions for these endpoints or features, equally released under minor updates.

In order to know which features are available with which versions, the compatibility table and check() function should have corresponding indications. Additionally, it would be nice for a function decorator to apply a specific version check and warn if a feature is not available in the current version.

This is different to breaking changes which are marked by major changes to the API version or Python client. These normally mean that the code is no longer backwards compatible (things that worked before don't work anymore).