Skip to content

Releases: meraki/dashboard-api-python

4.1.0b2

20 May 15:21
fb1944f

Choose a tag to compare

4.1.0b2 Pre-release
Pre-release

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

20 May 15:21
7703108

Choose a tag to compare

3.1.0b2 Pre-release
Pre-release

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

14 May 00:55
5c774b5

Choose a tag to compare

4.1.0b1 Pre-release
Pre-release

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

14 May 01:28
2695214

Choose a tag to compare

3.1.0b1 Pre-release
Pre-release

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

06 May 03:43
904f954

Choose a tag to compare

4.0.0b1 Pre-release
Pre-release

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:

  1. One library, one codebase - eliminates ~80% duplicated logic between sync (rest_session.py, 670 lines) and async (aio/rest_session.py, 547 lines)
  2. Fixes real bugs - bare except Exception in async, inconsistent error handling, blocking time.sleep() in the async event loop
  3. Drops two pinned deps (requests<3, aiohttp<4) for one (httpx)
  4. Identical sync/async API - httpx.Client and httpx.AsyncClient share the same surface, so shared base class becomes trivial
  5. Type-annotated from the start - natural opportunity to add typing to core modules
  6. 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 + aiohttp replaced by httpx>=0.28,<1: Anyone pinning or importing these transitively loses them.
  • responses (test library) replaced by respx: Only affects contributors running the test suite.

Module structure

  • meraki/rest_session.py deleted: from meraki.rest_session import RestSession breaks
  • meraki/aio/rest_session.py deleted: from meraki.aio.rest_session import AsyncRestSession breaks
  • New location: meraki/session/sync.py, meraki/session/async_.py: If you need to, use from 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

  • AsyncAPIError is now a deprecated subclass of APIError: except AsyncAPIError still catches, but emits DeprecationWarning. Use except APIError for both sync and async going forward.
  • .reason attribute preserved on exception objects: Still works; internally, now reads from response.reason_phrase.

Internals (private SDK API)

  • _req_session attribute removed; there is no compatibility shim.
  • Monkey-patch of requests.models.RequestEncodingMixin._encode_params removed; anyone relying on this SDK side-effecting the requests module loses it.
  • response.status (from aiohttp) is now response.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

06 May 20:56
c266bdd

Choose a tag to compare

What's Changed

  • Release v3.1.0 (API v1.70.0) by @meraki-release-bot[bot] in #341

New Contributors

  • @meraki-release-bot[bot] made their first contribution in #341

Full Changelog: 3.0.2...3.1.0

3.1.0b0

06 May 23:33
2828696

Choose a tag to compare

3.1.0b0 Pre-release
Pre-release

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

06 May 01:35
0628b49

Choose a tag to compare

Patchfix for #335.

What's Changed

Full Changelog: 3.0.1...3.0.2

3.0.1

30 Apr 13:04
286d7f0

Choose a tag to compare

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

30 Apr 05:55
90d9785

Choose a tag to compare

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

Full Changelog: 2.2.0...3.0.0