Add additional compiler warnings (#628)

* Cleanup spec

* Add additional compiler warnings

Author: delvedor

compiler/model/build-model.ts

@@ -180,8 +180,6 @@ function compileClassOrInterfaceDeclaration (declaration: ClassDeclaration | Int
     )
   }
 
-  let bodyWasSet = false
-
   // Request and Response definitions needs to be handled
   // differently from normal classes
   if (name === 'Request' || name === 'Response') {
@@ -240,15 +238,16 @@ function compileClassOrInterfaceDeclaration (declaration: ClassDeclaration | Int
               `The property '${part.name}' does not exist in the rest-api-spec ${namespace} url template`
             )
           }
+          assert(member, property.properties.length > 0, 'There is no need to declare an empty object path_parts, just remove the path_parts declaration.')
           type.path = property.properties
         } else if (property.name === 'query_parameters') {
+          assert(member, property.properties.length > 0, 'There is no need to declare an empty object query_parameters, just remove the query_parameters declaration.')
           type.query = property.properties
         } else if (property.name === 'body') {
-          bodyWasSet = true
           // the body can either be a value (eg Array<string> or an object with properties)
           if (property.valueOf != null) {
             if (property.valueOf.kind === 'instance_of' && property.valueOf.type.name === 'Void') {
-              type.body = { kind: 'no_body' }
+              assert(member, false, 'There is no need to use Void in requets definitions, just remove the body declaration.')
             } else {
               type.body = { kind: 'value', value: property.valueOf }
               const openGenerics = declaration.getTypeParameters().map(modelGenerics)
@@ -268,7 +267,8 @@ function compileClassOrInterfaceDeclaration (declaration: ClassDeclaration | Int
                 type.body.identifier = tags.identifier
               }
             }
-          } else if (property.properties.length > 0) {
+          } else if (Array.isArray(property.properties)) {
+            assert(member, property.properties.length > 0, 'There is no need to declare an empty object body, just remove the body declaration.')
             type.body = { kind: 'properties', properties: property.properties }
           }
         } else {
@@ -291,7 +291,6 @@ function compileClassOrInterfaceDeclaration (declaration: ClassDeclaration | Int
         )
         const property = visitRequestOrResponseProperty(member)
         if (property.name === 'body') {
-          bodyWasSet = true
           // the body can either by a value (eg Array<string> or an object with properties)
           if (property.valueOf != null) {
             if (property.valueOf.kind === 'instance_of' && property.valueOf.type.name === 'Void') {
@@ -341,10 +340,15 @@ function compileClassOrInterfaceDeclaration (declaration: ClassDeclaration | Int
     }
 
     // If the body wasn't set and we have a parent class, then it's a property body with no additional properties
-    if (!bodyWasSet && type.inherits != null) {
+    if (type.body.kind === 'no_body' && type.inherits != null) {
       const parent = type.inherits.type
       // RequestBase is special as it's a "marker" base class that doesn't imply a property body type. We should get rid of it.
-      if (!(parent.name === 'RequestBase' && parent.namespace === '_types')) {
+      if (parent.name === 'RequestBase' && parent.namespace === '_types') {
+        // nothing to do
+      // CatRequestBase is special as it's a "marker" base class that doesn't imply a property body type. We should get rid of it.
+      } else if (parent.name === 'CatRequestBase' && parent.namespace === 'cat._types') {
+        // nothing to do
+      } else {
         type.body = { kind: 'properties', properties: new Array<model.Property>() }
       }
     }

specification/_global/clear_scroll/ClearScrollRequest.ts

@@ -29,7 +29,6 @@ export interface Request extends RequestBase {
   path_parts?: {
     scroll_id?: Ids
   }
-  query_parameters?: {}
   body?: {
     scroll_id?: Ids
   }

specification/_global/close_point_in_time/ClosePointInTimeRequest.ts

@@ -26,8 +26,6 @@ import { Id } from '@_types/common'
  * @stability TODO
  */
 export interface Request extends RequestBase {
-  path_parts?: {}
-  query_parameters?: {}
   body?: {
     id: Id
   }

specification/_global/delete/DeleteRequest.ts

@@ -53,5 +53,4 @@ export interface Request extends RequestBase {
     version_type?: VersionType
     wait_for_active_shards?: WaitForActiveShards
   }
-  body?: {}
 }

specification/_global/delete_by_query_rethrottle/DeleteByQueryRethrottleRequest.ts

@@ -33,5 +33,4 @@ export interface Request extends RequestBase {
   query_parameters?: {
     requests_per_second?: long
   }
-  body?: {}
 }

specification/_global/delete_script/DeleteScriptRequest.ts

@@ -34,5 +34,4 @@ export interface Request extends RequestBase {
     master_timeout?: Time
     timeout?: Time
   }
-  body?: {}
 }

specification/_global/exists/DocumentExistsRequest.ts

@@ -51,5 +51,4 @@ export interface Request extends RequestBase {
     version?: VersionNumber
     version_type?: VersionType
   }
-  body?: {}
 }

specification/_global/exists_source/SourceExistsRequest.ts

@@ -50,5 +50,4 @@ export interface Request extends RequestBase {
     version?: VersionNumber
     version_type?: VersionType
   }
-  body?: {}
 }

specification/_global/open_point_in_time/OpenPointInTimeRequest.ts

@@ -33,5 +33,4 @@ export interface Request extends RequestBase {
   query_parameters?: {
     keep_alive?: Time
   }
-  body?: {}
 }

specification/_global/ping/PingRequest.ts

@@ -24,7 +24,4 @@ import { RequestBase } from '@_types/Base'
  * @since 0.0.0
  * @stability TODO
  */
-export interface Request extends RequestBase {
-  query_parameters?: {}
-  body?: {}
-}
+export interface Request extends RequestBase {}

specification/_global/reindex_rethrottle/ReindexRethrottleRequest.ts

@@ -33,5 +33,4 @@ export interface Request extends RequestBase {
   query_parameters?: {
     requests_per_second?: long
   }
-  body?: {}
 }

specification/_global/render_search_template/RenderSearchTemplateRequest.ts

@@ -31,7 +31,6 @@ export interface Request extends RequestBase {
   path_parts?: {
     id?: Id
   }
-  query_parameters?: {}
   body?: {
     file?: string
     params?: Dictionary<string, UserDefinedValue>

specification/_global/scripts_painless_execute/ExecutePainlessScriptRequest.ts

@@ -27,7 +27,6 @@ import { PainlessContextSetup } from './types'
  * @stability TODO
  */
 export interface Request extends RequestBase {
-  query_parameters?: {}
   body?: {
     context?: string
     context_setup?: PainlessContextSetup

specification/_global/update_by_query_rethrottle/UpdateByQueryRethrottleRequest.ts

@@ -33,5 +33,4 @@ export interface Request extends RequestBase {
   query_parameters?: {
     requests_per_second?: long
   }
-  body?: {}
 }

specification/async_search/get/AsyncSearchGetRequest.ts

@@ -35,5 +35,4 @@ export interface Request extends RequestBase {
     typed_keys?: boolean
     wait_for_completion_timeout?: Time
   }
-  body?: {}
 }

specification/async_search/status/AsyncSearchStatusRequest.ts

@@ -29,5 +29,4 @@ export interface Request extends RequestBase {
   path_parts?: {
     id: Id
   }
-  query_parameters?: {}
 }

specification/cat/aliases/CatAliasesRequest.ts

@@ -32,5 +32,4 @@ export interface Request extends CatRequestBase {
   query_parameters?: {
     expand_wildcards?: ExpandWildcards
   }
-  body?: {}
 }

specification/cat/allocation/CatAllocationRequest.ts

@@ -32,5 +32,4 @@ export interface Request extends CatRequestBase {
   query_parameters?: {
     bytes?: Bytes
   }
-  body?: {}
 }

specification/cat/count/CatCountRequest.ts

@@ -29,6 +29,4 @@ export interface Request extends CatRequestBase {
   path_parts?: {
     index?: Indices
   }
-  query_parameters?: {}
-  body?: {}
 }

specification/cat/fielddata/CatFielddataRequest.ts

@@ -32,5 +32,4 @@ export interface Request extends CatRequestBase {
   query_parameters?: {
     bytes?: Bytes
   }
-  body?: {}
 }

specification/cat/health/CatHealthRequest.ts

@@ -29,5 +29,4 @@ export interface Request extends CatRequestBase {
     include_timestamp?: boolean
     ts?: boolean
   }
-  body?: {}
 }

specification/cat/help/CatHelpRequest.ts

@@ -24,7 +24,4 @@ import { CatRequestBase } from '@cat/_types/CatBase'
  * @since 0.0.0
  * @stability TODO
  */
-export interface Request extends CatRequestBase {
-  query_parameters?: {}
-  body?: {}
-}
+export interface Request extends CatRequestBase {}

specification/cat/indices/CatIndicesRequest.ts

@@ -36,5 +36,4 @@ export interface Request extends CatRequestBase {
     include_unloaded_segments?: boolean
     pri?: boolean
   }
-  body?: {}
 }

specification/cat/master/CatMasterRequest.ts

@@ -24,7 +24,4 @@ import { CatRequestBase } from '@cat/_types/CatBase'
  * @since 0.0.0
  * @stability TODO
  */
-export interface Request extends CatRequestBase {
-  query_parameters?: {}
-  body?: {}
-}
+export interface Request extends CatRequestBase {}

specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts

@@ -33,5 +33,4 @@ export interface Request extends CatRequestBase {
     allow_no_match?: boolean
     bytes?: Bytes
   }
-  body?: {}
 }

specification/cat/ml_datafeeds/CatDatafeedsRequest.ts

@@ -32,5 +32,4 @@ export interface Request extends CatRequestBase {
   query_parameters?: {
     allow_no_datafeeds?: boolean
   }
-  body?: {}
 }

specification/cat/ml_jobs/CatJobsRequest.ts

@@ -33,5 +33,4 @@ export interface Request extends CatRequestBase {
     allow_no_jobs?: boolean
     bytes?: Bytes
   }
-  body?: {}
 }

specification/cat/ml_trained_models/CatTrainedModelsRequest.ts

@@ -36,5 +36,4 @@ export interface Request extends CatRequestBase {
     from?: integer
     size?: integer
   }
-  body?: {}
 }

specification/cat/nodeattrs/CatNodeAttributesRequest.ts

@@ -24,7 +24,4 @@ import { CatRequestBase } from '@cat/_types/CatBase'
  * @since 0.0.0
  * @stability TODO
  */
-export interface Request extends CatRequestBase {
-  query_parameters?: {}
-  body?: {}
-}
+export interface Request extends CatRequestBase {}

specification/cat/nodes/CatNodesRequest.ts

@@ -30,5 +30,4 @@ export interface Request extends CatRequestBase {
     bytes?: Bytes
     full_id?: boolean | string
   }
-  body?: {}
 }

specification/cat/pending_tasks/CatPendingTasksRequest.ts

@@ -24,7 +24,4 @@ import { CatRequestBase } from '@cat/_types/CatBase'
  * @since 0.0.0
  * @stability TODO
  */
-export interface Request extends CatRequestBase {
-  query_parameters?: {}
-  body?: {}
-}
+export interface Request extends CatRequestBase {}

specification/cat/plugins/CatPluginsRequest.ts

@@ -24,7 +24,4 @@ import { CatRequestBase } from '@cat/_types/CatBase'
  * @since 0.0.0
  * @stability TODO
  */
-export interface Request extends CatRequestBase {
-  query_parameters?: {}
-  body?: {}
-}
+export interface Request extends CatRequestBase {}

specification/cat/recovery/CatRecoveryRequest.ts

@@ -34,5 +34,4 @@ export interface Request extends CatRequestBase {
     bytes?: Bytes
     detailed?: boolean
   }
-  body?: {}
 }

specification/cat/repositories/CatRepositoriesRequest.ts

@@ -24,7 +24,4 @@ import { CatRequestBase } from '@cat/_types/CatBase'
  * @since 2.1.0
  * @stability TODO
  */
-export interface Request extends CatRequestBase {
-  query_parameters?: {}
-  body?: {}
-}
+export interface Request extends CatRequestBase {}

specification/cat/segments/CatSegmentsRequest.ts

@@ -32,5 +32,4 @@ export interface Request extends CatRequestBase {
   query_parameters?: {
     bytes?: Bytes
   }
-  body?: {}
 }

specification/cat/shards/CatShardsRequest.ts

@@ -32,5 +32,4 @@ export interface Request extends CatRequestBase {
   query_parameters?: {
     bytes?: Bytes
   }
-  body?: {}
 }

specification/cat/snapshots/CatSnapshotsRequest.ts

@@ -32,5 +32,4 @@ export interface Request extends CatRequestBase {
   query_parameters?: {
     ignore_unavailable?: boolean
   }
-  body?: {}
 }

specification/cat/tasks/CatTasksRequest.ts

@@ -32,5 +32,4 @@ export interface Request extends CatRequestBase {
     node_id?: string[]
     parent_task?: long
   }
-  body?: {}
 }

specification/cat/templates/CatTemplatesRequest.ts

