Skip to content

docs(swift-sdk): say what hydration does with a changed declared type - #628

Merged
aicayzer merged 2 commits into
mainfrom
fix/declare-replaces
Oct 25, 2026
Merged

aicayzer merged 2 commits into
mainfrom
fix/declare-replaces

Conversation

@aicayzer

Copy link
Copy Markdown
Contributor

Summary

The Swift SDK page said hydration registers declared types the instance lacks. It now also says a hydration replaces a declared app.* type the instance holds in another definition, how the server judges "another", what happens when the server refuses, and the new replacedTypes and unreplacedTypes report fields. Documents withmarfa/marfa#2400, which closes withmarfa/marfa#2398.

Changes

  • swift-sdk.mdx: the declareTypes(_:) paragraph becomes a short list of what a hydration does to registered, replaced and refused types.
  • No other page describes declaring types. The TypeScript SDK page covers the HTTP client, which registers and replaces types by explicit calls.

Testing

  • Checked every claim against the marfa pull request's contract statements and the server's PUT /types/{id} and POST /types/normalize descriptions.
  • Not run: the docs build. CI may fail until the Marfa release that contains #2400 is synced into the docs.

Notes for reviewers

Merge only after that release is synced. The Swift package must expose replacedTypes and unreplacedTypes first for the page to be true of the package.

Checklist

  • The title is a scoped Conventional Commit.
  • Docs still say what is true after this change.

@aicayzer
aicayzer force-pushed the fix/declare-replaces branch from 227c1ee to 4da48ba Compare October 25, 2026 12:37
@aicayzer
aicayzer marked this pull request as ready for review October 25, 2026 12:37
@aicayzer

Copy link
Copy Markdown
Contributor Author

Rebased onto main after #633 and the v0.0.36 sync (#635). Review depth: checks only; a small docs change describing merged behavior, checked against the v0.0.36 tag.

@aicayzer
aicayzer merged commit 689fa45 into main Oct 25, 2026
3 checks passed
@aicayzer
aicayzer deleted the fix/declare-replaces branch October 25, 2026 12:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Declaring an app's types replaces a definition the app has changed

1 participant