Add docs to query params

contiamo · Jan 9, 2020 · 396eeac · 396eeac
1 parent 45d0ef6
commit 396eeac
Show file tree

Hide file tree

Showing 3 changed files with 434 additions and 403 deletions.
diff --git a/src/scripts/import-open-api.ts b/src/scripts/import-open-api.ts
@@ -337,9 +337,11 @@ export const generateRestfulComponent = (
   const queryParamsType = queryParams
     .map(p => {
       const processedName = IdentifierRegexp.test(p.name) ? p.name : `"${p.name}"`;
-      return `${processedName}${p.required ? "" : "?"}: ${resolveValue(p.schema!)}`;
+      return `${formatDescription(p.description, 2)}${processedName}${p.required ? "" : "?"}: ${resolveValue(
+        p.schema!,
+      )}`;
     })
-    .join("; ");
+    .join(";\n  ");
 
   const genericsTypes =
     verb === "get"
@@ -372,7 +374,9 @@ export ${
   }${
     queryParamsType
       ? `
-export interface ${componentName}QueryParams {${queryParamsType}}
+export interface ${componentName}QueryParams {
+  ${queryParamsType};
+}
 `
       : ""
   }

diff --git a/src/scripts/tests/__snapshots__/import-open-api.test.ts.snap b/src/scripts/tests/__snapshots__/import-open-api.test.ts.snap
@@ -34,7 +34,16 @@ export interface Error {
   message: string;
 }
 
-export interface FindPetsQueryParams {tags?: string[]; limit?: number}
+export interface FindPetsQueryParams {
+  /**
+   * tags to filter by
+   */
+  tags?: string[];
+  /**
+   * maximum number of results to return
+   */
+  limit?: number;
+}
 
 export type FindPetsProps = Omit<GetProps<Pet[], Error, FindPetsQueryParams>, \\"path\\">;