Skip to content

Comments

docs(ios): make proxyEndpoint optional in Swift initializer#1632

Merged
aleks-tpom6oh merged 1 commit intomainfrom
fix/ios-proxy-endpoint-optional
Feb 19, 2026
Merged

docs(ios): make proxyEndpoint optional in Swift initializer#1632
aleks-tpom6oh merged 1 commit intomainfrom
fix/ios-proxy-endpoint-optional

Conversation

@aleks-tpom6oh
Copy link
Contributor

@aleks-tpom6oh aleks-tpom6oh commented Feb 19, 2026

Summary

  • Makes proxyEndpoint parameter optional (String?) in the Swift initializer signature, matching the actual SDK API

Addresses review feedback from #1630 (comment)

Test plan

  • Verify the Swift initializer signature matches the SDK source

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated Avo Inspector iOS SDK documentation. The proxy endpoint parameter in the initializer is now optional, providing greater flexibility in SDK configuration.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@vercel
Copy link

vercel bot commented Feb 19, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Feb 19, 2026 3:32pm

Request Review

@coderabbitai
Copy link

coderabbitai bot commented Feb 19, 2026

📝 Walkthrough

Walkthrough

The iOS SDK documentation for AvoInspector has been updated to reflect that the proxyEndpoint parameter in the Swift initializer signature is now optional (String?) instead of required (String), allowing callers to omit this argument when initializing the inspector.

Changes

Cohort / File(s) Summary
iOS SDK Documentation
pages/reference/avo-inspector-sdks/ios.mdx
Updated Swift initializer signature to make proxyEndpoint parameter optional (String?) rather than required (String).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A parameter once bound, now set free,
Optional now—proxyEndpoint can be,
Flexibility blooms in this SDK's design,
Making constructors more gentle and fine! ✨

🚥 Pre-merge checks | ✅ 3
✅ 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 accurately describes the main change: making the proxyEndpoint parameter optional in the Swift initializer, which matches the single documentation update in the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/ios-proxy-endpoint-optional

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

@logason
Copy link
Member

logason commented Feb 19, 2026

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
pages/reference/avo-inspector-sdks/ios.mdx (1)

43-56: ⚠️ Potential issue | 🟡 Minor

Align parameter docs with the new optional proxyEndpoint.

Line 44 marks proxyEndpoint as String?, but the parameter list still describes it as required String. Update the bullets to match the signature so readers know the argument is optional.

✏️ Suggested doc tweak
-> - `String proxyEndpoint` - proxy endpoint used by the SDK for network requests
+> - `String? proxyEndpoint` (optional) - proxy endpoint used by the SDK for network requests
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@pages/reference/avo-inspector-sdks/ios.mdx` around lines 43 - 56, The
parameter docs for the initializers init(apiKey: String, env: AvoInspectorEnv,
proxyEndpoint: String?, publicEncryptionKey: String?) and -(instancetype)
initWithApiKey:env:proxyEndpoint:publicEncryptionKey: are out of sync: change
the `proxyEndpoint` bullet to indicate it is optional (e.g., `String?
proxyEndpoint` or "optional") and ensure the `publicEncryptionKey` bullet
remains marked nullable/optional; keep the description text consistent with
optional semantics so readers know they can omit the proxyEndpoint argument.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Outside diff comments:
In `@pages/reference/avo-inspector-sdks/ios.mdx`:
- Around line 43-56: The parameter docs for the initializers init(apiKey:
String, env: AvoInspectorEnv, proxyEndpoint: String?, publicEncryptionKey:
String?) and -(instancetype)
initWithApiKey:env:proxyEndpoint:publicEncryptionKey: are out of sync: change
the `proxyEndpoint` bullet to indicate it is optional (e.g., `String?
proxyEndpoint` or "optional") and ensure the `publicEncryptionKey` bullet
remains marked nullable/optional; keep the description text consistent with
optional semantics so readers know they can omit the proxyEndpoint argument.

@aleks-tpom6oh aleks-tpom6oh merged commit 85db91a into main Feb 19, 2026
4 checks passed
@aleks-tpom6oh aleks-tpom6oh deleted the fix/ios-proxy-endpoint-optional branch February 19, 2026 17:50
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.

2 participants