QVAC-23972 feat[api]: describe classification modelConfig fields - #4061
Open
lauripiisang wants to merge 1 commit into
Open
QVAC-23972 feat[api]: describe classification modelConfig fields#4061lauripiisang wants to merge 1 commit into
lauripiisang wants to merge 1 commit into
Conversation
- Add .describe() to classificationConfigSchema fields (modelPath, topK, nativeLogger); text promoted from the existing JSDoc so it now flows into the contract - Sourced from @qvac/classification-ggml index.d.ts / README - Regenerate contract/schema.json and the Python generated models
Contributor
Review StatusCurrent Status: ❌ PENDING Pending reviews: Needs 1 Management or Team Lead, and 1 more from Management, Team Lead, or Member. |
Contributor
License compliance — cleanNo new dependency license findings in this PR. Warn-only (shadow) mode — this check does not block merges yet. Updated automatically by the canonical license compliance workflow. NOTICE presence (advisory)Missing NOTICE (advisory, does not block):
|
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.
🎯 What problem does this PR solve?
ggml-classification)modelConfigfields carried only JSDoc comments, which don't reach the generated contract (contract/schema.json) — soqvac configure, the typed-client generators, and the Python generator had nothing to say about what any field means.📝 How does it solve it?
.describe()to everyclassificationConfigSchemafield:modelPath,topK,nativeLogger.@qvac/classification-ggmlindex.d.ts/ README — no invented semantics.contract/schema.jsonand the Python generated models.Part of QVAC-23933.
🧪 How was it tested?
bun run contract:exportregenerated;contract:check,typecheck,lint,format, and fulltest:unit(incl. contract-export freshness) pass.packages/inferencetypecheck+lintpass.packages/sdk-pythongenerate.py --checkpasses.🔌 API Changes
Additive only — descriptions are now readable off the contract and typed clients: