Fix generator for HEAD request boolean response type (#1006)

* Fix generator for HEAD request boolean response type (#1005)

Signed-off-by: Xavier Fournet <[email protected]>

Author: xfournet

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
+
 ## [Unreleased]
 ### Added
 ### Dependencies
@@ -11,6 +12,10 @@ Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ### Fixed
 ### Security
 
+## [3.5.1]
+### Fixed
+- Api Generator: fix HEAD request boolean response type ([#1006](https://github.com/opensearch-project/opensearch-js/pull/1006))
+
 ## [3.5.0]
 ### Added
 ### Dependencies

api/_core/exists.d.ts

@@ -34,7 +34,9 @@ export interface Exists_Request extends Global.Params {
   version_type?: Common.VersionType;
 }
 
-export type Exists_Response = boolean
+export interface Exists_Response extends ApiResponse {
+  body: Exists_ResponseBody;
+}
 
-export type Exists_ResponseBody = Record<string, any>
+export type Exists_ResponseBody = boolean
 

api/_core/existsSource.d.ts

@@ -33,7 +33,9 @@ export interface ExistsSource_Request extends Global.Params {
   version_type?: Common.VersionType;
 }
 
-export type ExistsSource_Response = boolean
+export interface ExistsSource_Response extends ApiResponse {
+  body: ExistsSource_ResponseBody;
+}
 
-export type ExistsSource_ResponseBody = Record<string, any>
+export type ExistsSource_ResponseBody = boolean
 

api/_core/ping.d.ts

@@ -19,7 +19,9 @@ import * as Global from '../_types/_global'
 
 export type Ping_Request = Global.Params & Record<string, any>
 
-export type Ping_Response = boolean
+export interface Ping_Response extends ApiResponse {
+  body: Ping_ResponseBody;
+}
 
-export type Ping_ResponseBody = Record<string, any>
+export type Ping_ResponseBody = boolean
 

api/cluster/existsComponentTemplate.d.ts

@@ -25,7 +25,9 @@ export interface Cluster_ExistsComponentTemplate_Request extends Global.Params {
   name: Common.Name;
 }
 
-export type Cluster_ExistsComponentTemplate_Response = boolean
+export interface Cluster_ExistsComponentTemplate_Response extends ApiResponse {
+  body: Cluster_ExistsComponentTemplate_ResponseBody;
+}
 
-export type Cluster_ExistsComponentTemplate_ResponseBody = Record<string, any>
+export type Cluster_ExistsComponentTemplate_ResponseBody = boolean
 

api/indices/exists.d.ts

@@ -29,7 +29,9 @@ export interface Indices_Exists_Request extends Global.Params {
   local?: boolean;
 }
 
-export type Indices_Exists_Response = boolean
+export interface Indices_Exists_Response extends ApiResponse {
+  body: Indices_Exists_ResponseBody;
+}
 
-export type Indices_Exists_ResponseBody = Record<string, any>
+export type Indices_Exists_ResponseBody = boolean
 

api/indices/existsAlias.d.ts

@@ -27,7 +27,9 @@ export interface Indices_ExistsAlias_Request extends Global.Params {
   name: Common.Names;
 }
 
-export type Indices_ExistsAlias_Response = boolean
+export interface Indices_ExistsAlias_Response extends ApiResponse {
+  body: Indices_ExistsAlias_ResponseBody;
+}
 
-export type Indices_ExistsAlias_ResponseBody = Record<string, any>
+export type Indices_ExistsAlias_ResponseBody = boolean
 

api/indices/existsIndexTemplate.d.ts

@@ -26,7 +26,9 @@ export interface Indices_ExistsIndexTemplate_Request extends Global.Params {
   name: Common.Name;
 }
 
-export type Indices_ExistsIndexTemplate_Response = boolean
+export interface Indices_ExistsIndexTemplate_Response extends ApiResponse {
+  body: Indices_ExistsIndexTemplate_ResponseBody;
+}
 
-export type Indices_ExistsIndexTemplate_ResponseBody = Record<string, any>
+export type Indices_ExistsIndexTemplate_ResponseBody = boolean
 

api/indices/existsTemplate.d.ts

@@ -26,7 +26,9 @@ export interface Indices_ExistsTemplate_Request extends Global.Params {
   name: Common.Names;
 }
 
-export type Indices_ExistsTemplate_Response = boolean
+export interface Indices_ExistsTemplate_Response extends ApiResponse {
+  body: Indices_ExistsTemplate_ResponseBody;
+}
 
-export type Indices_ExistsTemplate_ResponseBody = Record<string, any>
+export type Indices_ExistsTemplate_ResponseBody = boolean
 

api/ism/existsPolicy.d.ts

@@ -21,7 +21,9 @@ export interface Ism_ExistsPolicy_Request extends Global.Params {
   policy_id: string;
 }
 
-export type Ism_ExistsPolicy_Response = boolean
+export interface Ism_ExistsPolicy_Response extends ApiResponse {
+  body: Ism_ExistsPolicy_ResponseBody;
+}
 
-export type Ism_ExistsPolicy_ResponseBody = any
+export type Ism_ExistsPolicy_ResponseBody = boolean
 

api_generator/src/renderers/render_types/FunctionTypesContainer.ts

@@ -53,12 +53,12 @@ export default class FunctionTypesContainer extends TypesContainer {
   }
 
   #build_response (): Schema {
-    if (this._func.http_verbs.has('HEAD')) return { type: 'boolean' }
     const schema = { properties: { body: { $ref: this.create_ref('response_body') } }, required: ['body'] }
     return { allOf: [schema, { $ref: 'ApiResponse' }] }
   }
 
   #build_response_body (): Schema {
+    if (this._func.http_verbs.has('HEAD')) return { type: 'boolean' }
     const body = this._func.response_body
     if (body == null) return { type: 'object' }
     if (body.ref_obj != null) return body.ref_obj

package.json

@@ -36,7 +36,7 @@
     "LICENSE.txt"
   ],
   "homepage": "https://www.opensearch.org/",
-  "version": "3.5.0",
+  "version": "3.5.1",
   "versionCanary": "7.10.0-canary.6",
   "keywords": [
     "opensearch",