docs: update data validation guide for schema.ts/schema.json deprecation#5651
Open
SapneshNaik wants to merge 2 commits intomasterfrom
Open
docs: update data validation guide for schema.ts/schema.json deprecation#5651SapneshNaik wants to merge 2 commits intomasterfrom
schema.ts/schema.json deprecation#5651SapneshNaik wants to merge 2 commits intomasterfrom
Conversation
![propel-code-bot[bot]](https://waps.l3s.uni-hannover.de/live/im_/https://avatars.githubusercontent.com/in/1179004?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
…ma.ts` and `.nango/schema.json` (removal date: April 16, 2026) - Updated the data validation docs to reflect the new approach **`docs/updates/dev.mdx`** - Added March 16, 2026 deprecation notice with timeline, impact, and migration steps - `schema.ts` → export types via `z.infer` from sync/action files - `schema.json` → use `json_schema` property in `nango.json`, or `z.toJSONSchema()` from Zod v4 **`docs/implementation-guides/platform/functions/data-validation.mdx`** - Rewrote "Available schema files" section to describe `nango.json` with its `json_schema` property - Added simplified `nango.json` example showing the `json_schema` structure - Added `<Warning>` banner linking to the dev update - Removed multi-language `schema.json` examples (TypeScript/Ajv, Go, Rust, Python) and "Custom validation" section: these referenced the deprecated file directly. If users want to do it, they will first need to compile the schema from nango.json manually before using them with other languages. - Replaced with three new sections: "Using JSON Schema from `nango.json`", "Generating JSON Schema from Zod" (`z.toJSONSchema()`), and "Exporting TypeScript types" (`z.infer`) - The `nango.json` file generation is unchanged but now includes `json_schema` per sync/action
SapneshNaik
force-pushed
the
schema_ts_schema_json_deprecation
branch
from
0443ad4 to
9fc6d79
Compare
Contributor
There was a problem hiding this comment.
Review completed with no issues identified in the documentation updates.
Status: No Issues Found | Risk: Low
Review Details
📁 1 files reviewed | 💬 0 comments
Instruction Files
├── .claude/
│ ├── agents/
│ │ └── nango-docs-migrator.md
│ └── skills/
│ ├── agent-builder-skill/
│ │ ├── EXAMPLES.md
│ │ └── SKILL.md
│ ├── creating-integration-docs/
│ │ └── SKILL.md
│ └── creating-skills-skill/
│ └── SKILL.md
├── AGENTS.md
└── GEMINI.md
kaposke
approved these changes
Mar 16, 2026
Contributor
kaposke
left a comment
kaposke
left a comment
There was a problem hiding this comment.
LGTM but also wait for Bastien's review
bastienbeurier
requested changes
Mar 17, 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
3 participants
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
Updates the data validation docs to reflect the upcoming removal of
.nango/schema.tsand.nango/schema.json(date TBD).Changes
nango.jsonwith its per-sync/actionjson_schemapropertynango.jsonexample showing thejson_schemastructure<Warning>banner for the deprecation with link to dev updatesschema.jsonvalidation examples (TypeScript/Ajv, Go, Rust, Python) and "Custom validation" code generation section; these referenced the deprecated file directly.nango.json" section with a note on compatible validators per languagez.toJSONSchema()z.inferTBD:
I mentioned the upcoming change date as April 16, 2026. Please let me know if its different.
Preview Link
https://nango-schema-ts-schema-json-deprecation.mintlify.app/implementation-guides/platform/functions/data-validation
It also reorganizes the data validation guide to clearly separate function-level validation from app-level validation.
This summary was automatically generated by @propel-code-bot