fix: handle application/json content type in parameter definitions

hey-api · May 23, 2024 · 93adfc3 · 93adfc3
1 parent 0ac9401
commit 93adfc3
Show file tree

Hide file tree

Showing 21 changed files with 193 additions and 66 deletions.
diff --git a/.changeset/olive-spies-press.md b/.changeset/olive-spies-press.md
@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix: handle application/json content type in parameter definitions
diff --git a/packages/openapi-ts/src/openApi/v3/interfaces/OpenApiParameter.ts b/packages/openapi-ts/src/openApi/v3/interfaces/OpenApiParameter.ts
@@ -3,21 +3,41 @@ import type { OpenApiExample } from './OpenApiExample';
 import type { OpenApiReference } from './OpenApiReference';
 import type { OpenApiSchema } from './OpenApiSchema';
 
+/**
+ * add only one type for now as that's needed to resolve the reported issue,
+ * more types should be added though
+ * {@link https://github.com/hey-api/openapi-ts/issues/612}
+ */
+type MediaType = 'application/json';
+
+/**
+ * encoding interface should be added, not adding it for now as it's not needed
+ * to resolve the issue reported
+ * {@link https://github.com/hey-api/openapi-ts/issues/612}
+ */
+interface MediaTypeObject {
+  example?: unknown;
+  examples?: Dictionary<OpenApiExample>;
+  schema: OpenApiSchema;
+  // encoding?
+}
+
 /**
  * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#parameter-object
  */
 export interface OpenApiParameter extends OpenApiReference {
-  name: string;
-  in: 'path' | 'query' | 'header' | 'formData' | 'cookie';
-  description?: string;
-  required?: boolean;
-  nullable?: boolean;
-  deprecated?: boolean;
   allowEmptyValue?: boolean;
-  style?: string;
-  explode?: boolean;
   allowReserved?: boolean;
-  schema?: OpenApiSchema;
+  content?: Record<MediaType, MediaTypeObject>;
+  deprecated?: boolean;
+  description?: string;
   example?: unknown;
   examples?: Dictionary<OpenApiExample>;
+  explode?: boolean;
+  in: 'cookie' | 'formData' | 'header' | 'path' | 'query';
+  name: string;
+  nullable?: boolean;
+  required?: boolean;
+  schema?: OpenApiSchema;
+  style?: string;
 }
diff --git a/packages/openapi-ts/src/openApi/v3/parser/getModels.ts b/packages/openapi-ts/src/openApi/v3/parser/getModels.ts
@@ -1,12 +1,16 @@
 import type { Client } from '../../../types/client';
+import { getConfig } from '../../../utils/config';
 import { reservedWords } from '../../common/parser/reservedWords';
 import { getType } from '../../common/parser/type';
 import type { OpenApi } from '../interfaces/OpenApi';
 import { getModel } from './getModel';
