fork of hey-api/openapi-ts because I need some additional things
Merge pull request #2216 from hey-api/fix/parser-patch-meta
fix(parser): add meta and version options to input.patch
+169
-15
+5
.changeset/strong-donkeys-give.md
+5
.changeset/strong-donkeys-give.md
+3
packages/openapi-ts-tests/test/openapi-ts.config.ts
+3
packages/openapi-ts-tests/test/openapi-ts.config.ts
+2
-1
packages/openapi-ts/src/openApi/2.0.x/index.ts
+2
-1
packages/openapi-ts/src/openApi/2.0.x/index.ts
···
1
1
export { parseV2_0_X } from './parser';
2
2
export type { OpenApiV2_0_X } from './types/spec';
3
3
4
-
import type { SchemaObject } from './types/spec';
4
+
import type { InfoObject, SchemaObject } from './types/spec';
5
5
6
6
export interface OpenApiV2_0_XTypes {
7
+
InfoObject: InfoObject;
7
8
SchemaObject: SchemaObject;
8
9
}
+2
packages/openapi-ts/src/openApi/3.0.x/index.ts
+2
packages/openapi-ts/src/openApi/3.0.x/index.ts
···
2
2
export type { OpenApiV3_0_X } from './types/spec';
3
3
4
4
import type {
5
+
InfoObject,
5
6
ParameterObject,
6
7
ReferenceObject,
7
8
RequestBodyObject,
···
10
11
} from './types/spec';
11
12
12
13
export interface OpenApiV3_0_XTypes {
14
+
InfoObject: InfoObject;
13
15
ParameterObject: ParameterObject;
14
16
ReferenceObject: ReferenceObject;
15
17
RequestBodyObject: RequestBodyObject;
+2
packages/openapi-ts/src/openApi/3.1.x/index.ts
+2
packages/openapi-ts/src/openApi/3.1.x/index.ts
···
2
2
export type { OpenApiV3_1_X } from './types/spec';
3
3
4
4
import type {
5
+
InfoObject,
5
6
ParameterObject,
6
7
ReferenceObject,
7
8
RequestBodyObject,
···
10
11
} from './types/spec';
11
12
12
13
export interface OpenApiV3_1_XTypes {
14
+
InfoObject: InfoObject;
13
15
ParameterObject: ParameterObject;
14
16
ReferenceObject: ReferenceObject;
15
17
RequestBodyObject: RequestBodyObject;
+8
packages/openapi-ts/src/openApi/types.d.ts
+8
packages/openapi-ts/src/openApi/types.d.ts
···
10
10
export type V3_1_X = OpenApiV3_1_X;
11
11
}
12
12
13
+
export namespace OpenApiMetaObject {
14
+
export type V2_0_X = OpenApiV2_0_XTypes['InfoObject'];
15
+
16
+
export type V3_0_X = OpenApiV3_0_XTypes['InfoObject'];
17
+
18
+
export type V3_1_X = OpenApiV3_1_XTypes['InfoObject'];
19
+
}
20
+
13
21
export namespace OpenApiParameterObject {
14
22
export type V3_0_X =
15
23
| OpenApiV3_0_XTypes['ParameterObject']
+53
packages/openapi-ts/src/types/input.d.ts
+53
packages/openapi-ts/src/types/input.d.ts
···
1
1
import type {
2
+
OpenApiMetaObject,
2
3
OpenApiParameterObject,
3
4
OpenApiRequestBodyObject,
4
5
OpenApiResponseObject,
···
246
247
}
247
248
248
249
export interface Patch {
250
+
/**
251
+
* Patch the OpenAPI meta object in place. Useful for modifying general metadata such as title, description, version, or custom fields before further processing.
252
+
*
253
+
* @param meta The OpenAPI meta object for the current version.
254
+
*/
255
+
meta?: (
256
+
meta:
257
+
| OpenApiMetaObject.V2_0_X
258
+
| OpenApiMetaObject.V3_0_X
259
+
| OpenApiMetaObject.V3_1_X,
260
+
) => void;
261
+
/**
262
+
* Patch OpenAPI parameters in place. The key is the parameter name, and the function receives the parameter object to modify directly.
263
+
*
264
+
* @example
265
+
* parameters: {
266
+
* limit: (parameter) => {
267
+
* parameter.schema.type = 'integer';
268
+
* }
269
+
* }
270
+
*/
249
271
parameters?: Record<
250
272
string,
251
273
(
252
274
parameter: OpenApiParameterObject.V3_0_X | OpenApiParameterObject.V3_1_X,
253
275
) => void
254
276
>;
277
+
/**
278
+
* Patch OpenAPI request bodies in place. The key is the request body name, and the function receives the request body object to modify directly.
279
+
*
280
+
* @example
281
+
* requestBodies: {
282
+
* CreateUserRequest: (requestBody) => {
283
+
* requestBody.required = true;
284
+
* }
285
+
* }
286
+
*/
255
287
requestBodies?: Record<
256
288
string,
257
289
(
···
260
292
| OpenApiRequestBodyObject.V3_1_X,
261
293
) => void
262
294
>;
295
+
/**
296
+
* Patch OpenAPI responses in place. The key is the response name, and the function receives the response object to modify directly.
297
+
*
298
+
* @example
299
+
* responses: {
300
+
* NotFound: (response) => {
301
+
* response.description = 'Resource not found.';
302
+
* }
303
+
* }
304
+
*/
263
305
responses?: Record<
264
306
string,
265
307
(
···
303
345
| OpenApiSchemaObject.V3_1_X,
304
346
) => void
305
347
>;
348
+
/**
349
+
* Patch the OpenAPI version string. The function receives the current version and should return the new version string.
350
+
* Useful for normalizing or overriding the version value before further processing.
351
+
*
352
+
* @param version The current OpenAPI version string.
353
+
* @returns The new version string to use.
354
+
*
355
+
* @example
356
+
* version: (version) => version.replace(/^v/, '')
357
+
*/
358
+
version?: (version: string) => string;
306
359
}
307
360
308
361
export interface Watch {