Skip to content

Commit

Permalink
Merge pull request #1482 from bohdanhusak/docs/basic-usage-plugin-oas…
Browse files Browse the repository at this point in the history
…-no-output

docs: update plugin-oas no output config in basic tutorial
  • Loading branch information
stijnvanhulle authored Dec 19, 2024
2 parents cc77ad8 + e57d618 commit 2ea0e2d
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/tutorials/basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Set up your `kubb.config.ts` file based on the [Quick start](/guide/quick-start)

We will add the plugins [`@kubb/plugin-oas`](/plugins/plugin-oas/) and [`@kubb/plugin-ts`](/plugins/plugin-ts/)(which is dependent on the [`@kubb/plugin-oas`](/plugins/plugin-oas/) plugin). Together these two plugins will generate the TypeScript types.

Next to that, we will also set `output` to false for the [`@kubb/swagger`](/plugins/swagger) plugin because we do not need the plugin to generate the JSON schemas for us.
Next to that, we will also set `generators` to empty array for the [`@kubb/plugin-oas`](/plugins/plugin-oas) plugin because we do not need the plugin to generate the JSON schemas for us.

- For the [`@kubb/plugin-ts`](/plugins/plugin-ts/) plugin, we will set the `output` to the `models` folder.

Expand All @@ -48,7 +48,7 @@ export default defineConfig(() => {
plugins: [
pluginOas(
{
output: false,
generators: [],
validate: true,
},
),
Expand Down Expand Up @@ -91,7 +91,7 @@ Your `package.json` will look like this:
{
"name": "your project",
"scripts": {
"generate": "kubb generate --config kubb.config.js"
"generate": "kubb generate --config kubb.config.ts"
},
"dependencies": {
"@kubb/cli": "latest",
Expand Down

0 comments on commit 2ea0e2d

Please sign in to comment.