fix(openapi): Preserve example summaries in v3 OpenAPI importer #10805
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes #9551 The bug was in AbstractMediaTypeObjectConverter.parseMediaTypeObject where example objects were being reduced to just their values, discarding the summary and description fields. This caused example names to be lost, resulting in generic 'Example 1/2/3' labels instead of the user-provided summary names like 'Partner token' and 'User token'. The fix preserves the full example object (including summary and description) instead of extracting only the value field. Co-Authored-By: [email protected] <[email protected]>
Contributor
Author
🤖 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:
|
… displayName This commit implements the bigger fix to properly convert OpenAPI examples from the examples field into v2Examples format. The key changes are: 1. Populate convertedResponseBody.examples field when ResponseBodyConverter returns examples from the OpenAPI examples field 2. Add convertOpenapiExamplesToFernExamples method to convert OpenAPI examples (with summary fields) into Fern example format 3. Use the summary field as the example name (displayName) when available 4. Merge OpenAPI examples with x-fern-examples and x-code-samples examples 5. Set displayName in convertEndpointExamples to preserve example names This fix ensures that OpenAPI example summaries are properly converted into v2Examples and displayed in the documentation UI instead of generic 'Example 1', 'Example 2' labels. Also reverted the previous FDR conversion layer fix since this bigger fix handles the issue properly at the source (OpenAPI-to-IR conversion). Co-Authored-By: [email protected] <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Closes #9551
Fixes a bug where OpenAPI example summaries were being ignored in the v3 importer, causing example names to display as generic "Example 1", "Example 2", etc. instead of the user-provided summary names like "Partner token" and "User token".
Changes Made
AbstractMediaTypeObjectConverter.parseMediaTypeObject()to preserve the full OpenAPIExampleObjectstructure (includingsummaryanddescriptionfields) instead of extracting only thevaluefieldresolved.value.value ?? resolved.value→resolved.valueexample.value ?? example→exampleTesting
examples-endpoint-level-namedshould cover this scenario, but this should be verified.Review Checklist
Critical items to verify:
resolved.valueandexampleare of typeOpenAPIV3_1.ExampleObject(not just the raw value). The filter on line 93 expects this type, but worth double-checking the resolver methods.convertMediaTypeObjectExamples()at line 142) expect the fullExampleObjectstructure withsummaryanddescriptionfields, not just the raw value.examples-endpoint-level-named.jsonsnapshot) properly validate that example summaries are preserved through the entire pipeline.Session: https://app.devin.ai/sessions/107aa7cf711e4608937bfcad07d6c5b7
Requested by: @dannysheridan ([email protected])