path collision are adding prefix without checking the method

[kossel]

Description

When there is collision in paths, it will automatically append the prefix (code) however, it doesn't check if the methods collide too, sometimes different method might be in different spec:

input:

• swagger1.json

{
  "swagger": "2.0",
  "info": {
    "version": "1.0.7",
    "title": "Swagger Petstore",
    "description": "Filtered spec containing only POST /pet/{petId}"
  },
  "host": "petstore.swagger.io",
  "basePath": "/v2",
  "schemes": ["https", "http"],
  "paths": {
    "/pet/{petId}": {
      "post": {
        "tags": ["pet"],
        "summary": "Updates a pet in the store with form data",
        "description": "",
        "operationId": "updatePetWithForm",
        "consumes": ["application/x-www-form-urlencoded"],
        "produces": ["application/json", "application/xml"],
        "parameters": [
          {
            "name": "petId",
            "in": "path",
            "description": "ID of pet that needs to be updated",
            "required": true,
            "type": "integer",
            "format": "int64"
          },
          {
            "name": "name",
            "in": "formData",
            "description": "Updated name of the pet",
            "required": false,
            "type": "string"
          },
          {
            "name": "status",
            "in": "formData",
            "description": "Updated status of the pet",
            "required": false,
            "type": "string"
          }
        ],
        "responses": {
          "405": {
            "description": "Invalid input"
          }
        },
        "security": [
          {
            "petstore_auth": ["write:pets", "read:pets"]
          }
        ]
      }
    }
  },
  "securityDefinitions": {
    "petstore_auth": {
      "type": "oauth2",
      "authorizationUrl": "https://petstore.swagger.io/oauth/authorize",
      "flow": "implicit",
      "scopes": {
        "read:pets": "read your pets",
        "write:pets": "modify pets in your account"
      }
    }
  }
}

• swagger2.json

{
  "swagger": "2.0",
  "info": {
    "version": "1.0.7",
    "title": "Swagger Petstore",
    "description": "Filtered spec containing only GET and DELETE for /pet/{petId}"
  },
  "host": "petstore.swagger.io",
  "basePath": "/v2",
  "schemes": ["https", "http"],
  "paths": {
    "/pet/{petId}": {
      "delete": {
        "tags": ["pet"],
        "summary": "Deletes a pet",
        "description": "",
        "operationId": "deletePet",
        "produces": ["application/json", "application/xml"],
        "parameters": [
          {
            "name": "api_key",
            "in": "header",
            "required": false,
            "type": "string"
          },
          {
            "name": "petId",
            "in": "path",
            "description": "Pet id to delete",
            "required": true,
            "type": "integer",
            "format": "int64"
          }
        ],
        "responses": {
          "400": {
            "description": "Invalid ID supplied"
          },
          "404": {
            "description": "Pet not found"
          }
        },
        "security": [
          {
            "petstore_auth": ["write:pets", "read:pets"]
          }
        ]
      }
    }
  },
  "securityDefinitions": {
    "api_key": {
      "type": "apiKey",
      "name": "api_key",
      "in": "header"
    },
    "petstore_auth": {
      "type": "oauth2",
      "authorizationUrl": "https://petstore.swagger.io/oauth/authorize",
      "flow": "implicit",
      "scopes": {
        "read:pets": "read your pets",
        "write:pets": "modify pets in your account"
      }
    }
  },
  "definitions": {
    "Category": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "Pet": {
      "type": "object",
      "required": ["name", "photoUrls"],
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64"
        },
        "category": {
          "$ref": "#/definitions/Category"
        },
        "name": {
          "type": "string",
          "example": "doggie"
        },
        "photoUrls": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "tags": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Tag"
          }
        },
        "status": {
          "type": "string",
          "enum": ["available", "pending", "sold"]
        }
      }
    },
    "Tag": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64"
        },
        "name": {
          "type": "string"
        }
      }
    }
  }
}

The result I would expect after merging is something like this:

{
  "/api/userphotos": {
    "get": { /* from spec 1 */ },
    "patch": { /* from spec 1 */ },
    "delete": { /* from spec 1 */ },
    "post": { /* from spec 2 */ }
  }
}

However, the merged spec becomes:

