Merge branch 'openapi-ts:main' into support-custom-path-serializer

Author: luxass

.github/workflows/ci.yml

@@ -14,7 +14,7 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - uses: actions/setup-node@v4
         with:
           node-version: 22
@@ -28,7 +28,7 @@ jobs:
       matrix:
         node-version: [20, 22]
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
@@ -39,7 +39,7 @@ jobs:
   test-e2e:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - uses: actions/setup-node@v4
         with:
           node-version: 22
@@ -51,7 +51,7 @@ jobs:
   test-macos:
     runs-on: macos-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - uses: actions/setup-node@v4
         with:
           node-version: 22
@@ -62,7 +62,7 @@ jobs:
   test-windows:
     runs-on: windows-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - uses: actions/setup-node@v4
         with:
           node-version: 22

.github/workflows/release.yml

@@ -17,7 +17,7 @@ jobs:
       pull-requests: write
     steps:
       - name: Git setup
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Node setup
         uses: actions/setup-node@v4

.github/workflows/size-limit.yml

@@ -12,7 +12,7 @@ jobs:
       pull-requests: write
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - uses: actions/setup-node@v4
         with:
           node-version: 22

packages/openapi-metadata/CHANGELOG.md

@@ -1,5 +1,11 @@
 # openapi-metadata
 
+## 0.2.2
+
+### Patch Changes
+
+- [#2365](https://github.com/openapi-ts/openapi-typescript/pull/2365) [`b419aee`](https://github.com/openapi-ts/openapi-typescript/commit/b419aee0ded0a329ce0623dacb67159bbb7c7800) Thanks [@spamshaker](https://github.com/spamshaker)! - fix(#2364) for allowing to add params via ApiOperation tag
+
 ## 0.2.1
 
 ### Patch Changes

packages/openapi-metadata/package.json

@@ -1,7 +1,7 @@
 {
   "name": "openapi-metadata",
   "description": "Auto-Generate OpenAPI specifications from Typescript decorators",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "author": {
     "name": "Martin PAUCOT",
     "email": "[email protected]"

packages/openapi-metadata/src/decorators/api-operation.ts

@@ -1,4 +1,8 @@
-import { type OperationMetadata, OperationMetadataStorage } from "../metadata/operation.js";
+import {
+  type OperationMetadata,
+  OperationMetadataStorage,
+  OperationParameterMetadataStorage,
+} from "../metadata/index.js";
 
 export type ApiOperationOptions = OperationMetadata;
 
@@ -11,5 +15,8 @@ export type ApiOperationOptions = OperationMetadata;
 export function ApiOperation(options: ApiOperationOptions): MethodDecorator {
   return (target, propertyKey) => {
     OperationMetadataStorage.defineMetadata(target, options, propertyKey);
+    if (Array.isArray(options.parameters)) {
+      OperationParameterMetadataStorage.mergeMetadata(target, options.parameters, propertyKey);
+    }
   };
 }

packages/openapi-metadata/src/metadata/operation.ts

@@ -1,8 +1,9 @@
 import type { OpenAPIV3 } from "openapi-types";
 import type { HttpMethods } from "../types.js";
 import { createMetadataStorage } from "./factory.js";
+import type { OperationParameterMetadata } from "./operation-parameter.js";
 
-export type OperationMetadata = Omit<OpenAPIV3.OperationObject, "responses"> & {
+export type OperationMetadata = Omit<OpenAPIV3.OperationObject, "responses" | "parameters"> & {
   /**
    * Operation path.
    * Can include parameters.
@@ -13,6 +14,11 @@ export type OperationMetadata = Omit<OpenAPIV3.OperationObject, "responses"> & {
    * Available methods for this operation.
    */
   methods?: HttpMethods[];
+
+  /**
+   * Represents metadata about an operation parameter.
+   */
+  parameters?: OperationParameterMetadata[];
 };
 
 export const OperationMetadataKey = Symbol("Operation");

packages/openapi-metadata/test/decorators.test.ts

@@ -1,11 +1,15 @@
 import "reflect-metadata";
 import {
+  ApiBasicAuth,
+  ApiBearerAuth,
   ApiBody,
   ApiCookie,
+  ApiCookieAuth,
   ApiExcludeController,
   ApiExcludeOperation,
   ApiExtraModels,
   ApiHeader,
+  ApiOauth2,
   ApiOperation,
   ApiParam,
   ApiProperty,
@@ -19,26 +23,40 @@ import {
   ExtraModelsMetadataStorage,
   OperationBodyMetadataStorage,
   OperationMetadataStorage,
+  type OperationParameterMetadata,
   OperationParameterMetadataStorage,
   OperationResponseMetadataStorage,
   OperationSecurityMetadataStorage,
   PropertyMetadataStorage,
 } from "../src/metadata/index.js";
-import { ApiBasicAuth, ApiBearerAuth, ApiCookieAuth, ApiOauth2 } from "../src/decorators/api-security.js";
 
 test("@ApiOperation", () => {
+  const parameters: OperationParameterMetadata[] = [
+    {
+      in: "path",
+      name: "id",
+    },
+  ] as const;
+
   class MyController {
-    @ApiOperation({ summary: "Hello", path: "/test", methods: ["get"] })
+    @ApiOperation({
+      summary: "Hello",
+      path: "/test",
+      methods: ["get"],
+      parameters,
+    })
     operation() {}
   }
 
-  const metadata = OperationMetadataStorage.getMetadata(MyController.prototype, "operation");
-
-  expect(metadata).toEqual({
+  const operationMetadata = OperationMetadataStorage.getMetadata(MyController.prototype, "operation");
+  const parameterMetadata = OperationParameterMetadataStorage.getMetadata(MyController.prototype, "operation");
+  expect(operationMetadata).toEqual({
     summary: "Hello",
     path: "/test",
     methods: ["get"],
+    parameters,
   });
+  expect(parameterMetadata).toEqual(parameters);
 });
 
 test("@ApiBody", () => {

packages/openapi-react-query/package.json

@@ -60,7 +60,7 @@
     "@tanstack/react-query": "^5.84.2",
     "@testing-library/react": "^16.3.0",
     "@types/react": "18.3.21",
-    "@vitejs/plugin-react": "^4.7.0",
+    "@vitejs/plugin-react": "^5.0.0",
     "execa": "^9.6.0",
     "msw": "^2.10.4",
     "openapi-fetch": "workspace:^",

packages/openapi-typescript/CHANGELOG.md

@@ -1,5 +1,13 @@
 # openapi-typescript
 
+## 7.9.1
+
+### Patch Changes
+
+- [#2393](https://github.com/openapi-ts/openapi-typescript/pull/2393) [`6943ccf`](https://github.com/openapi-ts/openapi-typescript/commit/6943ccf216f602f004eb178dd652ffcbafc05346) Thanks [@simon-curtis](https://github.com/simon-curtis)! - Now checking for null & empty string when generating enum description
+
+- [#2375](https://github.com/openapi-ts/openapi-typescript/pull/2375) [`5be22d7`](https://github.com/openapi-ts/openapi-typescript/commit/5be22d7adc8bc36fdfa91f1aa3473919107060f2) Thanks [@ParkerVR](https://github.com/ParkerVR)! - Fix behavior when using enum and export-type flags
+
 ## 7.9.0
 
 ### Minor Changes