Repository navigation
chore: regenerate Zero Friction SDK for v1.1 - #15
Draft
thom-techlete wants to merge 3 commits into
Draft
thom-techlete wants to merge 3 commits into
thom-techlete wants to merge 3 commits into
Conversation
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
openapi_specs/.7.13.0..openapi-generator/FILESmanifest.DefaultApisurface.zero-frictiondistribution so installed generated code always matches the selected branch or tag.OpenAPI changes versus
mainAll eight specifications changed:
The dominant generated change is tag normalization: all eight clients now expose
DefaultApirather than the former resource-specific API classes. There are also response-type changes, model renames/removals, enum changes, and required parameter/header changes. No security-scheme changes were detected.Compatibility impact
Potentially breaking:
DefaultApiin all eight clients.Definitely breaking for existing consumers:
contracts_api,attachments_api, andbilling_relations_apiare no longer generated; callers must migrate todefault_apiand the new operation signatures.CustomersApigenerated module was removed.Compatibility updates in this PR:
zero_friction/core/sdk_client.pyhandles generated Masterdatadefault_apiwhile retaining the patched publiccustomers_apialias.zero_friction/patches/patched_customers_api.pytargetsDefaultApiandApiResponseDTOOfCustomerDTO.sdk.masterdata_client.default_api.Packaging change
The root package no longer declares the eight generated clients as Git URL dependencies. It directly includes their packages from
sdk/*_client/*_clientand declares their shared runtime dependencies.This makes installation ref-aware without embedding a branch ref in
pyproject.toml:Projects satisfied with v1 should pin:
Projects testing this candidate should temporarily use:
The standalone generated client distributions should not be installed separately alongside
zero-friction.Generation details
The documented Docker generation loop was used with
openapitools/openapi-generator-cli:v7.13.0. The pinned generator rejected two duplicate query-parameter definitions in the supplied Masterdata snapshot:POST /Contracts/filter/bulkaddservicecontextPOST /Contracts/filter/bulkremoveservicecontextThe vendor specs were not modified. Generation therefore used the explicit
--skip-validate-specoption, with the issue documented here for follow-up with the spec owner.Verification
Passed:
uv lockuv syncuv lock --checkuv run pytest: 5 passedKnown validation limitation:
pip-auditreports five advisories in environment packages (pipandtornado), and the local unpublishedzero-frictionpackage cannot be audited from PyPI. This is unchanged by the SDK packaging work.Downstream validation required before merge
For each dependent project testing this candidate, test installation, imports, generated model names, API attributes, method signatures, unified
zero_frictionwrapper usage, full tests, and relevant integration/smoke tests. Search first for removed resource API classes and model symbols.Projects that are satisfied with v1 must remain pinned to
v1so they do not followmainwhen v1.1 becomes the head commit after merge.Release gate
This is a draft candidate for
v1.1. Do not create or move thev1.1tag until downstream projects are validated, this PR is reviewed, and the branch is merged tomain.