-
Notifications
You must be signed in to change notification settings - Fork 3
Document explicit null overrides pattern for deleting parameters #1801
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
base: main
Are you sure you want to change the base?
Document explicit null overrides pattern for deleting parameters #1801
Conversation
Add comprehensive documentation to parameter-names.mdx explaining how to use explicit null values in overrides files to delete parameters from the base OpenAPI specification. Documentation includes: - Clear explanation of when to use null overrides (duplicate identifiers, deprecated parameters, simplifying SDK interface) - Warning about breaking changes when deleting parameters - Example for deleting a single parameter using 'parameters: [null]' - Example for deleting multiple parameters - Real-world example from Vercel SDK showing how to resolve duplicate identifier errors between query parameters and request body properties This pattern was successfully used to fix TypeScript compilation errors in the Vercel SDK where slug query parameters conflicted with slug request body properties. Related PR: fern-demo/vercel-fern-config#13 Co-Authored-By: [email protected] <[email protected]>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
| - Simplifying the SDK interface by hiding internal parameters | ||
|
|
||
| <Warning> | ||
| Deleting parameters is a breaking change. Parameters removed via null overrides will not be available in the generated SDK, even though they exist in the base OpenAPI specification. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'won't' instead of 'will not'.
Document explicit null overrides pattern for deleting parameters
Summary
This PR adds documentation to the OpenAPI extensions guide explaining how to use explicit
nullvalues in overrides files to delete parameters from the base OpenAPI specification. This pattern was successfully used to resolve TypeScript compilation errors in the Vercel SDK (fern-demo/vercel-fern-config#13) where query parameters and request body properties had duplicate identifiers.The new documentation section includes:
Review & Testing Checklist for Human
🟡 MEDIUM PRIORITY:
parameters: [null]is the correct and complete syntax for deleting parameters in Fern overrides. Check if there are any variations or additional options.Recommended Test Plan
slugexample)parameters: [null]for that endpoint[null, null]syntax worksNotes
Link to Devin session: https://app.devin.ai/sessions/fde0679e607f4b1497db15af0bbeb538
Requested by: Deep Singhvi (@deep Singhvi)