@@ -29,6 +29,4 @@ export interface Request extends CatRequestBase {
   path_parts?: {
     name?: Name
   }
-  query_parameters?: {}
-  body?: {}
 }

specification/cat/thread_pool/CatThreadPoolRequest.ts

@@ -32,5 +32,4 @@ export interface Request extends CatRequestBase {
   query_parameters?: {
     size?: Size | boolean
   }
-  body?: {}
 }

specification/cat/transforms/CatTransformsRequest.ts

@@ -35,5 +35,4 @@ export interface Request extends CatRequestBase {
     from?: integer
     size?: integer
   }
-  body?: {}
 }

specification/ccr/put_auto_follow_pattern/PutAutoFollowPatternRequest.ts

@@ -33,7 +33,6 @@ export interface Request extends RequestBase {
   path_parts?: {
     name: Name // param name in docs: auto_follow_pattern_name
   }
-  query_parameters?: {}
   body?: {
     remote_cluster: string
     follow_index_pattern?: IndexPattern

specification/cluster/exists_component_template/ClusterComponentTemplateExistsRequest.ts

@@ -49,5 +49,4 @@ export interface Request extends RequestBase {
      */
     local?: boolean
   }
-  body?: {}
 }

specification/cluster/get_settings/ClusterGetSettingsRequest.ts

@@ -32,5 +32,4 @@ export interface Request extends RequestBase {
     master_timeout?: Time
     timeout?: Time
   }
-  body?: {}
 }

