Skip to content

feat(docs): document sdkHooksConfigAccess feature flag #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 4, 2025

Conversation

TristanSpeakEasy
Copy link
Member

Summary

Documents the sdkHooksConfigAccess feature flag in the SDK hooks documentation.

Changes

  • Added new section "SDK Configuration Access" to explain the feature flag behavior
  • Documented version compatibility differences between new and existing SDKs
  • Explained how the flag affects SDK init hook signatures
  • Provided migration instructions for enabling full config access in existing SDKs

Details

The sdkHooksConfigAccess flag is located in the generation section of gen.yaml and controls whether hooks have access to the complete SDK configuration object:

  • true (default for newly generated SDKs): Full SDK configuration access
  • false (default for SDKs older than May 2025): Limited access with different SDK init hook signature

This documentation helps users understand the feature flag and how to migrate existing SDKs to use the enhanced configuration access.

- Add documentation for sdkHooksConfigAccess flag in SDK hooks
- Explain behavior differences between true/false settings
- Document version compatibility for SDKs before/after May 2025
- Provide migration instructions for existing SDKs
- Clarify SDK init hook signature differences based on flag value
@TristanSpeakEasy TristanSpeakEasy requested a review from a team as a code owner June 4, 2025 14:55
Copy link

github-actions bot commented Jun 4, 2025

🔗 Preview your changes
https://speakeasycom-git-docs-preview-pr-42-speakeasyapi.vercel.app
(The preview may still be building. Check back at this link in a few minutes.)

@TristanSpeakEasy TristanSpeakEasy enabled auto-merge (squash) June 4, 2025 15:06
@TristanSpeakEasy TristanSpeakEasy merged commit b2fafbb into main Jun 4, 2025
2 checks passed
@TristanSpeakEasy TristanSpeakEasy deleted the feat/document-sdk-hooks-config-access branch June 4, 2025 22:29
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.

3 participants