Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

Summary

Improves the generators.yml reference documentation for api.auth to better explain how to specify a default security scheme across the API. Previously, the documentation only said "Authentication configuration for the API" with no details on usage.

Changes:

  • Added a Note in the auth-schemes section pointing users to api.auth for applying schemes as the default
  • Expanded the api.auth ParamField with a clear explanation of what it does and what values it accepts
  • Added a complete two-step example showing how to define a scheme and then apply it
  • Included SDK usage example showing the result
  • Changed the type from "object" to "string" to accurately reflect that it accepts a scheme name reference

Review & Testing Checklist for Human

  • Verify the type change from "object" to "string" is accurate for api.auth (it should accept a string referencing a scheme name)
  • Check that the internal anchor links work: #auth-schemes and #override-api-authentication-settings
  • Review the preview deployment to ensure the documentation renders correctly and the examples are clear

Notes

Requested by: kenny
Devin session: https://app.devin.ai/sessions/30976867fe374d578a9933819c799d71

- Expand api.auth ParamField to explain what it does and what values it accepts
- Add complete example showing the two-step workflow: define scheme, then apply it
- Add Note in auth-schemes section pointing users to api.auth
- Include SDK usage example showing the result

Co-Authored-By: [email protected] <[email protected]>
@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
Contributor

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.

0 participants