+import { getParameterSchema } from './parameter';
 
 export const getModels = (
   openApi: OpenApi,
 ): Pick<Client, 'models' | 'types'> => {
+  const config = getConfig();
+
   const types: Client['types'] = {};
   let models: Client['models'] = [];
 
@@ -39,8 +43,11 @@ export const getModels = (
 
   Object.entries(openApi.components.parameters ?? {}).forEach(
     ([definitionName, definition]) => {
-      const schema = definition.schema;
+      const schema = getParameterSchema(definition);
       if (!schema) {
+        if (config.debug) {
+          console.warn('Skipping generating parameter:', definitionName);
+        }
         return;
       }
 

diff --git a/packages/openapi-ts/src/openApi/v3/parser/getOperationParameter.ts b/packages/openapi-ts/src/openApi/v3/parser/getOperationParameter.ts
@@ -11,12 +11,16 @@ import type { OpenApiParameter } from '../interfaces/OpenApiParameter';
 import type { OpenApiSchema } from '../interfaces/OpenApiSchema';
 import { getModel } from './getModel';
 import { isDefinitionNullable } from './inferType';
+import { getParameterSchema } from './parameter';
 
 export const getOperationParameter = ({
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  debug,
   openApi,
   parameter,
   types,
 }: {
+  debug?: boolean;
   openApi: OpenApi;
   parameter: OpenApiParameter;
   types: Client['types'];
@@ -61,11 +65,12 @@ export const getOperationParameter = ({
     return operationParameter;
   }
 
-  let schema = parameter.schema;
+  let schema = getParameterSchema(parameter);
   if (schema) {
     if (schema.$ref?.startsWith('#/components/parameters/')) {
       schema = getRef<OpenApiSchema>(openApi, schema);
     }
+
     if (schema.$ref) {
       const model = getType({ type: schema.$ref });
       operationParameter.export = 'reference';
@@ -79,47 +84,47 @@ export const getOperationParameter = ({
       ];
       operationParameter.default = getDefault(schema);
       return operationParameter;
-    } else {
-      const model = getModel({ definition: schema, openApi, types });
-      operationParameter = {
-        ...operationParameter,
-        $refs: [...operationParameter.$refs, ...model.$refs],
-        base: model.base,
-        enum: [...operationParameter.enum, ...model.enum],
-        enums: [...operationParameter.enums, ...model.enums],
-        exclusiveMaximum: model.exclusiveMaximum,
-        exclusiveMinimum: model.exclusiveMinimum,
-        export: model.export,
-        format: model.format,
-        imports: [...operationParameter.imports, ...model.imports],
-        isNullable: operationParameter.isNullable || model.isNullable,
-        isReadOnly: model.isReadOnly,
-        isRequired: operationParameter.isRequired || model.isRequired,
-        link: model.link,
-        maxItems: model.maxItems,
-        maxLength: model.maxLength,
-        maxProperties: model.maxProperties,
-        maximum: model.maximum,
-        minItems: model.minItems,
-        minLength: model.minLength,
-        minProperties: model.minProperties,
-        minimum: model.minimum,
-        multipleOf: model.multipleOf,
-        pattern: getPattern(model.pattern),
-        properties: [...operationParameter.properties, ...model.properties],
-        template: model.template,
-        type: model.type,
-        uniqueItems: model.uniqueItems,
-      };
-      if (
-        (operationParameter.enum.length || operationParameter.enums.length) &&
-        !operationParameter.meta
-      ) {
-        operationParameter.meta = enumMeta(operationParameter);
-      }
-      operationParameter.default = model.default;
-      return operationParameter;
     }
+
+    const model = getModel({ definition: schema, openApi, types });
+    operationParameter = {
+      ...operationParameter,
+      $refs: [...operationParameter.$refs, ...model.$refs],
+      base: model.base,
+      enum: [...operationParameter.enum, ...model.enum],
+      enums: [...operationParameter.enums, ...model.enums],
+      exclusiveMaximum: model.exclusiveMaximum,
+      exclusiveMinimum: model.exclusiveMinimum,
+      export: model.export,
+      format: model.format,
+      imports: [...operationParameter.imports, ...model.imports],
+      isNullable: operationParameter.isNullable || model.isNullable,
+      isReadOnly: model.isReadOnly,
+      isRequired: operationParameter.isRequired || model.isRequired,
+      link: model.link,
+      maxItems: model.maxItems,
+      maxLength: model.maxLength,
+      maxProperties: model.maxProperties,
+      maximum: model.maximum,
+      minItems: model.minItems,
+      minLength: model.minLength,
+      minProperties: model.minProperties,
+      minimum: model.minimum,
+      multipleOf: model.multipleOf,
+      pattern: getPattern(model.pattern),
+      properties: [...operationParameter.properties, ...model.properties],
+      template: model.template,
+      type: model.type,
+      uniqueItems: model.uniqueItems,
+    };
+    if (
+      (operationParameter.enum.length || operationParameter.enums.length) &&
+      !operationParameter.meta
+    ) {
+      operationParameter.meta = enumMeta(operationParameter);
+    }
+    operationParameter.default = model.default;
+    return operationParameter;
   }
 
   return operationParameter;

diff --git a/packages/openapi-ts/src/openApi/v3/parser/getOperationParameters.ts b/packages/openapi-ts/src/openApi/v3/parser/getOperationParameters.ts
@@ -8,10 +8,12 @@ import { getOperationParameter } from './getOperationParameter';
 const allowedIn = ['cookie', 'formData', 'header', 'path', 'query'] as const;
 
 export const getOperationParameters = ({
+  debug,
   openApi,
   parameters,
   types,
 }: {
+  debug?: boolean;
   openApi: OpenApi;
   parameters: OpenApiParameter[];
   types: Client['types'];
@@ -34,20 +36,22 @@ export const getOperationParameters = ({
       parameterOrReference,
     );
     const parameter = getOperationParameter({
+      debug,
       openApi,
       parameter: parameterDef,
       types,
     });
 
-    const defIn = parameterDef.in as (typeof allowedIn)[number];
-
     // ignore the "api-version" param since we do not want to add it
     // as the first/default parameter for each of the service calls
-    if (parameter.prop === 'api-version' || !allowedIn.includes(defIn)) {
+    if (
+      parameter.prop === 'api-version' ||
+      !allowedIn.includes(parameterDef.in)
+    ) {
       return;
     }
 
-    switch (defIn) {
+    switch (parameterDef.in) {
       case 'cookie':
         operationParameters.parametersCookie = [
           ...operationParameters.parametersCookie,

diff --git a/packages/openapi-ts/src/openApi/v3/parser/getServices.ts b/packages/openapi-ts/src/openApi/v3/parser/getServices.ts
@@ -38,7 +38,7 @@ export const getServices = ({
 
   for (const url in openApi.paths) {
     const path = openApi.paths[url];
-    const pathParams = getOperationParameters({
+    const pathParameters = getOperationParameters({
       openApi,
       parameters: path.parameters ?? [],
       types,
@@ -57,7 +57,7 @@ export const getServices = ({
             method,
             op,
             openApi,
-            pathParams,
+            pathParams: pathParameters,
             tag,
             types,
             url,

diff --git a/packages/openapi-ts/src/openApi/v3/parser/parameter.ts b/packages/openapi-ts/src/openApi/v3/parser/parameter.ts
@@ -0,0 +1,23 @@
+import type { OpenApiParameter } from '../interfaces/OpenApiParameter';
+import type { OpenApiSchema } from '../interfaces/OpenApiSchema';
+
+export const getParameterSchema = (
+  definition: OpenApiParameter,
+): OpenApiSchema | undefined => {
+  if (definition.schema) {
+    return definition.schema;
+  }
+
+  if (definition.content) {
+    // treat every media type the same for now, types should be modified to
+    // preserve this data so client knows which headers to use and how to
+    // parse response bodies
+    const contents = Object.entries(definition.content);
+    for (const [key, mediaTypeObject] of contents) {
+      if (mediaTypeObject.schema) {
+        const mediaType = key as keyof Required<OpenApiParameter>['content'];
+        return definition.content[mediaType].schema;
+      }
+    }
+  }
+};
diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3/services.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3/services.gen.ts.snap
@@ -122,6 +122,7 @@ export class ParametersService {
      * @param data The data for the request.
      * @param data.foo foo in method
      * @param data.bar bar in method
+     * @param data.xFooBar Parameter with illegal characters
      * @throws ApiError
      */
     public static deleteFoo(data: DeleteFooData3): CancelablePromise<void> {
@@ -131,6 +132,9 @@ export class ParametersService {
             path: {
                 foo: data.foo,
                 bar: data.bar
+            },
+            headers: {
+                'x-Foo-Bar': data.xFooBar
             }
         });
     }

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3/types.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3/types.gen.ts.snap
@@ -985,7 +985,7 @@ export type ParameterSimpleParameter = string;
 /**
  * Parameter with illegal characters
  */
-export type Parameterx_Foo_Bar = string;
+export type Parameterx_Foo_Bar = ModelWithString;
 
 export type PostServiceWithEmptyTagData = {
     requestBody: ModelWithReadOnlyAndWriteOnly | ModelWithArrayReadOnlyAndWriteOnly;
@@ -1004,6 +1004,10 @@ export type DeleteFooData3 = {
      * foo in method
      */
     foo: string;
+    /**
+     * Parameter with illegal characters
+     */
+    xFooBar: ModelWithString;
 };
 
 export type CallWithParametersData = {

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/services.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/services.gen.ts.snap
@@ -139,6 +139,7 @@ export class ParametersService {
      * @param data The data for the request.
      * @param data.foo foo in method
      * @param data.bar bar in method
+     * @param data.xFooBar Parameter with illegal characters
      * @throws ApiError
      */
     public deleteFoo(data: DeleteFooData3): Observable<void> {
@@ -148,6 +149,9 @@ export class ParametersService {
             path: {
                 foo: data.foo,
                 bar: data.bar
+            },
+            headers: {
+                'x-Foo-Bar': data.xFooBar
             }
         });
     }

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/types.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/types.gen.ts.snap
@@ -862,7 +862,7 @@ export type ParameterSimpleParameter = string;
 /**
  * Parameter with illegal characters
  */
-export type Parameterx_Foo_Bar = string;
+export type Parameterx_Foo_Bar = ModelWithString;
 
 export type PostServiceWithEmptyTagData = {
     requestBody: ModelWithReadOnlyAndWriteOnly | ModelWithArrayReadOnlyAndWriteOnly;
@@ -881,6 +881,10 @@ export type DeleteFooData3 = {
      * foo in method
      */
     foo: string;
+    /**
+     * Parameter with illegal characters
+     */
+    xFooBar: ModelWithString;
 };
 
 export type CallWithParametersData = {

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_client/services.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_client/services.gen.ts.snap
@@ -127,6 +127,7 @@ export class ParametersService {
      * @param data The data for the request.
      * @param data.foo foo in method
      * @param data.bar bar in method
+     * @param data.xFooBar Parameter with illegal characters
      * @throws ApiError
      */
     public deleteFoo(data: DeleteFooData3): CancelablePromise<void> {
@@ -136,6 +137,9 @@ export class ParametersService {
             path: {
                 foo: data.foo,
                 bar: data.bar
+            },
+            headers: {
+                'x-Foo-Bar': data.xFooBar
             }
         });
     }