Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update plugin-oas no output config in basic tutorial #1482

Merged
merged 1 commit into from
Dec 19, 2024
Merged

docs: update plugin-oas no output config in basic tutorial #1482

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/tutorials/basic.md
View file
Open in desktop
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
Loading