Why is my openapi-ts.config.ts file wrong?

[paulchen5]

This currently my content of the openapi-ts.config.ts file.

openapi-ts.config.ts:

import { defineConfig } from '@hey-api/openapi-ts';

export default defineConfig({
  input: './docs/event_management.swagger.json',
  output: './src/shared/api',

  client: 'fetch',

  types: {
    enums: 'typescript',
  },

  services: {
    asClass: false,
  },
});

Therefore I am receiving the following error via VS Code Intellisense:

No overload matches this call.
  Overload 1 of 2, '(config: LazyOrAsync<readonly UserConfig[]>): Promise<readonly UserConfig[]>', gave the following error.
    Object literal may only specify known properties, and 'input' does not exist in type 'LazyOrAsync<readonly UserConfig[]>'.
  Overload 2 of 2, '(config: LazyOrAsync<UserConfig>): Promise<UserConfig>', gave the following error.
    Object literal may only specify known properties, and 'client' does not exist in type 'LazyOrAsync<UserConfig>'.

I am using @hey-api/openapi-ts@0.95.0.

[dosubot[bot]]

Your config is using the old format. Starting with v0.63.0, @hey-api/openapi-ts moved to a plugin-based architecture, so client, types, and services are no longer top-level options [1].

Here's your config migrated to the v0.95.0 format:

import { defineConfig } from '@hey-api/openapi-ts';

export default defineConfig({
  input: './docs/event_management.swagger.json',
  output: './src/shared/api',
  plugins: [
    '@hey-api/client-fetch',
    {
      name: '@hey-api/typescript',
      enums: 'typescript',
    },
    {
      name: '@hey-api/sdk',
    },
  ],
});

Key changes:

• client: 'fetch' → add '@hey-api/client-fetch' to plugins (make sure to install the @hey-api/client-fetch package)
• types: { enums: 'typescript' } → { name: '@hey-api/typescript', enums: 'typescript' } plugin
• services: { asClass: false } → { name: '@hey-api/sdk' } plugin (flat/tree-shakeable functions are the default, so no extra config needed)

Also note that client imports changed from client/sdk.gen to client/client.gen [1], so update any existing import paths in your code as well.

To reply, just mention @dosu.

---

Docs are dead. Just use Dosu.

[paulchen5]

Thanks

[mrlubos]

@dosu why do you say it's necessary to install @hey-api/client-fetch? It's not, that package is deprecated and plugin with the same name exists.

[dosubot[bot]]

You're right, my mistake! Since v0.73.0, @hey-api/client-fetch is a built-in plugin bundled with @hey-api/openapi-ts — there's no separate package to install [1]. You just reference it by name in the plugins array and it works out of the box. Thanks for the correction!

To reply, just mention @dosu.

---

Share context across your team and agents. Try Dosu.