Repository navigation
docs(swift-sdk): show how to identify the connected instance - #614
Merged
Merged
Conversation
3 tasks done
aicayzer
commented
Oct 24, 2026
aicayzer
left a comment
Contributor
Author
There was a problem hiding this comment.
The example matches the released API in marfa-swift v0.0.29 (Server.instanceDescription()), and it was run against a real instance. Merging now the package is released.
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.
Summary
Show Swift app authors how to display the connected instance's name and identifier with
Server.instanceDescription(). This documents withmarfa/marfa-swift#362, which addresses withmarfa/marfa-swift#358.Changes
/swift-sdkbeside the server and connection APIs.Testing
pnpm test: all 700 tests passed, including content and link checks.pnpm build,pnpm build:status, andpnpm types:checkpassed.git diff --checkpassed. This documentation-only change needs no new behavioral test; the SDK pull request carries the HTTP tests.Notes for reviewers
Wait to merge until the API in withmarfa/marfa-swift#362 is released: the page directs readers to install the latest release, and v0.0.28 contains the core export but not this public SDK wrapper. Do not merge either pull request as part of this task.
Review depth: checked the example against the SDK source and a real instance, and the claims against the pinned core and the contract's public description rules. The existing instance reference and settings guide need no changes. No generated files changed.
The open #611 changes later sections of the same page. This change adds a separate section after the server API table and does not depend on that branch.
Checklist