Fix route param parsing when the param begins with just one letter (rebased original PR #686 by @ahoseinian)

.changeset/honest-bears-stay.md

@@ -0,0 +1,5 @@
+---
+"swagger-typescript-api": patch
+---
+
+Fix query params detection on route name parsing

src/schema-routes/schema-routes.ts

@@ -95,8 +95,9 @@ export class SchemaRoutes {
       this.config.hooks.onPreBuildRoutePath(originalRouteName) ||
       originalRouteName;
 
+    // TODO forbid leading symbols [\]^` in a major release (allowed yet for backwards compatibility)
     const pathParamMatches = (routeName || "").match(
-      /({(([A-z]){1}([a-zA-Z0-9]-?_?\.?)+)([0-9]+)?})|(:(([A-z]){1}([a-zA-Z0-9]-?_?\.?)+)([0-9]+)?:?)/g,
+      /({[\w[\\\]^`][-_.\w]*})|(:[\w[\\\]^`][-_.\w]*:?)/g,
     );
 
     // used in case when path parameters is not declared in requestInfo.parameters ("in": "path")

tests/spec/extractRequestParams/__snapshots__/basic.test.ts.snap

@@ -476,6 +476,52 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
         ...params,
       }),
   };
+  iKey = {
+    /**
+     * @description Get public details of an Authentiq ID.
+     *
+     * @tags key, get
+     * @name IKeyDetail
+     * @request GET:/i_key/{i_PK}
+     */
+    iKeyDetail: (iPk: string, params: RequestParams = {}) =>
+      this.request<
+        {
+          /** @format date-time */
+          since?: string;
+          status?: string;
+          /** base64safe encoded public signing key */
+          sub?: string;
+        },
+        Error
+      >({
+        path: \`/i_key/\${iPk}\`,
+        method: "GET",
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * @description Get public details of an Authentiq ID.
+     *
+     * @tags key, get
+     * @name UnderlinesDetail
+     * @request GET:/i_key/underlines/{i__UK}
+     */
+    underlinesDetail: (iUk: string, params: RequestParams = {}) =>
+      this.request<
+        {
+          /** base64safe encoded public signing key */
+          sub?: string;
+        },
+        Error
+      >({
+        path: \`/i_key/underlines/\${iUk}\`,
+        method: "GET",
+        format: "json",
+        ...params,
+      }),
+  };
   login = {
     /**
      * @description push sign-in request See: https://github.com/skion/authentiq/wiki/JWT-Examples

tests/spec/extractRequestParams/schema.json

@@ -56,6 +56,20 @@
       "required": true,
       "type": "string"
     },
+    "i__UK": {
+      "description": "Variable with double __ in it.",
+      "in": "path",
+      "name": "i__UK",
+      "required": true,
+      "type": "string"
+    },
+    "i_PK": {
+      "description": "Public Signing Key - Authentiq ID (43 chars)",
+      "in": "path",
+      "name": "i_PK",
+      "required": true,
+      "type": "string"
+    },
     "BarBaz": {
       "description": "bar baz",
       "in": "path",
@@ -424,6 +438,85 @@
         "tags": ["key", "put"]
       }
     },
+    "/i_key/{i_PK}": {
+      "get": {
+        "description": "Get public details of an Authentiq ID.\n",
+        "parameters": [
+          {
+            "$ref": "#/parameters/i_PK"
+          }
+        ],
+        "produces": ["application/json"],
+        "responses": {
+          "200": {
+            "description": "Successfully retrieved",
+            "schema": {
+              "properties": {
+                "since": {
+                  "format": "date-time",
+                  "type": "string"
+                },
+                "status": {
+                  "type": "string"
+                },
+                "sub": {
+                  "description": "base64safe encoded public signing key",
+                  "type": "string"
+                }
+              },
+              "title": "JWT",
+              "type": "object"
+            }
+          },
+          "404": {
+            "description": "Unknown key `unknown-key`",
+            "schema": {
+              "$ref": "#/definitions/Error"
+            }
+          },
+          "410": {
+            "description": "Key is revoked (gone). `revoked-key`",
+            "schema": {
+              "$ref": "#/definitions/Error"
+            }
+          },
+          "default": {
+            "$ref": "#/responses/ErrorResponse"
+          }
+        },
+        "tags": ["key", "get"]
+      }
+    },
+    "/i_key/underlines/{i__UK}": {
+      "get": {
+        "description": "Get public details of an Authentiq ID.\n",
+        "parameters": [
+          {
+            "$ref": "#/parameters/i__UK"
+          }
+        ],
+        "produces": ["application/json"],
+        "responses": {
+          "200": {
+            "description": "Successfully retrieved",
+            "schema": {
+              "properties": {
+                "sub": {
+                  "description": "base64safe encoded public signing key",
+                  "type": "string"
+                }
+              },
+              "title": "JWT",
+              "type": "object"
+            }
+          },
+          "default": {
+            "$ref": "#/responses/ErrorResponse"
+          }
+        },
+        "tags": ["key", "get"]
+      }
+    },
     "/login": {
       "post": {
         "consumes": ["application/jwt"],