From 8ef70499db8d5647b0e46ce04938e6d23dc74e78 Mon Sep 17 00:00:00 2001 From: yangdan8 <361100314@qq.com> Date: Wed, 26 Feb 2025 10:55:54 +0800 Subject: [PATCH 1/3] Update index.ts --- types/index.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/index.ts b/types/index.ts index 17fdf6e9..50ef1233 100644 --- a/types/index.ts +++ b/types/index.ts @@ -9,7 +9,7 @@ interface GenerateApiParamsBase { /** * default 'api.ts' */ - name?: string; + fileName?: string; /** * name of the main exported class From 046f0466aa976008e15d6984d0f40391bca3dd30 Mon Sep 17 00:00:00 2001 From: yangdan8 <361100314@qq.com> Date: Wed, 26 Feb 2025 10:58:48 +0800 Subject: [PATCH 2/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ad6bb43b..559f60bd 100644 --- a/README.md +++ b/README.md @@ -84,7 +84,7 @@ import { generateApi, generateTemplates } from "swagger-typescript-api"; /* NOTE: all fields are optional expect one of `input`, `url`, `spec` */ generateApi({ - name: "MySuperbApi.ts", + fileName: "MySuperbApi.ts", // set to `false` to prevent the tool from writing to disk output: path.resolve(process.cwd(), "./src/__generated__"), url: "http://api.com/swagger.json", From c06af2e3cf9b03aa37e3652d5312975bb1292d28 Mon Sep 17 00:00:00 2001 From: Sora Morimoto Date: Mon, 24 Mar 2025 18:41:37 +0900 Subject: [PATCH 3/3] Add changeset Signed-off-by: Sora Morimoto --- .changeset/stupid-walls-act.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/stupid-walls-act.md diff --git a/.changeset/stupid-walls-act.md b/.changeset/stupid-walls-act.md new file mode 100644 index 00000000..b9012a6b --- /dev/null +++ b/.changeset/stupid-walls-act.md @@ -0,0 +1,5 @@ +--- +"swagger-typescript-api": patch +--- + +Fix documentation and type definition to align with actual implementation by renaming `name` to `fileName`.