docs(migrate): add v12 → v13 upgrade guide#40
Merged
Conversation
mx-core v13.0.0 ships the V3 response envelope, snake_case schema, named views, and bumps the route prefix from `/api/v2/*` to `/api/v3/*`. Document the upgrade path: server upgrade is mechanical (no data migration), mx-admin must move to v8 in lockstep, and `@mx-space/api-client@5`'s legacy adapter lets frontend consumers stay on V1 wire shape while they migrate endpoint-by-endpoint. Hook the new page into the migrate section meta and the overview index card.
SafeDep Report Summary
No dependency changes detected. Nothing to scan. This report is generated by SafeDep Github App |
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
content/docs/migrate/v12-to-v13.mdxdocuments the v12 → v13 upgrade path.{ data, meta }, snake_case, named views) and bumps the route prefix/api/v2/*→/api/v3/*. The guide covers server upgrade (Docker + source), mx-admin v8 sync, frontend migration via@mx-space/api-client@5legacy adapter, direct-REST consumer changes, rollback, and FAQ.migrate/meta.json(afterindex, beforev11-to-v12) and add a card to the migrate overview.Test plan
pnpm devand visit/docs/migrate— confirm the v12 → v13 card appears and links work./docs/migrate/v12-to-v13— confirm Callouts and Cards render correctly.