v1. You’re always on the version in the
URL — Memic never silently changes the shape of responses under you.
When we bump the version
A new major version (v2) is created when we need to make a breaking
change. Examples of breaking changes:
- Removing a field from a response
- Renaming a field
- Changing a field’s type
- Removing an endpoint
- Changing the semantics of a parameter
- Changing authentication requirements
What is NOT a breaking change
These are non-breaking and happen on the current version without notice:- Adding a new field to a response
- Adding a new optional parameter
- Adding a new endpoint
- Adding a new error code (with an existing status code)
- Adding a new enum value (where the field is documented as extensible)
- Performance improvements, bug fixes, security patches
SDK versioning
The Python SDK (memic) follows semantic versioning:
- Patch (
0.3.0 → 0.3.1) — bug fixes - Minor (
0.3.0 → 0.4.0) — new features, backwards compatible - Major (
0.9.0 → 1.0.0) — breaking changes
Migration path
Whenv2 ships, v1 will continue to work for a guaranteed minimum of
12 months. During that period:
- Both versions are fully supported
v1endpoints return aDeprecation: trueheader- The docs show a version selector so you can view either version’s reference
- We email your organization with migration timing
v1 before the 12-month window expires.
Checking the current version
v1 in the URL is the only version indicator. Responses do not include
a version field — the version is fixed by the URL you called.
Related
API Reference
The full endpoint reference, versioned at
v1.