Skip to content

Release/v4.0.0#104

Draft
AlexGherardelli wants to merge 12 commits into
mainfrom
release/v4.0.0
Draft

Release/v4.0.0#104
AlexGherardelli wants to merge 12 commits into
mainfrom
release/v4.0.0

Conversation

@AlexGherardelli

@AlexGherardelli AlexGherardelli commented Jun 11, 2026

Copy link
Copy Markdown
Member

Description

This PR introduces several updates and breaking changes across the data bridges and household API, along with documentation and maintenance improvements.

Breaking change

  • Rename DataBridgesShape → DataBridgesKnots
  • Add new parameters to household survey API: apply_mapping, full_data

New features

  • Update default DataBridges API version to v2 (latest)
  • Extend get_household_survey to support richer responses via new parameters

Bug fixes

  • Pin correct data-bridges-client version
  • Ensure API calls use self.configuration consistently
  • Fix class renaming inconsistencies and typo in DataBridgesKnots

Docs & housekeeping

Update README
Update ROADMAP for v4.x
Apply codestyle formatting

Related Issue

Type of Change

  • 📚 Examples / docs / tutorials / dependencies update
  • 🔧 Bug fix (non-breaking change which fixes an issue)
  • 🥂 Improvement (non-breaking change which improves an existing feature)
  • 🚀 New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to change)
  • 🔐 Security fix

Checklist

  • I've updated the code style using make codestyle.
  • I've written tests for all new methods and classes that I created.
  • I've written the docstring in Google format for all the methods and classes that I used.
  • My commits follow the Conventional Commits format (fix:, feat:, chore:, etc.).

Comment on lines +27 to +41
# def test_get_household_full_data_success(client):
# mock_api_instance = MagicMock()
# mock_api_instance.household_full_data_get.return_value = {"data": ["ok"]}

# with patch(
# "data_bridges_knots.endpoints.householdApi.data_bridges_client.IncubationApi",
# return_value=mock_api_instance,
# ), patch(
# "data_bridges_knots.endpoints.householdApi.data_bridges_client.ApiClient"
# ) as mock_api_client:

# result = client.get_household_survey(
# api_key="test_key",
# survey_id=123,
# access_type="full",
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant