Skip to content

feat(plugin): add support for responses with $ref specification #349

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

Merged
radist2s merged 3 commits into from
Jun 21, 2025
Merged

feat(plugin): add support for responses with $ref specification #349

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9879e1d
chore(test-fixtures): add `$ref` example for the `responses`
radist2s Jun 20, 2025
74d4093
feat(plugin): add support for the responses with the `$ref` specified
radist2s Jun 20, 2025
8f90621
docs(changeset): Add support for responses with `$ref` specification.
radist2s Jun 21, 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
6 changes: 6 additions & 0 deletions .changeset/true-weeks-love.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@openapi-qraft/test-fixtures': patch
'@openapi-qraft/plugin': patch
---

Add support for responses with `$ref` specification.
32 changes: 13 additions & 19 deletions packages/openapi-typescript-plugin/src/__snapshots__/no-extra-options.ts.snapshot.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,17 @@ export interface components {
url: string;
};
};
responses: never;
responses: {
/** @description Unexpected error */
DefaultErrorSchemaResponse: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorSchemaResponse"];
};
};
};
parameters: {
IdIn: string[];
/** @example 2023-06-04 */
Expand Down Expand Up @@ -262,15 +272,7 @@ export interface operations {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
/** @description Unexpected error */
default: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorSchemaResponse"];
};
};
default: components["responses"]["DefaultErrorSchemaResponse"];
};
};
get_approval_policies_id: {
Expand Down Expand Up @@ -514,15 +516,7 @@ export interface operations {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
/** @description Internal Server Error */
default: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorSchemaResponse"];
};
};
default: components["responses"]["DefaultErrorSchemaResponse"];
};
};
post_files: {
Expand Down
22 changes: 12 additions & 10 deletions ...i-typescript-plugin/src/__snapshots__/with-explicit-component-enum-exports.ts.snapshot.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,17 @@ export interface components {
url: string;
};
};
responses: never;
responses: {
/** @description Unexpected error */
DefaultErrorSchemaResponse: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorSchemaResponse"];
};
};
};
parameters: {
IdIn: string[];
/** @example 2023-06-04 */
Expand Down Expand Up @@ -160,15 +170,7 @@ export interface operations {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
/** @description Internal Server Error */
default: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorSchemaResponse"];
};
};
default: components["responses"]["DefaultErrorSchemaResponse"];
};
};
post_files: {
Expand Down
22 changes: 12 additions & 10 deletions ...penapi-typescript-plugin/src/__snapshots__/with-explicit-component-exports.ts.snapshot.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,17 @@ export interface components {
url: string;
};
};
responses: never;
responses: {
/** @description Unexpected error */
DefaultErrorSchemaResponse: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorSchemaResponse"];
};
};
};
parameters: {
IdIn: string[];
/** @example 2023-06-04 */
Expand Down Expand Up @@ -160,15 +170,7 @@ export interface operations {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
/** @description Internal Server Error */
default: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorSchemaResponse"];
};
};
default: components["responses"]["DefaultErrorSchemaResponse"];
};
};
post_files: {
Expand Down
22 changes: 12 additions & 10 deletions packages/openapi-typescript-plugin/src/__snapshots__/with-extra-options.ts.snapshot.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,17 @@ export interface components {
url: string;
};
};
responses: never;
responses: {
/** @description Unexpected error */
DefaultErrorSchemaResponse: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorSchemaResponse"];
};
};
};
parameters: {
IdIn: string[];
/** @example 2023-06-04 */
Expand Down Expand Up @@ -197,15 +207,7 @@ export interface operations {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
/** @description Internal Server Error */
default: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorSchemaResponse"];
};
};
default: components["responses"]["DefaultErrorSchemaResponse"];
};
};
post_files: {
Expand Down
3 changes: 2 additions & 1 deletion packages/plugin/src/lib/open-api/OpenAPISchemaType.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ export type OpenAPISchemaType = {
};
responses: {
[statusCode in number | 'default']: {
description: string;
$ref?: string;
description?: string;
content?: {
[contentType: string]:
| {
Expand Down
7 changes: 7 additions & 0 deletions packages/plugin/src/lib/open-api/getServices.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,13 @@ export const getServices = (
>
>(
(acc, [statusCode, response]) => {
if (response.$ref) {
response = resolveDocumentLocalRef(
response.$ref,
openApiJson
) as typeof response;
}

const statusType =
statusCode !== 'default' && // See "default" response https://swagger.io/docs/specification/describing-responses/#default
Number(statusCode) < 400
Expand Down
24 changes: 12 additions & 12 deletions packages/test-fixtures/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,12 +120,7 @@
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ErrorSchemaResponse" }
}
}
"$ref": "#/components/responses/DefaultErrorSchemaResponse"
}
},
"security": [{ "userToken": [] }, { "partnerToken": [] }]
Expand Down Expand Up @@ -493,12 +488,7 @@
}
},
"default": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ErrorSchemaResponse" }
}
}
"$ref": "#/components/responses/DefaultErrorSchemaResponse"
}
},
"security": [{ "HTTPBearer": [] }]
Expand Down Expand Up @@ -881,6 +871,16 @@
}
}
}
},
"responses": {
"DefaultErrorSchemaResponse": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ErrorSchemaResponse" }
}
}
}
}
}
}
Loading