Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Dec 9, 2025

Summary

Fixes the security callbacks documentation to correctly distinguish between single and multiple security scheme patterns. Previously, the documentation incorrectly showed the security callback pattern (returning a Security object) for single security schemes.

The key distinction:

  • Single scheme: Use the scheme name directly as a property (e.g., bearerAuth) with a callback returning the credential string
  • Multiple schemes: Use the security property with a callback returning a Security object to dynamically choose which auth method to use

Updates since last revision

Scaled back changes per user feedback - only TypeScript examples were updated. All other language examples (Python, Go, Java, C#, PHP, Ruby) were reverted to their original state since the user only provided TypeScript-specific feedback.

Review & Testing Checklist for Human

  • Verify TypeScript single-scheme example is correct - Confirm that bearerAuth: async (): Promise<string> => { ... } is the correct pattern for single security schemes
  • Verify TypeScript multiple-scheme example is correct - Confirm that security: async (): Promise<Security> => { ... } is the correct pattern for multiple security schemes
  • Consider updating non-TypeScript examples - The non-TypeScript examples still show the old pattern (using security/securitySource even for single schemes). If the single-scheme pattern applies to other languages too, those examples may need separate updates.

Recommended test plan: Generate a TypeScript SDK with a single security scheme and verify the documented bearerAuth callback pattern works as shown.

Notes

@devin-ai-integration devin-ai-integration bot requested a review from a team as a code owner December 9, 2025 12:32
@devin-ai-integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@github-actions
Copy link

github-actions bot commented Dec 9, 2025

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

@AshGodfrey AshGodfrey closed this Dec 9, 2025
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