{
  "swagger": "2.0",
  "info": {
    "version": "1.0.7",
    "title": "Swagger Petstore",
    "description": "Filtered spec containing only POST /pet/{petId}"
  },
  "paths": {
    "/pet/{petId}": {
      "post": {
        "tags": [
          "pet"
        ],
        "summary": "Updates a pet in the store with form data",
        "description": "",
        "operationId": "swagger1_updatePetWithForm",
        "consumes": [
          "application/x-www-form-urlencoded"
        ],
        "produces": [
          "application/json",
          "application/xml"
        ],
        "parameters": [
          {
            "name": "petId",
            "in": "path",
            "description": "ID of pet that needs to be updated",
            "required": true,
            "type": "integer",
            "format": "int64"
          },
          {
            "name": "name",
            "in": "formData",
            "description": "Updated name of the pet",
            "required": false,
            "type": "string"
          },
          {
            "name": "status",
            "in": "formData",
            "description": "Updated status of the pet",
            "required": false,
            "type": "string"
          }
        ],
        "responses": {
          "405": {
            "description": "Invalid input"
          }
        },
        "security": [
          {
            "petstore_auth": [
              "write:pets",
              "read:pets"
            ]
          }
        ],
        "requestBody": [
          {
            "name": "name",
            "in": "formData",
            "description": "Updated name of the pet",
            "required": false,
            "type": "string"
          },
          {
            "name": "status",
            "in": "formData",
            "description": "Updated status of the pet",
            "required": false,
            "type": "string"
          }
        ]
      }
    },
    "/swagger2/pet/{petId}": {
      "delete": {
        "tags": [
          "pet"
        ],
        "summary": "Deletes a pet",
        "description": "",
        "operationId": "swagger2_deletePet",
        "produces": [
          "application/json",
          "application/xml"
        ],
        "parameters": [
          {
            "name": "api_key",
            "in": "header",
            "required": false,
            "type": "string"
          },
          {
            "name": "petId",
            "in": "path",
            "description": "Pet id to delete",
            "required": true,
            "type": "integer",
            "format": "int64"
          }
        ],
        "responses": {
          "400": {
            "description": "Invalid ID supplied"
          },
          "404": {
            "description": "Pet not found"
          }
        },
        "security": [
          {
            "petstore_auth": [
              "write:pets",
              "read:pets"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {},
    "parameters": {},
    "requestBodies": {},
    "responses": {},
    "headers": {},
    "securitySchemes": {},
    "examples": {},
    "links": {},
    "callbacks": {}
  }
}

and this generates the output

export const postPhotosV2ApiUserphotos = <...) => (options.client ?? client).post<...>({
    url: '/photosV2/api/userphotos',
    ...options,
    headers: {
        'Content-Type': 'application/json',
        ...options.headers
    }
});

Reproducible example or configuration

https://stackblitz.com/edit/hey-api-client-fetch-example-n41ipjsh?file=src%2Fclient%2Fsdk.gen.ts

[pullfrog]

  ^{｜ Build this ➔ ｜ Make a plan ➔ ｜ pullfrog.com}

[bolt-new-by-stackblitz]

Start a new pull request in StackBlitz Codeflow.

• hey-api-client-fetch-example-n41ipjsh (Open reproduction)

[mrlubos]

@kossel are you able to provide actual minimal specs to reproduce the issue? This should be easily resolvable once it can be reproduced!

[kossel]

@mrlubos Hi
here is the sandbox https://stackblitz.com/edit/hey-api-client-fetch-example-n41ipjsh?file=src%2Fclient%2Fsdk.gen.ts

I have swagger1.json and swagger2.json they have the same path, but one with post one with delete.

the output in sdk.gen.ts are

• swagger1UpdatePetWithForm url: /pet/{petId}
• swagger2DeletePet() url: /swagger2/pet/{petId}

I feel there could be a better way for the conflict, just some thoughts:

• should never make assumption and change the url, since it breaks the application, it should match to the path
• besides checking paths for collision should check for method collision, then apply conflict resolution strategy
• if both path and method collide, then suffix/prefix something but no url change
• if possible allow us to pass a "conflict resolution" function

our use case came because legacy reason, we use header x-api-version for api versioning, so an ideal scenario for a conflict like this:

get /pet/{petId}  {x-api-version: 1}
get /pet/{petId} {x-api-version: 2}

would be

const getPetByIdV1 = ()=> {
   client({
     url: '/pet/{id}',
     headers: {
        'x-api-version': 1
     }
   }}
} 

const getPetByIdV2 = ()=> {
   client({
     url: '/pet/{id}',
     headers: {
        'x-api-version': 2
     }
   }}
} 

but I can understand the later might be out of scope 😅

[mrlubos]

@kossel Can you try with @next tag (canary build) and update your comment? I just touched parts related to this. It probably won't fix the issue but it produces different results

[kossel]

Hi @mrlubos

Please let me know if I understood correctly, I did npm install @hey-api/openapi-ts@next the package bumped to "@hey-api/openapi-ts": "0.0.0-next-20260220173109",

however the output sdk.gen.ts still the same. please look the stackblitz

[mrlubos]

This will be fixed in the next release or you can try it with npm i @hey-api/openapi-ts@next again!

[kossel]

@mrlubos Hi
Thanks for the quick change, I tested and worked well. However I still think that we should never add the {prefix} to it even there is a path collision (path + method) there is no guarantee that the url with {prefix} is a valid url, I think creating a duplicated sdk function or take latest or at least offer a way to opt-out this behavior. what do you think?

[mrlubos]

@kossel I think that's fair, can you open an issue for that? Are you running into that problem? What kind of spec does this?