Skip to content

Commit 4369a1f

Browse files
authored
refactor: rename internal responses variable to operation (#335)
* refactor: rename internal `responses` variable to `operations` cause that is what it is: https://swagger.io/docs/specification/paths-and-operations/ * style: make eslint happy * refactor: rename internal `OpenAPI3Response` interface to `OpenAPI3Operation`
1 parent 869d26b commit 4369a1f

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

src/types/OpenAPI3.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ export interface OpenAPI3Schemas {
1010

1111
export interface OpenAPI3Paths {
1212
[path: string]: {
13-
[method: string]: OpenAPI3Response;
13+
[method: string]: OpenAPI3Operation;
1414
};
1515
}
1616

17-
export interface OpenAPI3Response {
17+
export interface OpenAPI3Operation {
1818
description?: string;
1919
parameters?: OpenAPI3Parameter[];
2020
responses: {

src/v3.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -157,18 +157,18 @@ export default function generateTypesV3(
157157
let output = "";
158158
Object.entries(paths).forEach(([path, methods]) => {
159159
output += `"${path}": {\n`;
160-
Object.entries(methods).forEach(([method, responses]) => {
161-
if (responses.description) output += comment(responses.description);
160+
Object.entries(methods).forEach(([method, operation]) => {
161+
if (operation.description) output += comment(operation.description);
162162
output += `"${method}": {\n`;
163163

164164
// handle parameters
165-
if (responses.parameters) {
165+
if (operation.parameters) {
166166
output += `parameters: {\n`;
167167
const allParameters: Record<
168168
string,
169169
Record<string, OpenAPI3Parameter>
170170
> = {};
171-
responses.parameters.forEach((p) => {
171+
operation.parameters.forEach((p) => {
172172
if (!allParameters[p.in]) allParameters[p.in] = {};
173173
// TODO: handle $ref parameters
174174
if (p.name) {
@@ -192,7 +192,7 @@ export default function generateTypesV3(
192192

193193
// handle responses
194194
output += `responses: {\n`;
195-
Object.entries(responses.responses).forEach(
195+
Object.entries(operation.responses).forEach(
196196
([statusCode, response]) => {
197197
if (response.description) output += comment(response.description);
198198
if (!response.content || !Object.keys(response.content).length) {

0 commit comments

Comments
 (0)