docs: document public SDK APIs#144
Merged
Merged
Conversation
ioannisj
approved these changes
May 20, 2026
ioannisj
left a comment
There was a problem hiding this comment.
Had a quick scan and all looks good
This was referenced May 20, 2026
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.
💡 Motivation and Context
The SDK exposes several public methods, constructor parameters, and configuration options that were missing or had stale PHPDoc. This makes it harder for users and IDE/static analysis tools to discover the supported API surface.
This PR updates PHPDoc across the SDK to document public APIs, supported message/config shapes, feature flag parameters, request context helpers, and error tracking configuration. It also marks implementation-only classes as
@internalwhere they are not intended as public SDK APIs, including the HTTP transport classes.The README is also simplified to avoid duplicating Error Tracking docs and to keep repository-local setup instructions in
CONTRIBUTING.md.💚 How did you test it?
find lib -name '*.php' -print0 | xargs -0 -n1 php -lphp -l lib/HttpClient.php && php -l lib/HttpResponse.php./vendor/bin/phpcs lib(no errors; existing line-length warnings remain)./vendor/bin/phpunit --colors=never test/(tests pass functionally; command exits 1 because of existing warnings/deprecations/no coverage driver)📝 Checklist
If releasing new changes
pnpm changesetto generate a changeset file