feat: document connectionId parameter for the iOS SDK

[victoreronmosele]

Description (required)

This PR document the connectionId parameter and its usage in the Kinde iOS SDK.

Related issues & labels (optional)

• SDK Implementation PR: feat: add support for connectionId parameter kinde-sdk-ios#38

Summary by CodeRabbit

• Documentation
  • Added guidance on using custom authentication pages with the iOS SDK.
  • Provided examples demonstrating passing loginHint and connectionId to prepopulate fields and bypass the initial login page.
  • Updated public usage docs to reflect new optional parameters on login, register, and create organization flows.
  • Minor wording and formatting tweaks for clarity.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Added documentation to the iOS SDK guide describing passing connectionId to login, register, and createOrg, and using loginHint to bypass the initial Kinde login page; updated public API usage examples and parameter lists to include the new optional arguments.

Changes

Cohort / File(s)	Summary
iOS SDK documentation src/content/docs/developer-tools/sdks/native/ios-sdk.mdx	Added "Use custom auth pages" section with Swift examples showing connectionId for login, register, and createOrg; added subsection on bypassing initial login via loginHint and prepopulation note; minor wording and formatting tweaks.
Public API signatures / docs ...KindeSDKAPI.auth (method docs)	Updated documented method signatures to add optional parameters: login(orgCode?: String, loginHint?: String, connectionId?: String), register(orgCode?: String, loginHint?: String, planInterest?: String, pricingTableKey?: String, connectionId?: String), and createOrg(orgName: String, connectionId?: String).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐇 I hopped through Swift and docs so neat,

Poked a hint where logins meet,
A connection ID, tucked in tight,
Skips the door and sets things right,
🥕— rabbit cheers for tidy bytes.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and specifically describes the main change: documenting the connectionId parameter for the iOS SDK, which aligns with the changeset that adds documentation sections, code examples, and parameter updates.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feat/ios-sdk-connection-id-parameter

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 4

📜 Review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2e4180c and 98734b0.

📒 Files selected for processing (1)

• src/content/docs/developer-tools/sdks/native/ios-sdk.mdx

[cloudflare-workers-and-pages]

Deploying kinde-docs-preview with    Cloudflare Pages

Latest commit:	0c6ac3d
Status:	✅  Deploy successful!
Preview URL:	https://b5dbbdba.kinde-docs-preview.pages.dev
Branch Preview URL:	https://feat-ios-sdk-connection-id-p.kinde-docs-preview.pages.dev

View logs

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (1)

src/content/docs/developer-tools/sdks/native/ios-sdk.mdx (1)

268-274: Consider showing CONNECTION_ID as a string literal for clarity.

While using a constant name like CONNECTION_ID is valid Swift, showing it as a string literal in the example would help developers immediately understand the expected value format. This is especially helpful since the second code block (lines 282-292) shows concrete examples for loginHint.

🔎 Suggested improvement

 ```swift
-KindeSDKAPI.auth.login(connectionId: CONNECTION_ID)
+KindeSDKAPI.auth.login(connectionId: "conn_123456789")
 
-KindeSDKAPI.auth.register(connectionId: CONNECTION_ID)
+KindeSDKAPI.auth.register(connectionId: "conn_123456789")
 
-KindeSDKAPI.auth.createOrg(connectionId: CONNECTION_ID)
+KindeSDKAPI.auth.createOrg(connectionId: "conn_123456789")

And add a note before line 268:
```markdown
Replace `conn_123456789` with your specific connection identifier from the Kinde dashboard.

📜 Review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 98734b0 and c639e6c.

📒 Files selected for processing (1)

• src/content/docs/developer-tools/sdks/native/ios-sdk.mdx

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (2)

src/content/docs/developer-tools/sdks/native/ios-sdk.mdx (2)

671-682: Consider adding usage examples for the new parameters.

The parameter list correctly includes loginHint and connectionId, but the usage examples only demonstrate basic usage and orgCode. While these parameters are shown in the earlier "Use custom auth pages" section (lines 269-273, 283-292), adding a brief example here would improve consistency and make the API reference more self-contained.

Example usage to add

// With connectionId
KindeSDKAPI.auth.login(connectionId: "conn_123")

// With loginHint and connectionId  
KindeSDKAPI.auth.login(loginHint: "user@example.com", connectionId: "conn_123")

---

703-706: Consider adding usage examples for the new parameters.

Similar to the login method, the register usage examples could benefit from demonstrating the newly documented parameters (loginHint, connectionId, planInterest, pricingTableKey) to maintain consistency with the parameter list and improve the API reference completeness.

📜 Review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c639e6c and 0c6ac3d.

📒 Files selected for processing (1)

• src/content/docs/developer-tools/sdks/native/ios-sdk.mdx

🔇 Additional comments (3)

src/content/docs/developer-tools/sdks/native/ios-sdk.mdx (3)

263-277: LGTM! Clear documentation of connectionId parameter.

The section clearly documents the connectionId parameter usage with appropriate Swift examples and links to relevant documentation for obtaining the connection ID.

---

278-297: LGTM! Helpful examples with multiple formats.

The subsection effectively demonstrates the loginHint parameter with both email and phone number formats, and appropriately links to related documentation for context.

---

753-754: LGTM! Parameter correctly documented.

The connectionId parameter is appropriately added as an optional parameter. The usage example at line 273 in the earlier section demonstrates how to use it, so the API reference is consistent.