Releases: meraki/dashboard-api-python
4.1.0b2
What's Changed
- Release v4.1.0b2 (API v1.70.0-beta.2) by @meraki-release-bot[bot] in #362
Full Changelog: 4.1.0b1...4.1.0b2
3.1.0b2
What's Changed
- Release v3.1.0b2 (API v1.70.0-beta.2) by @meraki-release-bot[bot] in #363
Full Changelog: 3.1.0b1...3.1.0b2
4.1.0b1
What's Changed
- Release v4.1.0b0 (API v1.70.0-beta.0) by @meraki-release-bot[bot] in #348
- Release v4.1.0b1 (API v1.70.0-beta.1) by @meraki-release-bot[bot] in #354
Full Changelog: 4.0.0b1...4.1.0b1
3.1.0b1
What's Changed
- Release v3.1.0b1 (API v1.70.0-beta.1) by @meraki-release-bot[bot] in #356
Full Changelog: 3.1.0b0...3.1.0b1
4.0.0b1
Hello, httpx!
This release is the first pre-release version of the library that has been refactored to use httpx instead of requests and aiohttp.
Summary
This migration offers us a number of meaningful benefits:
- One library, one codebase - eliminates ~80% duplicated logic between sync (rest_session.py, 670 lines) and async (aio/rest_session.py, 547 lines)
- Fixes real bugs - bare except Exception in async, inconsistent error handling, blocking time.sleep() in the async event loop
- Drops two pinned deps (requests<3, aiohttp<4) for one (httpx)
- Identical sync/async API - httpx.Client and httpx.AsyncClient share the same surface, so shared base class becomes trivial
- Type-annotated from the start - natural opportunity to add typing to core modules
- Simpler async - response body is buffered after await, so .json() is sync even on the async client; eliminates all async with await patterns
Decision logic (retry, backoff, error classification) lives in a single base class, and sync/async layers are thin I/O shells differing only in sleep vs await asyncio.sleep.
Breaking changes
For normal SDK users, these changes are invisible. Most scripts will "just work" without updates. The SDK's public API (DashboardAPI, AsyncDashboardAPI, all endpoint methods) is unchanged.
The actual breaks live in import paths, exception internals, and the HTTP dependency swap.
Dependencies
requests+aiohttpreplaced byhttpx>=0.28,<1: Anyone pinning or importing these transitively loses them.responses(test library) replaced byrespx: Only affects contributors running the test suite.
Module structure
meraki/rest_session.pydeleted:from meraki.rest_session import RestSessionbreaksmeraki/aio/rest_session.pydeleted:from meraki.aio.rest_session import AsyncRestSessionbreaks- New location:
meraki/session/sync.py,meraki/session/async_.py: If you need to, usefrom meraki.session import RestSession, AsyncRestSession(most users will not need this) - New shared base:
meraki/session/base.py: Internal; not part of the SDK's public API - New encoding module:
meraki/encoding.py: Internal; replaces the old monkey-patch
Exceptions
AsyncAPIErroris now a deprecated subclass of APIError:except AsyncAPIErrorstill catches, but emitsDeprecationWarning. Useexcept APIErrorfor both sync and async going forward..reasonattribute preserved on exception objects: Still works; internally, now reads fromresponse.reason_phrase.
Internals (private SDK API)
_req_sessionattribute removed; there is no compatibility shim.- Monkey-patch of
requests.models.RequestEncodingMixin._encode_paramsremoved; anyone relying on this SDK side-effecting therequestsmodule loses it. response.status(fromaiohttp) is nowresponse.status_code(httpx); only visible if you accessed raw response objects from session internals.
More info, why, etc.
For more information, please consult HTTPX-MIGRATION.md.
Full Changelog: 3.0.2...4.0.0b1
3.1.0
3.1.0b0
What's Changed
- Release v3.1.0b0 (API v1.70.0-beta.0) by @meraki-release-bot[bot] in #345
Full Changelog: 3.1.0...3.1.0b0
3.0.2
Patchfix for #335.
What's Changed
- Auto-generated library v3.0.2 for API v1.69.0. by @TKIPisalegacycipher in #336
Full Changelog: 3.0.1...3.0.2
3.0.1
First library version generated on OASv3.
Exposes new OASv3-specific API features already present in upstream API.
Integrates invalid kwarg logging.
Deprecates v2 generator in alignment with Meraki OASv2 deprecation.
Please report any issues.
3.0.0
Release Notes (since 2.2.0)
Bug Fixes
- Fix golden test using wrong ruff line-length in temp dir
- Fix generator omitting path params from function signature
- Fix generator for URL path params only declared as body params in spec
- Fix sync _get_pages_iterator dropping the last page (#326)
Security
- Prevent script injection in GitHub Actions workflows
- Fix CodeQL alert in test-library CI
Build & Tooling
- Replace Poetry with uv for build tooling and dependency management
- Add generator test suite
- Modernize project tooling, imports, and test infrastructure
- Clean up CI, linting, and code quality issues
- Optimize GitHub Actions: upgrade deprecated actions, reduce redundant work
- Delete duplicated CodeQL workflow
- Exclude .venv from tests
Dependency Updates (requiring semver bump from 2.2.0 -> 3.0.0)
- Add support for Python 3.14
- Drop Python 3.10 support in anticipation of 3.10 EOL
- aiohttp 3.11.18 → 3.13.5 (#324, #328)
- requests 2.32.3 → 2.33.1 (#323, #329)
- urllib3 2.4.0 → 2.6.3 (#317)
- pytest 8.3.5 → 9.0.3 (#325)
- pytest-cov 6.3.0 → 7.1.0 (#327)
New Contributors
- @jgarber-cisco made their first contribution in #326
Full Changelog: 2.2.0...3.0.0