Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
37 changes: 37 additions & 0 deletions docs/src/pages/reference/configuration/input.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,43 @@ export default defineConfig({
});
```

### paths

Type: `(String | RegExp)[] | Array<[String | RegExp, String[]]>`.

Only endpoints that match the specified `String` or `RegExp` will be automatically generated.
For instance, the example below only generates the endpoints that match the path `/pets` or regular expression `/health/`.

```js
module.exports = {
petstore: {
input: {
filters: {
paths: ['/pets', /health/],
},
},
},
};
```

You can also filter by specific HTTP methods for each path using the tuple format `[path, [methods]]`:

```js
module.exports = {
petstore: {
input: {
filters: {
paths: [
['/pets', ['get', 'post']],
['/pets/{petId}', ['get', 'put']],
[/health/, ['get']],
],
},
},
},
};
```

## converterOptions

Type: `Object`.
Expand Down
Loading