Skip to content

docs(swift-sdk): show how to identify the connected instance - #614

Merged
aicayzer merged 1 commit into
mainfrom
docs/swift-instance-description
Oct 24, 2026
Merged

aicayzer merged 1 commit into
mainfrom
docs/swift-instance-description

Conversation

@aicayzer

Copy link
Copy Markdown
Contributor

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

  • Add a short example to /swift-sdk beside the server and connection APIs.
  • Explain the anonymous read, default name, path-prefix preservation, failure behavior, and limits of what the description establishes.
  • Link to the existing public instance operation for the endpoint reference.

Testing

  • pnpm test: all 700 tests passed, including content and link checks.
  • pnpm build, pnpm build:status, and pnpm types:check passed.
  • Checked the prerendered Swift SDK page contains the new section.
  • Ran the Swift example against a real demo instance through the SDK and released core framework, with an empty key. It returned the instance name and identifier.
  • git diff --check passed. 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

  • The title is a scoped Conventional Commit.
  • New behavior has a test that was seen failing first, or no test was needed and the reason is above.
  • Docs, comments and the contract still say what is true after this change.

@aicayzer aicayzer left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@aicayzer
aicayzer merged commit 2fe2554 into main Oct 24, 2026
3 checks passed
@aicayzer
aicayzer deleted the docs/swift-instance-description branch October 24, 2026 09:48
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.

1 participant