Introduce GenericResponseBody behaviour

compiler/model/utils.ts

@@ -48,7 +48,8 @@ export const knownBehaviors = [
   'ArrayResponseBase',
   'EmptyResponseBase',
   'CommonQueryParameters',
-  'CommonCatQueryParameters'
+  'CommonCatQueryParameters',
+  'GenericResponseBody'
 ]
 
 /**

docs/behaviors.md

@@ -64,3 +64,14 @@ Since these can break the request structure these are listed explicitly as a beh
 ```ts
 class CatRequestBase extends RequestBase implements CommonCatQueryParameters {}
 ```
+
+## GenericResponseBody
+
+Some APIs does not return a structured body, but a generic value instead.
+For examplke the `get_source` API return the source document.
+
+```ts
+class SourceResponse<TDocument>
+  extends ResponseBase
+  implements GenericResponseBody<TDocument> {}
+```

output/schema/schema.json

@@ -122210,28 +122210,36 @@
       "query": []
     },
     {
-      "generics": [
-        {
-          "name": "TDocument",
-          "namespace": "_global.get_source"
-        }
+      "attachedBehaviors": [
+        "GenericResponseBody"
       ],
-      "inherits": [
+      "behaviors": [
         {
           "generics": [
             {
               "kind": "instance_of",
               "type": {
-                "name": "Field",
-                "namespace": "_types"
+                "name": "TDocument",
+                "namespace": "_global.get_source"
               }
-            },
-            {
-              "kind": "user_defined_value"
             }
           ],
           "type": {
-            "name": "DictionaryResponseBase",
+            "name": "GenericResponseBody",
+            "namespace": "_spec_utils"
+          }
+        }
+      ],
+      "generics": [
+        {
+          "name": "TDocument",
+          "namespace": "_global.get_source"
+        }
+      ],
+      "inherits": [
+        {
+          "type": {
+            "name": "ResponseBase",
             "namespace": "_types"
           }
         }
@@ -137654,6 +137662,21 @@
           }
         }
       ]
+    },
+    {
+      "description": "Some APIs does not return a structured body, but a generic value instead.\nFor examplke the `get_source` API return the source document.",
+      "generics": [
+        {
+          "name": "T",
+          "namespace": "_spec_utils"
+        }
+      ],
+      "kind": "interface",
+      "name": {
+        "name": "GenericResponseBody",
+        "namespace": "_spec_utils"
+      },
+      "properties": []
     }
   ]
 }

output/typescript/types.ts

@@ -11809,8 +11809,7 @@ export interface SearchSourceFilteringSourceFilter {
 export interface GetSourceSourceRequest extends GetGetRequest {
 }
 
-export interface GetSourceSourceResponse<TDocument = unknown> extends DictionaryResponseBase<Field, any> {
-}
+export type GetSourceSourceResponse<TDocument = unknown> = TDocument
 
 export interface QueryDslSpanContainingSpanContainingQuery extends QueryDslAbstractionsQueryQueryBase {
   big?: QueryDslSpanSpanQuery
@@ -13495,3 +13494,6 @@ export interface SpecUtilsCommonQueryParameters {
   source_query_string?: string
 }
 
+export interface SpecUtilsGenericResponseBody<T = unknown> {
+}
+

specification/_global/get_source/SourceResponse.ts

@@ -17,14 +17,9 @@
  * under the License.
  */
 
-import { DictionaryResponseBase } from '@_types/Base'
-import { Field } from '@_types/common'
-import { UserDefinedValue } from '_spec_utils/UserDefinedValue'
+import { GenericResponseBody } from '_spec_utils/behaviors'
+import { ResponseBase } from '@_types/Base'
 
-// TODO: this is weird as we likely require a special behaviour
-// the generic is not respected
-// --> export class SourceResponse<TDocument> implements GenericBodyResponse<TDocument> {}
-export class SourceResponse<TDocument> extends DictionaryResponseBase<
-  Field,
-  UserDefinedValue
-> {}
+export class SourceResponse<TDocument>
+  extends ResponseBase
+  implements GenericResponseBody<TDocument> {}

specification/_spec_utils/behaviors.ts

@@ -81,3 +81,10 @@ export interface CommonCatQueryParameters {
   s?: string[]
   v?: boolean
 }
+
+/**
+ * Some APIs does not return a structured body, but a generic value instead.
+ * For examplke the `get_source` API return the source document.
+ * @behavior Defines a trait that the response body is the given generic.
+ */
+export interface GenericResponseBody<T> {}

typescript-generator/index.ts

@@ -32,7 +32,8 @@ const model: M.Model = JSON.parse(readFileSync(join(__dirname, '..', 'output', '
 const skipBehaviors = [
   'ArrayResponseBase',
   'EmptyResponseBase',
-  'AdditionalProperties'
+  'AdditionalProperties',
+  'GenericResponseBody'
 ]
 
 let definitions = `/*
@@ -174,6 +175,13 @@ function buildBehaviorInterface (type: M.Interface): string {
       return serializeAdditionalPropertiesType(type)
     }
 
+    if (type.attachedBehaviors.includes('GenericResponseBody')) {
+      const generics = type.generics
+      assert(generics)
+      const name = generics[0].name
+      return `export type ${createName(type.name)}${buildGenerics(generics)} = ${name}\n`
+    }
+
     if (type.attachedBehaviors.includes('ArrayResponseBase')) {
       const behavior = lookupBehavior(type, 'ArrayResponseBase')
       assert(behavior)