[codex] Fix Python SDK documentation examples#249
Draft
ayush-shah wants to merge 2 commits into
Draft
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Member
Author
|
I found one semantic mismatch in the new Topic DELETE example while validating against the OpenMetadata service code. In rest_client.delete(
"/topics/name/sample_kafka.address_book",
data={"hardDelete": True},
)The API reads rest_client.delete("/topics/name/sample_kafka.address_book?hardDelete=true") |
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
Fix Python SDK examples and API guide snippets across the 1.11, 1.12, and 1.13 docs to match the SDK facades exposed by current releases.
What changed
Tables,DatabaseServices, andDataContractsinstead of missing singular classes.EntityList.entities,after, andbefore, and removed references to missing helpers such asTableListParamsandauto_paging_iterable().Tables.update(entity)rather than passing an ID separately.patch; low-level patch operations should use the configured OpenMetadata client.metadata.sdk.configure(...)andmetadata.sdk.client().Lineage.get_entity_lineage(...),AddLineageRequest,EntitiesEdge,EntityReference, andLineage.add_lineage_request(...).MlModelServicesis not exported, and Topic docs use the configured client becauseTopicsis not exported by the Python SDK.CodeLayoutcomponent used by API reference pages.Validation
openmetadata-ingestion==1.11.13.0andopenmetadata-ingestion==1.12.8.8in isolated Python 3.11 environments.1.12.8and checked source behavior against OpenMetadata/openmetadata-collate refs for 1.11, 1.12, and 1.13.https://sandbox-beta.open-metadata.org/apiusing the 1.12.8 SDK:Tables.list(limit=2, fields=["owners", "tags"])returned anEntityListwithentitiesand nodataattribute.git diff --checkTableListParams,auto_paging_iterable, singularTablefacade usage, incorrectTables.update(str(...)), missingpatch, staleget_client, and oldEntityListtext.Topicsfacade imports remain, Topic Python code fences parse, andCreateTopicRequestimports/construction were validated against 1.11.13.0 and 1.12.8.8.rtk npm run broken-linksrtk mint openapi-check api-reference/openapi.jsonKnown repository-wide checks
rtk mint validatestill fails with 217 existing warnings, mainly missing connector snippets underv1.13.x-SNAPSHOTand unsupported external snippet imports such asreact/prop-types.rtk mint a11ystill fails repository-wide due the existing#6938EFdark-background contrast issue and 1244 pre-existing missing alt/label issues across generated/reference pages.