feat(api-client): void return type for methods with empty schema

flowup · May 18, 2019 · f1977eb · f1977eb
1 parent d14ef9d
commit f1977eb
Show file tree

Hide file tree

Showing 10 changed files with 42 additions and 43 deletions.
diff --git a/src/helper.ts b/src/helper.ts
@@ -1,8 +1,8 @@
 import { Reference } from 'swagger-schema-official';
 import { FileInfix } from './types';
 
-export const BASIC_TS_TYPE_REGEX = /\b(?:string|number|integer|boolean)\b/;
-const BUILD_IN_TS_TYPE_REGEX = /^(?:string|number|integer|boolean|null|undefined|any|Object|Date|File|Blob)\b/i;
+export const BASIC_TS_TYPE_REGEX = /\b(?:string|number|integer|boolean|void)\b/;
+const BUILD_IN_TS_TYPE_REGEX = /^(?:string|number|integer|boolean|null|undefined|any|void|Object|Date|File|Blob)\b/i;
 
 export function toCamelCase(text: string = '', lowerFirst: boolean = true): string {
   text = removeDuplicateWords(text);

diff --git a/src/parser.ts b/src/parser.ts
@@ -332,8 +332,7 @@ function determineResponseType(response: Response): {
   const {schema} = response;
 
   if (schema == null) {
-    logWarn('200 or 201 response schema not specified; `any` will be used');
-    return {name: 'any', type: 'any'};
+    return {name: 'void', type: 'void'};
   }
 
   const nullable = (schema as Schema & { 'x-nullable'?: boolean })['x-nullable'] || false;

diff --git a/tests/custom/api/api-client.interface.ts b/tests/custom/api/api-client.interface.ts
@@ -34,7 +34,7 @@ export interface APIClientInterface {
       id: string,
     },
     requestHttpOptions?: HttpOptions
-  ): Observable<any>;
+  ): Observable<void>;
 
   getCustomers(
     requestHttpOptions?: HttpOptions

diff --git a/tests/custom/api/api-client.service.ts b/tests/custom/api/api-client.service.ts
@@ -106,14 +106,14 @@ export class APIClient implements APIClientInterface {
       id: string,
     },
     requestHttpOptions?: HttpOptions
-  ): Observable<any> {
+  ): Observable<void> {
     const path = `/pets/${args.id}`;
     const options: APIHttpOptions = {
       ...this.options,
       ...requestHttpOptions,
     };
 
-    return this.sendRequest<any>('DELETE', path, options);
+    return this.sendRequest<void>('DELETE', path, options);
   }
 
   getCustomers(

diff --git a/tests/esquare/api/api-client.interface.ts b/tests/esquare/api/api-client.interface.ts
@@ -66,7 +66,7 @@ export interface APIClientInterface {
       structureId: number,  // structure id to delete
     },
     requestHttpOptions?: HttpOptions
-  ): Observable<any>;
+  ): Observable<void>;
 
   /**
    * [Screenshot from design](http://prntscr.com/hy4z8d)
@@ -231,7 +231,7 @@ export interface APIClientInterface {
       id: number,  // Id of current import
     },
     requestHttpOptions?: HttpOptions
-  ): Observable<any>;
+  ): Observable<void>;
 
   /**
    * [Screenshot from design](http://prntscr.com/hy5bi6)
@@ -244,7 +244,7 @@ export interface APIClientInterface {
       file: File,  // file to upload
     },
     requestHttpOptions?: HttpOptions
-  ): Observable<any>;
+  ): Observable<void>;
 
   /**
    * [Screenshot from design](http://prntscr.com/i4052r)
@@ -334,7 +334,7 @@ export interface APIClientInterface {
       id: number,
     },
     requestHttpOptions?: HttpOptions
-  ): Observable<any>;
+  ): Observable<void>;
 
   /**
    * [Screenshot from design](http://prntscr.com/i93q0s)
@@ -379,7 +379,7 @@ export interface APIClientInterface {
       id: number,
     },
     requestHttpOptions?: HttpOptions
-  ): Observable<any>;
+  ): Observable<void>;
 
   /**
    * [Screenshot from design](http://prntscr.com/iba7xr)
@@ -394,7 +394,7 @@ export interface APIClientInterface {
       body?: any,
     },
     requestHttpOptions?: HttpOptions
-  ): Observable<any>;
+  ): Observable<void>;
 
   /**
    * [Screenshot from design](http://prntscr.com/iba8tq)
@@ -447,14 +447,14 @@ export interface APIClientInterface {
       id: number,
     },
     requestHttpOptions?: HttpOptions
-  ): Observable<any>;
+  ): Observable<void>;
 
   disableNotification(
     args: {
       id: number,
     },
     requestHttpOptions?: HttpOptions
-  ): Observable<any>;
+  ): Observable<void>;
 
   getNotification(
     args: {
@@ -469,7 +469,7 @@ export interface APIClientInterface {
       body?: models.NotificationEditable,
     },
     requestHttpOptions?: HttpOptions
-  ): Observable<any>;
+  ): Observable<void>;
 
   createNotification(
     args: {

diff --git a/tests/esquare/api/api-client.service.ts b/tests/esquare/api/api-client.service.ts
@@ -174,14 +174,14 @@ export class APIClient implements APIClientInterface {
       structureId: number,  // structure id to delete
     },
     requestHttpOptions?: HttpOptions
-  ): Observable<any> {
+  ): Observable<void> {
     const path = `/structure/${args.structureId}`;
     const options: APIHttpOptions = {
       ...this.options,
       ...requestHttpOptions,
     };
 
-    return this.sendRequest<any>('DELETE', path, options);
+    return this.sendRequest<void>('DELETE', path, options);
   }
 
   /**
@@ -484,14 +484,14 @@ export class APIClient implements APIClientInterface {
       id: number,  // Id of current import
     },
     requestHttpOptions?: HttpOptions
-  ): Observable<any> {
+  ): Observable<void> {
     const path = `/report/wizard/${args.id}/cancelImport`;
     const options: APIHttpOptions = {
       ...this.options,
       ...requestHttpOptions,
     };
 
-    return this.sendRequest<any>('POST', path, options);
+    return this.sendRequest<void>('POST', path, options);
   }
 
   /**
@@ -505,14 +505,14 @@ export class APIClient implements APIClientInterface {
       file: File,  // file to upload
     },
     requestHttpOptions?: HttpOptions
-  ): Observable<any> {
+  ): Observable<void> {
     const path = `/report/wizard/${args.id}/override`;
     const options: APIHttpOptions = {
       ...this.options,
       ...requestHttpOptions,
     };
 
-    return this.sendRequest<any>('POST', path, options, JSON.stringify(args.description), JSON.stringify(args.file));
+    return this.sendRequest<void>('POST', path, options, JSON.stringify(args.description), JSON.stringify(args.file));
   }
 
   /**
@@ -730,14 +730,14 @@ export class APIClient implements APIClientInterface {
       id: number,
     },
     requestHttpOptions?: HttpOptions
-  ): Observable<any> {
+  ): Observable<void> {
     const path = `/users/${args.id}`;
     const options: APIHttpOptions = {
       ...this.options,
       ...requestHttpOptions,
     };
 
-    return this.sendRequest<any>('DELETE', path, options);
+    return this.sendRequest<void>('DELETE', path, options);
   }
 
   /**
@@ -823,14 +823,14 @@ export class APIClient implements APIClientInterface {
       id: number,
     },
     requestHttpOptions?: HttpOptions
-  ): Observable<any> {
+  ): Observable<void> {
     const path = `/users/roles/${args.id}`;
     const options: APIHttpOptions = {
       ...this.options,
       ...requestHttpOptions,
     };
 
-    return this.sendRequest<any>('DELETE', path, options);
+    return this.sendRequest<void>('DELETE', path, options);
   }
 
   /**
@@ -854,14 +854,14 @@ export class APIClient implements APIClientInterface {
       body?: any,
     },
     requestHttpOptions?: HttpOptions
-  ): Observable<any> {
+  ): Observable<void> {
     const path = `/notifications/markAsViewed`;
     const options: APIHttpOptions = {
       ...this.options,
       ...requestHttpOptions,
     };
 
-    return this.sendRequest<any>('PUT', path, options, JSON.stringify(args.body));
+    return this.sendRequest<void>('PUT', path, options, JSON.stringify(args.body));
   }
 
   /**
@@ -971,29 +971,29 @@ export class APIClient implements APIClientInterface {
       id: number,
     },
     requestHttpOptions?: HttpOptions
-  ): Observable<any> {
+  ): Observable<void> {
     const path = `/notifications/enable/${args.id}`;
     const options: APIHttpOptions = {
       ...this.options,
       ...requestHttpOptions,
     };
 
-    return this.sendRequest<any>('PUT', path, options);
+    return this.sendRequest<void>('PUT', path, options);
   }
 
   disableNotification(
     args: {
       id: number,
     },
     requestHttpOptions?: HttpOptions
-  ): Observable<any> {
+  ): Observable<void> {
     const path = `/notifications/disable/${args.id}`;
     const options: APIHttpOptions = {
       ...this.options,
       ...requestHttpOptions,
     };
 
-    return this.sendRequest<any>('PUT', path, options);
+    return this.sendRequest<void>('PUT', path, options);
   }
 
   getNotification(
@@ -1017,14 +1017,14 @@ export class APIClient implements APIClientInterface {
       body?: models.NotificationEditable,
     },
     requestHttpOptions?: HttpOptions
-  ): Observable<any> {
+  ): Observable<void> {
     const path = `/notifications/${args.id}`;
     const options: APIHttpOptions = {
       ...this.options,
       ...requestHttpOptions,
     };
 
-    return this.sendRequest<any>('PUT', path, options, JSON.stringify(args.body));
+    return this.sendRequest<void>('PUT', path, options, JSON.stringify(args.body));
   }
 
   createNotification(

diff --git a/tests/github/api/services/markdown/markdown-api-client.interface.ts b/tests/github/api/services/markdown/markdown-api-client.interface.ts
@@ -20,7 +20,7 @@ export interface MarkdownAPIClientInterface {
       body: models.Markdown,
     },
     requestHttpOptions?: HttpOptions
-  ): Observable<any>;
+  ): Observable<void>;
 
   /**
    * Render a Markdown document in raw mode
@@ -35,6 +35,6 @@ export interface MarkdownAPIClientInterface {
       xGitHubRequestId?: number,
     },
     requestHttpOptions?: HttpOptions
-  ): Observable<any>;
+  ): Observable<void>;
 
 }
diff --git a/tests/github/api/services/markdown/markdown-api-client.service.ts b/tests/github/api/services/markdown/markdown-api-client.service.ts
@@ -56,7 +56,7 @@ export class MarkdownAPIClient implements MarkdownAPIClientInterface {
       body: models.Markdown,
     },
     requestHttpOptions?: HttpOptions
-  ): Observable<any> {
+  ): Observable<void> {
     const path = `/markdown`;
     const options: APIHttpOptions = {
       ...this.options,
@@ -81,7 +81,7 @@ export class MarkdownAPIClient implements MarkdownAPIClientInterface {
     if ('xGitHubRequestId' in args) {
       options.headers = options.headers.set('X-GitHub-Request-Id', String(args.xGitHubRequestId));
     }
-    return this.sendRequest<any>('POST', path, options, JSON.stringify(args.body));
+    return this.sendRequest<void>('POST', path, options, JSON.stringify(args.body));
   }
 
   /**
@@ -97,7 +97,7 @@ export class MarkdownAPIClient implements MarkdownAPIClientInterface {
       xGitHubRequestId?: number,
     },
     requestHttpOptions?: HttpOptions
-  ): Observable<any> {
+  ): Observable<void> {
     const path = `/markdown/raw`;
     const options: APIHttpOptions = {
       ...this.options,
@@ -122,7 +122,7 @@ export class MarkdownAPIClient implements MarkdownAPIClientInterface {
     if ('xGitHubRequestId' in args) {
       options.headers = options.headers.set('X-GitHub-Request-Id', String(args.xGitHubRequestId));
     }
-    return this.sendRequest<any>('POST', path, options);
+    return this.sendRequest<void>('POST', path, options);
   }
 
   private sendRequest<T>(method: string, path: string, options: HttpOptions, body?: any): Observable<T> {

diff --git a/tests/github/api/services/repos/repos-api-client.interface.ts b/tests/github/api/services/repos/repos-api-client.interface.ts
@@ -560,7 +560,7 @@ export interface ReposAPIClientInterface {
       body: models.DeploymentStatusesCreate,
     },
     requestHttpOptions?: HttpOptions
-  ): Observable<any>;
+  ): Observable<void>;
 
   /**
    * Deprecated. List downloads for a repository.

diff --git a/tests/github/api/services/repos/repos-api-client.service.ts b/tests/github/api/services/repos/repos-api-client.service.ts
@@ -1348,7 +1348,7 @@ export class ReposAPIClient implements ReposAPIClientInterface {
       body: models.DeploymentStatusesCreate,
     },
     requestHttpOptions?: HttpOptions
-  ): Observable<any> {
+  ): Observable<void> {
     const path = `/repos/${args.owner}/${args.repo}/deployments/${args.id}/statuses`;
     const options: APIHttpOptions = {
       ...this.options,
@@ -1373,7 +1373,7 @@ export class ReposAPIClient implements ReposAPIClientInterface {
     if ('xGitHubRequestId' in args) {
       options.headers = options.headers.set('X-GitHub-Request-Id', String(args.xGitHubRequestId));
     }
-    return this.sendRequest<any>('POST', path, options, JSON.stringify(args.body));
+    return this.sendRequest<void>('POST', path, options, JSON.stringify(args.body));
   }
 
   /**