Skip to content

fix(openapi): Preserve example summaries in v3 OpenAPI importer #10804

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.

Sign up for GitHub

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

fix(openapi): Preserve example summaries in v3 OpenAPI importer #10804

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
07e9c2c
fix(openapi): Preserve example summaries in v3 OpenAPI importer
devin-ai-integration[bot] Nov 22, 2025
a130653
test(openapi): Add regression test for example summaries preservation
devin-ai-integration[bot] Nov 22, 2025
e97441d
fix(test): Fix biome formatting in openapi-from-flag test
devin-ai-integration[bot] Nov 22, 2025
55a1c72
fix(openapi): Preserve example displayName in FDR conversion
devin-ai-integration[bot] Nov 22, 2025
45cfd7b
fix(test): Update gRPC comments snapshot for example displayName
devin-ai-integration[bot] Nov 22, 2025
9f223cd
fix(test): Add trailing newline to grpc-comments-fdr.snap
devin-ai-integration[bot] Nov 22, 2025
c7dd9fc
fix(test): Update gRPC snapshot with correct EOF format
devin-ai-integration[bot] Nov 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions ...importers/v3-importer-commons/src/converters/abstract/AbstractMediaTypeObjectConverter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,9 @@ export abstract class AbstractMediaTypeObjectConverter extends AbstractConverter
breadcrumbs: [...this.breadcrumbs, "content", contentType, "examples"],
skipErrorCollector: true
});
return resolved.resolved ? [key, resolved.value.value ?? resolved.value] : null;
return resolved.resolved ? [key, resolved.value] : null;
}
return [key, example.value ?? example];
return [key, example];
})
.filter((entry): entry is [string, OpenAPIV3_1.ExampleObject] => entry != null)
)
Expand Down
225 changes: 225 additions & 0 deletions ...es/cli/register/src/ir-to-fdr-converter/__test__/__snapshots__/example-summaries-fdr.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,225 @@
{
"auth": undefined,
"authSchemes": {},
"globalHeaders": [],
"navigation": undefined,
"rootPackage": {
"endpoints": [
{
"auth": false,
"authV2": undefined,
"availability": undefined,
"defaultEnvironment": "https://httpbin.org/anything",
"description": undefined,
"environments": [
{
"baseUrl": "https://httpbin.org/anything",
"id": "https://httpbin.org/anything",
},
],
"errors": undefined,
"errorsV2": [],
"examples": [
{
"codeSamples": undefined,
"description": "",
"headers": {},
"name": "User token",
"path": "/something",
"pathParameters": {},
"queryParameters": {},
"requestBody": {
"foo": "user",
},
"requestBodyV3": {
"type": "json",
"value": {
"foo": "user",
},
},
"responseBody": {
"foo": "string",
},
"responseBodyV3": {
"type": "json",
"value": {
"foo": "string",
},
},
"responseStatusCode": 200,
},
{
"codeSamples": undefined,
"description": "",
"headers": {},
"name": "Partner token",
"path": "/something",
"pathParameters": {},
"queryParameters": {},
"requestBody": {
"foo": "partner",
},
"requestBodyV3": {
"type": "json",
"value": {
"foo": "partner",
},
},
"responseBody": {
"foo": "string",
},
"responseBodyV3": {
"type": "json",
"value": {
"foo": "string",
},
},
"responseStatusCode": 200,
},
],
"headers": [],
"id": "doSomething",
"includeInApiExplorer": undefined,
"method": "POST",
"multiAuth": undefined,
"name": "Do something",
"originalEndpointId": "endpoint_.doSomething",
"path": {
"parts": [
{
"type": "literal",
"value": "",
},
{
"type": "literal",
"value": "/something",
},
],
"pathParameters": [],
},
"protocol": {
"type": "rest",
},
"queryParameters": [],
"request": {
"description": undefined,
"type": {
"contentType": "application/json",
"description": undefined,
"shape": {
"type": "reference",
"value": {
"default": undefined,
"type": "id",
"value": "Foo",
},
},
"type": "json",
},
},
"requestsV2": {
"requests": [
{
"description": undefined,
"type": {
"contentType": "application/json",
"description": undefined,
"shape": {
"type": "reference",
"value": {
"default": undefined,
"type": "id",
"value": "Foo",
},
},
"type": "json",
},
},
],
},
"response": {
"description": "ok",
"isWildcard": undefined,
"statusCode": 200,
"type": {
"type": "reference",
"value": {
"default": undefined,
"type": "id",
"value": "Foo",
},
},
},
"responsesV2": {
"responses": [
{
"description": "ok",
"isWildcard": undefined,
"statusCode": 200,
"type": {
"type": "reference",
"value": {
"default": undefined,
"type": "id",
"value": "Foo",
},
},
},
],
},
"slug": undefined,
},
],
"pointsTo": undefined,
"subpackages": [],
"types": [
"Foo",
],
"webhooks": [],
"websockets": [],
},
"snippetsConfiguration": {
"csharpSdk": undefined,
"goSdk": undefined,
"javaSdk": undefined,
"phpSdk": undefined,
"pythonSdk": undefined,
"rubySdk": undefined,
"rustSdk": undefined,
"swiftSdk": undefined,
"typescriptSdk": undefined,
},
"subpackages": {},
"types": {
"Foo": {
"availability": undefined,
"description": undefined,
"displayName": undefined,
"name": "Foo",
"shape": {
"extends": [],
"extraProperties": undefined,
"properties": [
{
"availability": undefined,
"description": undefined,
"key": "foo",
"propertyAccess": undefined,
"valueType": {
"type": "primitive",
"value": {
"default": undefined,
"format": undefined,
"maxLength": undefined,
"minLength": undefined,
"regex": undefined,
"type": "string",
},
},
},
],
"type": "object",
},
},
},
}
Loading
Loading