Skip to content

v3.4.0: deprecate contents.metadata format

Choose a tag to compare

@tyler5673 tyler5673 released this 09 Sep 23:31
· 5 commits to main since this release
88a2ae8

Minor release. The metadata format on the Contents API is now deprecated and will be removed in a future major release, matching the upstream server change.

Deprecated

  • ContentsFormats.METADATA — the "metadata" format value is now deprecated. Passing it emits DeprecationWarning. Use html and/or markdown instead.
  • ContentsMetadata and ContentsMetadataTypedDict — the model types backing the metadata response field. Marked deprecated in docstrings.
  • ContentsResponse.metadata — the response field carrying OpenGraph and JSON-LD data. Marked deprecated in docstrings.

Dependencies

  • pydantic 2.12.5 → 2.13.5
  • mypy 2.3.0 → 2.3.1, pylint 4.0.6 → 4.0.8, pyright 1.1.398 → 1.1.413
  • GitHub Actions: checkout v7, setup-python v7, setup-go v7, droid-action v7

Fixes

  • page_age docstrings synced across WebResult/NewsResult (TypedDict + Pydantic) to describe lenient parsing behavior (DX-823)
  • Fixed pyright 1.1.413 possibly-unbound variable warning in research_helpers.py re-poll loops

Full changelog: https://github.com/youdotcom-oss/youdotcom-python-sdk/blob/v3.4.0/CHANGELOG.md