feat(schema): bump ACP schema to v1.19.0 (extensible unions + lenient deserialization)#117
Open
michelTho wants to merge 4 commits into
Open
feat(schema): bump ACP schema to v1.19.0 (extensible unions + lenient deserialization)#117michelTho wants to merge 4 commits into
michelTho wants to merge 4 commits into
Conversation
…1.19.0 Bump schema-v1.16.0 -> schema-v1.19.0. v1.18.0 introduced an "extensible union" idiom (known const-tagged variants plus a "custom or future" catch-all member) that datamodel-codegen cannot express in a discriminated union, so it emitted broken placeholder literals. Codegen support (scripts/gen_schema.py): - _normalize_catchall_unions: strip the discriminator and collapse each catch-all member to a permissive object, so codegen emits a plain, payload-preserving union. - Inject a field_validator per catch-all that rejects the known discriminator values (recovered from the schema's `not` clause), so a malformed known variant fails instead of silently parsing as custom (mirrors the TS SDK's excludeKnownTags). - EXTENSIBLE_UNIONS map + drift assertion so changes to the union set fail loudly. - RENAME_MAP names for the 5 new variants; alias template updated so the parse adapters include the catch-all. Export the 3 new Elicitation*/Create* variants from the acp package. Add unit and behavioral regression tests. Generated by Mistral Vibe. Co-Authored-By: Mistral Vibe <vibe@mistral.ai>
…tems The schema declares lenient-deserialization hints that generated Pydantic models cannot express directly: x-deserialize-default-on-error (salvage a malformed field to its default) on 379 fields, and x-deserialize-skip-invalid-items (drop bad array items) on 35. Mirrors the TypeScript SDK's src/schema-deserialize.ts. - src/acp/_deserialize.py: leaf module (imports only pydantic, so schema.py can depend on it without a layering cycle) with salvage_on_error and skip_invalid_items. - gen_schema.py injects field_validator(mode="wrap") methods: `_meta` once on the shared BaseModel via check_fields=False (inherited everywhere); non-meta fields per $def grouped by fallback (None / [] / schema default); union-def common props target the member variant classes. - Generated schema.py uses an absolute import (from acp._deserialize) because gen_signature.py loads the module standalone, where relative imports cannot resolve. Add unit tests (fallback rules, spec extraction) and behavioral round-trips. Generated by Mistral Vibe. Co-Authored-By: Mistral Vibe <vibe@mistral.ai>
Adding CreateOtherElicitationRequest to the CreateElicitationRequest union (so custom/future modes parse) made a previously-unreachable `raise TypeError` in the client router reachable: an incoming custom mode now parses, then _mode_from_create_elicitation_request hit the fallthrough and surfaced as an opaque -32603 internal error (plus a logged traceback). Raise RequestError.invalid_params instead, so a client that can't render an unknown mode declines with a clean -32602. Adds a regression test. Generated by Mistral Vibe. Co-Authored-By: Mistral Vibe <vibe@mistral.ai>
pretty-format-json (pre-commit) rewrites schema/schema.json and schema/meta.json because gen_all wrote them via json.dumps(indent=2) with no trailing newline. Content is otherwise identical to the hook's output, so add the newline in download_schema (keeping regeneration idempotent) and to the committed files. Generated by Mistral Vibe. Co-Authored-By: Mistral Vibe <vibe@mistral.ai>
Contributor
Author
|
Hey @PsiACE I took the liberty to propose something for bumping schema to v1.19.0, if it's ok for you. If you have other things you'd want looked at, don't hesitate to tell me! Happy to get a review on this one, as it's not that small |
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
1 participant
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
Bumps the ACP schema
schema-v1.16.0 → v1.19.0and adds the codegen support v1.18+ requires — a plain bump produces invalid models, because v1.18 added two idiomsdatamodel-codegencan't express:CreateElicitationRequest/Response,ElicitationPropertySchema,MultiSelectItems) — known variants + a "custom/future" catch-all. Codegen strips the discriminator, preserves the catch-all payload, and injects a validator that rejects known tags so a malformed known variant errors instead of silently parsing as custom.x-deserialize-default-on-error(salvage a bad field to its default) andx-deserialize-skip-invalid-items(drop bad array items) viasrc/acp/_deserialize.py.New public types:
CreateOtherElicitationRequest,OtherElicitationResponse,ElicitationOtherPropertySchema. Approach mirrors the TypeScript SDK'sschema-deserialize.ts.Also fixes an edge case this change exposed: an incoming unknown elicitation mode now returns a clean
invalid_params(-32602) rather than an opaque internal error. Broader dispatch hardening for unknown/forward-compat variants is tracked in a follow-up.Related issues
N/A for the bump. A follow-up issue (dispatch hardening for unknown variants) will be linked once filed.
Testing
pytest --doctest-modules→ 142 passed, 1 skipped. Adds unit tests (fallback rules, tag extraction), behavioral round-trips (catch-all routing, field salvage, item skip), and a dispatch regression test (unknown mode → clean error).ruff check,ruff format --check,ty check→ clean.ACP_SCHEMA_VERSION=schema-v1.19.0 make gen-all; regeneration is idempotent (re-running is a no-op).-32602.Docs & screenshots
None needed — schema/types are generated and there's no prose doc referencing them; the new types are additive and self-describing.
Checklist
feat:,fix:).make gen-all) are called out if applicable.