specification/cluster/pending_tasks/ClusterPendingTasksRequest.ts

@@ -31,5 +31,4 @@ export interface Request extends RequestBase {
     /** @server_default 30s */
     master_timeout?: Time
   }
-  body?: {}
 }

specification/enrich/execute_policy/ExecuteEnrichPolicyRequest.ts

@@ -32,5 +32,4 @@ export interface Request extends RequestBase {
   query_parameters?: {
     wait_for_completion?: boolean
   }
-  body?: {}
 }

specification/enrich/stats/EnrichStatsRequest.ts

@@ -24,7 +24,4 @@ import { RequestBase } from '@_types/Base'
  * @since 7.5.0
  * @stability TODO
  */
-export interface Request extends RequestBase {
-  query_parameters?: {}
-  body?: {}
-}
+export interface Request extends RequestBase {}

specification/indices/add_block/IndicesAddBlockRequest.ts

@@ -38,7 +38,6 @@ export interface Request extends RequestBase {
     master_timeout?: Time // default: 30s
     timeout?: Time // default: 30s
   }
-  body?: {}
 }
 
 export enum IndicesBlockOptions {

specification/indices/analyze/IndicesAnalyzeRequest.ts

@@ -33,7 +33,6 @@ export interface Request extends RequestBase {
   path_parts?: {
     index?: IndexName
   }
-  query_parameters?: {}
   body?: {
     analyzer?: string
     attributes?: string[]

specification/indices/clear_cache/IndicesIndicesClearCacheRequest.ts

@@ -38,5 +38,4 @@ export interface Request extends RequestBase {
     query?: boolean
     request?: boolean
   }
-  body?: {}
 }