Skip to content

fix(spec): correct stale "passed to mysql2 verbatim" doc comment on MysqlConfigSchema.ssl#9169

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
os-zhuang merged 1 commit into from
Aug 16, 2026
+11 −1
Merged

fix(spec): correct stale "passed to mysql2 verbatim" doc comment on MysqlConfigSchema.ssl #9169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/mysql-ssl-doc-comment-verbatim.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@objectstack/spec": patch
---

fix(spec): correct the stale "passed to `mysql2` verbatim" TS doc comment on `MysqlConfigSchema.ssl` (mysql.zod.ts) — since #8874, the resolved `true` is translated into mysql2's own default TLS options (`rejectUnauthorized: true`) before mysql2 sees it, because mysql2 rejects a bare boolean outright. Comment-only; accept/reject behaviour is unchanged, and the shared `DriverSslToggleSchema.describe()` (correct for the postgres/turso arms, which do pass the boolean verbatim) is untouched (#9125)
7 changes: 6 additions & 1 deletion packages/spec/src/data/driver/mysql.zod.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -112,7 +112,12 @@ export const MysqlConfigSchema = lazySchema(() => strictObject(
*/
password: refusedInlineCredentialKey('password', 'Password'),

/** TLS settings, passed to `mysql2` verbatim. */
/**
* TLS on/off. `true` reaches `mysql2` as its own default TLS options
* (`rejectUnauthorized: true`), not the bare boolean — mysql2 rejects a
* boolean outright (#8874). Certificates and verification live in the
* datasource-level `ssl` block.
*/
ssl: DriverSslToggleSchema.optional().meta({ title: 'Use SSL/TLS' }),

/** Dev-only, loosen-only schema self-heal (#2186). */
Expand Down
Loading