Skip to content

fix: align API names with Swift guidelines - #20

Merged
julianschiavo merged 1 commit into
mainfrom
julian/fix-api-naming
Mar 13, 2026
Merged

fix: align API names with Swift guidelines#20
julianschiavo merged 1 commit into
mainfrom
julian/fix-api-naming

Conversation

@julianschiavo

@julianschiavo julianschiavo commented Mar 13, 2026

Copy link
Copy Markdown
Member
  • Rename the exact-entry lookup API to entry(for:) and the CLI command to get for clearer use-site semantics.
  • Align package and private bridge names with Swift API design guidelines by removing implementation-heavy terms like stringIdentifier, stringNamed, and locate....
  • Add regression coverage for the CLI rename and update docs and integration tests to match.

Note

Medium Risk
Medium risk because it introduces breaking renames across the public Swift API and xcdocs CLI subcommand, which can disrupt downstream callers despite minimal logic changes.

Overview
Renames the exact-entry lookup surface from fetch to entry across the Swift API (Client.fetchClient.entry(for:)), the support layer (VectorSearchClient.fetchentry(for:)), and the CLI (xcdocs fetchxcdocs get), updating README and integration tests accordingly.

Aligns internal/bridge naming with Swift conventions by replacing implementation-heavy terms (e.g., stringIdentifieridentifier, stringNamedstringAttribute(named:), locateDatabaseDirectoryURL()databaseDirectoryURL()), and adjusts related call sites/parameter labels (including MADServiceObject.performRequests).

Written by Cursor Bugbot for commit d8e3af8. This will update automatically on new commits. Configure here.

@julianschiavo
julianschiavo merged commit e0304ae into main Mar 13, 2026
3 checks passed
@julianschiavo
julianschiavo deleted the julian/fix-api-naming branch March 13, 2026 06:34
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