Repository navigation
docs(semantic-layer): define SDK surface and release policy - #45906
Draft
mikebridge wants to merge 2 commits into
Draft
mikebridge wants to merge 2 commits into
mikebridge wants to merge 2 commits into
Conversation
✅ Deploy Preview for superset-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #45906 +/- ##
==========================================
+ Coverage 84.73% 84.75% +0.02%
==========================================
Files 3069 3074 +5
Lines 205771 206418 +647
Branches 48396 48399 +3
==========================================
+ Hits 174354 174946 +592
- Misses 28123 28178 +55
Partials 3294 3294
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
SUMMARY
TL;DR: Define which
apache-superset-coreimports semantic providers and host extensions can rely on, and how package versions and deprecations will be communicated before the next release.Background: The Python core package mixes provider contracts and host-bound persistence interfaces. Its dependency guide described the whole package as stable without naming the supported imports, and its package changelog did not record releases.
Problem: Extension authors could treat incidental module names as supported API. The current package changelog also gave no guidance for upcoming contract changes and deprecations.
Changes: Document the provider-facing import paths and symbols separately from host-extension models and DAOs; state that the host supplies
REQUESTandBACKGROUNDorigins while explicit MCP, async and export binders are deferred; identify the reserved credentials channel andCONFIGorigin; state the pre-1.0 version and deprecation policy; add an unreleased0.2.0package changelog entry and pointpyproject.tomlto that changelog. The installed package version stays at0.1.0until the coordinated core-package release bump. This PR changes documentation and package metadata only. Runtime export declarations follow after the provider boundary work lands.BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
Not applicable; no UI change.
TESTING INSTRUCTIONS
Review the
apache-superset-coreversion and changelog URL insuperset-core/pyproject.toml, then check the unreleased package changelog entry and the extension dependency guide. Confirm that the listed provider symbols exist in their named modules and that the origin wording matches the host's request/background inference. Changed-file pre-commit and metadata/symbol checks passed locally.ADDITIONAL INFORMATION
The
0.2.0changelog entry is marked unreleased; this PR does not publish a distribution or change runtime imports.