Allow to add a dot in query parameters (airtasker#1370)

Thodin3 · May 4, 2021 · 9a025c1 · 9a025c1
1 parent 03b3062
commit 9a025c1
Show file tree

Hide file tree

Showing 9 changed files with 19 additions and 9 deletions.
diff --git a/lib/src/generators/openapi2/__snapshots__/openapi2.spec.ts.snap b/lib/src/generators/openapi2/__snapshots__/openapi2.spec.ts.snap
@@ -692,7 +692,7 @@ exports[`OpenAPI 2 generator query params endpoint with query params 1`] = `
             \\"type\\": \\"string\\"
           },
           {
-            \\"name\\": \\"postcode\\",
+            \\"name\\": \\"post.code\\",
             \\"in\\": \\"query\\",
             \\"required\\": false,
             \\"type\\": \\"string\\"

diff --git a/lib/src/generators/openapi2/__spec-examples__/contract-with-query-params.ts b/lib/src/generators/openapi2/__spec-examples__/contract-with-query-params.ts
@@ -21,7 +21,7 @@ class EndpointWithQueryParams {
     @queryParams
     queryParams: {
       country: String;
-      postcode?: String;
+      "post.code"?: String;
     }
   ) {}
 

diff --git a/lib/src/generators/openapi2/openapi2.spec.ts b/lib/src/generators/openapi2/openapi2.spec.ts
@@ -152,7 +152,7 @@ describe("OpenAPI 2 generator", () => {
           type: expect.anything()
         },
         {
-          name: "postcode",
+          name: "post.code",
           in: "query",
           required: false,
           type: expect.anything()

diff --git a/lib/src/generators/openapi3/__snapshots__/openapi3.spec.ts.snap b/lib/src/generators/openapi3/__snapshots__/openapi3.spec.ts.snap
@@ -885,7 +885,7 @@ exports[`OpenAPI 3 generator query params endpoint with query params 1`] = `
             }
           },
           {
-            \\"name\\": \\"postcode\\",
+            \\"name\\": \\"post.code\\",
             \\"in\\": \\"query\\",
             \\"required\\": false,
             \\"schema\\": {

diff --git a/lib/src/generators/openapi3/__spec-examples__/contract-with-query-params.ts b/lib/src/generators/openapi3/__spec-examples__/contract-with-query-params.ts
@@ -21,7 +21,7 @@ class EndpointWithQueryParams {
     @queryParams
     queryParams: {
       country: String;
-      postcode?: String;
+      "post.code"?: String;
     }
   ) {}
 

diff --git a/lib/src/generators/openapi3/openapi3.spec.ts b/lib/src/generators/openapi3/openapi3.spec.ts
@@ -170,7 +170,7 @@ describe("OpenAPI 3 generator", () => {
           schema: expect.anything()
         },
         {
-          name: "postcode",
+          name: "post.code",
           in: "query",
           required: false,
           schema: expect.anything()

diff --git a/lib/src/parsers/__spec-examples__/query-params.ts b/lib/src/parsers/__spec-examples__/query-params.ts
@@ -27,6 +27,7 @@ class QueryParamsClass {
         objectProp: string;
       };
       arrayProperty: string[];
+      "property.with.dots": string;
     },
     @queryParams
     interfaceQueryParams: IQueryParams,

diff --git a/lib/src/parsers/query-params-parser.spec.ts b/lib/src/parsers/query-params-parser.spec.ts
@@ -26,7 +26,7 @@ describe("query params parser", () => {
       typeTable,
       lociTable
     ).unwrapOrThrow();
-    expect(result).toHaveLength(7);
+    expect(result).toHaveLength(8);
     expect(result[0]).toStrictEqual({
       description: undefined,
       examples: undefined,
@@ -112,6 +112,15 @@ describe("query params parser", () => {
       },
       optional: false
     });
+    expect(result[7]).toStrictEqual({
+      description: undefined,
+      examples: undefined,
+      name: "property.with.dots",
+      type: {
+        kind: TypeKind.STRING
+      },
+      optional: false
+    });
   });
 
   test("parses @queryParams as interface parameter", () => {

diff --git a/lib/src/parsers/query-params-parser.ts b/lib/src/parsers/query-params-parser.ts
@@ -70,10 +70,10 @@ function extractQueryParamName(
   propertySignature: PropertySignature
 ): Result<string, ParserError> {
   const name = getPropertyName(propertySignature);
-  if (!/^[\w-]*$/.test(name)) {
+  if (!/^[\w-.]*$/.test(name)) {
     return err(
       new ParserError(
-        "@queryParams property name may only contain alphanumeric, underscore and hyphen characters",
+        "@queryParams property name may only contain alphanumeric, underscore, dot and hyphen characters",
         {
           file: propertySignature.getSourceFile().getFilePath(),
           position: propertySignature.getPos()