Skip to content

Commit 55ebf28

Browse files
committed
feat: enhance OpenAPI configuration options in documentation
1 parent 1d67444 commit 55ebf28

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -304,11 +304,16 @@ static/openapi.json
304304

305305
| Option | Type | Default | Description |
306306
| ----------------- | ---------- | ----------- | ----------------------------------------------------- |
307+
| `info` | `object` | `undefined` | OpenAPI info section (title, version, description) |
308+
| `servers` | `array` | `undefined` | OpenAPI servers configuration |
307309
| `baseSchemasPath` | `string` | `undefined` | Path to file with shared `@swagger` component schemas |
308310
| `yamlFiles` | `string[]` | `[]` | Additional YAML files to merge into the spec |
309311
| `prependPath` | `string` | `''` | Prefix to prepend to all paths (e.g., `/api`) |
312+
| `include` | `string[]` | `['src/routes/**/{+server,+page.server}.{js,ts}']` | Glob patterns to include |
313+
| `exclude` | `string[]` | `['**/node_modules/**', '**/.svelte-kit/**']` | Glob patterns to exclude |
314+
| `failOnErrors` | `boolean` | `false` | Whether to fail on JSDoc parsing errors |
310315
| `outputPath` | `string` | `undefined` | File path to write spec during build |
311-
| `debounceMs` | `number` | `100` | Debounce delay for HMR regeneration |
316+
| `debounceMs` | `number` | `200` | Debounce delay for HMR regeneration |
312317

313318
### SvelteKit Route Mapping
314319

src/routes/+page.svelte

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,13 +80,13 @@
8080
option: 'include',
8181
type: 'string[]',
8282
description: 'Glob patterns to include',
83-
default: "['src/routes/**/+server.ts', 'src/routes/**/+page.server.ts']"
83+
default: "['src/routes/**/{+server,+page.server}.{js,ts}']"
8484
},
8585
{
8686
option: 'exclude',
8787
type: 'string[]',
8888
description: 'Glob patterns to exclude',
89-
default: '-'
89+
default: "['**/node_modules/**', '**/.svelte-kit/**']"
9090
},
9191
{
9292
option: 'failOnErrors',

0 commit comments

Comments
 (0)