Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Nov 20, 2025

Summary

This PR documents the new global api.settings configuration feature introduced in PR #10521. This feature allows users to define API settings globally in generators.yml that apply to all specifications, with a precedence hierarchy where generator-level settings override spec-level settings, which in turn override global settings.

The documentation includes:

  • A new settings parameter under the api section
  • An example showing the three-level precedence hierarchy
  • Explanation of when global settings are useful

Review & Testing Checklist for Human

  • Verify precedence hierarchy: Confirm the documented precedence (generator-level > spec-level > global) matches the actual implementation in PR #10521
  • Test YAML example syntax: Verify the example code is syntactically correct and follows the actual generators.yml schema
  • Check setting compatibility: Verify that the settings used in the example (coerce-enums-to-literals, inline-path-parameters) can actually be used at the global level, or if there are any restrictions
  • Preview documentation: Check the preview link to ensure the new section renders correctly and the example code displays properly

Test Plan

  1. Navigate to the generators.yml reference page in the preview
  2. Scroll to the api section and verify the new settings parameter appears
  3. Check that the example code is properly formatted and the comments are visible
  4. Verify the description text is clear and accurate

Notes

  • Devin Session: https://app.devin.ai/sessions/cb4f8125897447d29c0c48d802361853
  • Requested by: Devin Logan (@devalog)
  • I documented this feature based on PR #10521's description without testing the actual implementation, so human verification of technical accuracy is important
  • The coerce-enums-to-literals default change was removed from this PR per user request

@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

@devin-ai-integration devin-ai-integration bot changed the title Document global api.settings and update coerce-enums-to-literals default docs: document global api.settings in generators.yml Nov 20, 2025
@github-actions
Copy link
Contributor

@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.

2 participants