fix: path parameters are not encoded #679

(cherry picked from commit 1c8a2ed)
orval-labs · Jul 13, 2023 · df2d4ba · df2d4ba
1 parent b361cb9
commit df2d4ba
Show file tree

Hide file tree

Showing 10 changed files with 245 additions and 158 deletions.
diff --git a/samples/react-query/basic/src/api/endpoints/petstoreFromFileSpecWithTransformer.ts b/samples/react-query/basic/src/api/endpoints/petstoreFromFileSpecWithTransformer.ts
@@ -69,7 +69,7 @@ export const listPets = (
   signal?: AbortSignal,
 ) => {
   return customInstance<Pets>({
-    url: `/v${version}/pets`,
+    url: `/v${encodeURIComponent(String(version))}/pets`,
     method: 'get',
     params,
     signal,
@@ -214,7 +214,7 @@ export const useListPets = <
  */
 export const createPets = (createPetsBody: CreatePetsBody, version = 1) => {
   return customInstance<Pet>({
-    url: `/v${version}/pets`,
+    url: `/v${encodeURIComponent(String(version))}/pets`,
     method: 'post',
     headers: { 'Content-Type': 'application/json' },
     data: createPetsBody,
@@ -281,7 +281,7 @@ export const useCreatePets = <
  */
 export const updatePets = (pet: NonReadonly<Pet>, version = 1) => {
   return customInstance<Pet>({
-    url: `/v${version}/pets`,
+    url: `/v${encodeURIComponent(String(version))}/pets`,
     method: 'put',
     headers: { 'Content-Type': 'application/json' },
     data: pet,
@@ -352,7 +352,9 @@ export const showPetById = (
   signal?: AbortSignal,
 ) => {
   return customInstance<Pet>({
-    url: `/v${version}/pets/${petId}`,
+    url: `/v${encodeURIComponent(String(version))}/pets/${encodeURIComponent(
+      String(petId),
+    )}`,
     method: 'get',
     signal,
   });

diff --git a/samples/react-query/custom-client/src/api/endpoints/petstoreFromFileSpecWithTransformer.ts b/samples/react-query/custom-client/src/api/endpoints/petstoreFromFileSpecWithTransformer.ts
@@ -35,7 +35,7 @@ export const useListPetsHook = () => {
 
   return (params?: ListPetsParams, version = 1, signal?: AbortSignal) => {
     return listPets({
-      url: `/v${version}/pets`,
+      url: `/v${encodeURIComponent(String(version))}/pets`,
       method: 'get',
       params,
       signal,
@@ -119,7 +119,7 @@ export const useCreatePetsHook = () => {
 
   return (createPetsBody: BodyType<CreatePetsBody>, version = 1) => {
     return createPets({
-      url: `/v${version}/pets`,
+      url: `/v${encodeURIComponent(String(version))}/pets`,
       method: 'post',
       headers: { 'Content-Type': 'application/json' },
       data: createPetsBody,
@@ -192,7 +192,9 @@ export const useShowPetByIdHook = () => {
 
   return (petId: string, version = 1, signal?: AbortSignal) => {
     return showPetById({
-      url: `/v${version}/pets/${petId}`,
+      url: `/v${encodeURIComponent(String(version))}/pets/${encodeURIComponent(
+        String(petId),
+      )}`,
       method: 'get',
       signal,
     });

diff --git a/samples/react-query/hook-mutator/endpoints.ts b/samples/react-query/hook-mutator/endpoints.ts
@@ -179,7 +179,11 @@ export const useShowPetByIdHook = () => {
   const showPetById = useCustomInstance<Pet>();
 
   return (petId: string, signal?: AbortSignal) => {
-    return showPetById({ url: `/pets/${petId}`, method: 'get', signal });
+    return showPetById({
+      url: `/pets/${encodeURIComponent(String(petId))}`,
+      method: 'get',
+      signal,
+    });
   };
 };
 

diff --git a/samples/svelte-query/src/api/endpoints/petstoreFromFileSpecWithTransformer.ts b/samples/svelte-query/src/api/endpoints/petstoreFromFileSpecWithTransformer.ts
@@ -31,7 +31,7 @@ export const listPets = (
   signal?: AbortSignal,
 ) => {
   return customInstance<Pets>({
-    url: `/v${version}/pets`,
+    url: `/v${encodeURIComponent(String(version))}/pets`,
     method: 'get',
     params,
     signal,
@@ -108,7 +108,7 @@ export const createListPets = <
  */
 export const createPets = (createPetsBody: CreatePetsBody, version = 1) => {
   return customInstance<void>({
-    url: `/v${version}/pets`,
+    url: `/v${encodeURIComponent(String(version))}/pets`,
     method: 'post',
     headers: { 'Content-Type': 'application/json' },
     data: createPetsBody,
@@ -176,7 +176,9 @@ export const showPetById = (
   signal?: AbortSignal,
 ) => {
   return customInstance<Pet>({
-    url: `/v${version}/pets/${petId}`,
+    url: `/v${encodeURIComponent(String(version))}/pets/${encodeURIComponent(
+      String(petId),
+    )}`,
     method: 'get',
     signal,
   });

diff --git a/samples/vue-query/package.json b/samples/vue-query/package.json
@@ -11,7 +11,7 @@
     "@faker-js/faker": "^7.3.0",
     "@tanstack/vue-query": "4.29.5",
     "axios": "^0.26.1",
-    "vue": "3.2.36"
+    "vue": "^3.3.4"
   },
   "devDependencies": {
     "@vitejs/plugin-vue": "^1.2.5",

diff --git a/samples/vue-query/src/api/endpoints/petstoreFromFileSpecWithTransformer.ts b/samples/vue-query/src/api/endpoints/petstoreFromFileSpecWithTransformer.ts
@@ -16,7 +16,7 @@ import type {
   UseInfiniteQueryReturnType,
 } from '@tanstack/vue-query';
 import { unref } from 'vue';
-import type { MaybeRef } from '@tanstack/vue-query/build/lib/types';
+import type { MaybeRef } from 'vue';
 import type {
   Pets,
   Error,
@@ -39,7 +39,7 @@ export const listPets = (
   signal?: AbortSignal,
 ) => {
   return customInstance<Pets>({
-    url: `/v${unref(version)}/pets`,
+    url: `/v${encodeURIComponent(String(unref(version)))}/pets`,
     method: 'get',
     params,
     signal,
@@ -185,7 +185,7 @@ export const createPets = (
   version = 1,
 ) => {
   return customInstance<Pet>({
-    url: `/v${unref(version)}/pets`,
+    url: `/v${encodeURIComponent(String(unref(version)))}/pets`,
     method: 'post',
     headers: { 'Content-Type': 'application/json' },
     data: createPetsBody,
@@ -253,7 +253,9 @@ export const showPetById = (
   signal?: AbortSignal,
 ) => {
   return customInstance<Pet>({
-    url: `/v${unref(version)}/pets/${unref(petId)}`,
+    url: `/v${encodeURIComponent(
+      String(unref(version)),
+    )}/pets/${encodeURIComponent(String(unref(petId)))}`,
     method: 'get',
     signal,
   });

diff --git a/samples/vue-query/tsconfig.json b/samples/vue-query/tsconfig.json
@@ -2,7 +2,7 @@
   "compilerOptions": {
     "target": "esnext",
     "module": "esnext",
-    "moduleResolution": "node",
+    "moduleResolution": "bundler", // as per default in node_modules/@vue/tsconfig/tsconfig.json
     "strict": true,
     "jsx": "preserve",
     "sourceMap": true,