Conversation
There was a problem hiding this comment.
An organization admin can view or raise the cap at claude.ai/admin-settings/claude-code. The cap resets at the start of the next billing period.
Once the cap resets or is raised, reopen this pull request to trigger a review.
There was a problem hiding this comment.
⚠️ API Contract Change Detected
This PR modifies the public API contract of the CyborgDB Python SDK.
Please provide an explanation for this change:
- Why is this change necessary?
- Is this a breaking change or backward compatible?
- Have you updated the documentation?
This review must be dismissed or addressed before the PR can be merged.
ahellegit
approved these changes
Apr 29, 2026
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.
Description (Required)
Two related fixes bundled into one PR:
Test fixes for the
query()default-include change.Query()incyborgdb-core/cyborgdb-servicewas changed to return onlyidby default (previously returnedid,distance, andmetadatawhen noincludeargument was provided). Updated affected tests intest_api_contract.py,test_client.py, andtest_concurrency.pyto passinclude=["distance"](or["distance", "metadata"]) wherever they assert on those keys. Also added a new contract test that pins the new default behavior —query()with noincludereturns only{id}— mirroring the test added incyborgdb-js.CI workflow migration from 1Password
PIP_EXTRA_INDEX_URLto AWS CodeArtifact. ThePIP_EXTRA_INDEX_URLfield was removed from theCyborgDB Dev1Password item, breakingtest.ymlandbuild_and_package_wheels.yml. Migrated both workflows to the same CodeArtifact-via-OIDC pattern already used incyborgdb-js: loadCA_AWS_ACCOUNT_IDfrom 1Password, assume an IAM role via OIDC, fetch a CodeArtifact authorization token, and export the resulting URL asPIP_INDEX_URL. Copied thecodeartifact-pip-urlcomposite action fromcyborgdb-jsinto.github/workflows/actions/.Related Issue (Required)
Mirrors fixes already landed in
cyborgdb-js:f161735"distance fixed in tests" and38b917b"added test to make sure we should only return ids from query".cyborgdb-js/.github/workflows/test.ymland the sharedcodeartifact-pip-urlcomposite action.Brings the Python SDK test suite and CI workflows in line with the new server-side default
includebehavior and the new package-index auth pattern.Scope of This PR (Required)
If "Other" was selected, describe the scope here:
CI/CD: migrating the GitHub Actions workflows from a static 1Password pip-index secret to AWS CodeArtifact via OIDC role assumption.
Test Changes (Required)
Added/Removed Tests:
Updated:
tests/test_api_contract.py::TestAPIContract::test_15_encrypted_index_querytests/test_api_contract.py::TestAPIContract::test_16_encrypted_index_query_patternstests/test_api_contract.py::TestAPIContract::test_18_encrypted_index_query_binarytests/test_client.py::ClientIntegrationTest::test_upsert_and_querytests/test_client.py::ClientIntegrationTest::test_upsert_with_numpy_arraytests/test_client.py::ClientIntegrationTest::test_query_with_2d_numpy_arraytests/test_concurrency.py::TestConcurrentReadsAndWrites::test_queries_during_upsertstests/test_concurrency.py::TestConcurrentReadsAndWrites::test_deletes_during_queriestests/test_concurrency.py::TestStressHighConcurrency::test_20_threads_200_vectors_eachAdded:
New default-include assertion inside
test_15_encrypted_index_queryverifyingquery()with noincludearg returns only{id}(Python equivalent of the newcyborgdb-js"should not return distance by default" test).No test changes
Reason:
Query()no longer returnsdistanceandmetadataby default. Tests that asserted on those keys without passing them inincludewere failing. Updated each affected call site to pass the appropriateincludeargument and pinned the new default behavior with an explicit contract assertion.Breaking Changes
This PR introduces breaking changes
If checked, please describe:
Impact:
Migration Steps:
(No SDK code changes in this PR — the breaking change in
query()'s defaultincludewas made incyborgdb-core/cyborgdb-service. This PR only updates the Python SDK's tests to match the new contract and migrates the CI workflows to AWS CodeArtifact.)Performance & Security Considerations
CI auth change: the
CyborgGitHubActionsS3RoleIAM trust policy must includecyborginc/cyborgdb-pyas a permitted OIDC subject. The same role is already used bycyborgdb-js; if it is currently scoped to that repo only, its trust policy needs to be widened (one-time IAM change, not a code change in this PR).Checklist
Additional Context
test_api_contract.py,test_client.py, andtest_concurrency.pysuites pass against a localcyborgdb-serviceinstance.cyborgdb-jsfiles (api_contract.test.ts,basic_test.test.ts,concurrency_test.test.ts) to confirm parity — every Python query assertion that checksdistanceormetadatanow passes those keys viainclude, matching the JS suite's contract.permissions: id-token: writeto thetestjob in both workflow files (required for OIDC), copiedcodeartifact-pip-url/action.ymlfromcyborgdb-js, and dropped the stale--extra-index-urlflags from thepip installsteps. Thebuild_and_package_wheels.ymlenv != 'prod'conditional is preserved so prod releases still resolvecyborgdb-servicefrom public PyPI.Information regarding test changes will be automatically stored in the test log.