Skip to content

Commit

Permalink
PRC
Browse files Browse the repository at this point in the history
  • Loading branch information
tjosepo committed Jul 18, 2024
1 parent 07b7d91 commit 2d6db32
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 11 deletions.
3 changes: 0 additions & 3 deletions .github/workflows/publish-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,6 @@ jobs:
steps:
- uses: actions/checkout@v4

- name: Setup project
uses: ./.github/actions/setup

- name: Build with Retype
uses: retypeapp/action-build@latest
id: retype
Expand Down
24 changes: 16 additions & 8 deletions docs/src/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,34 +22,42 @@ You can use the `defineConfig` helper which should provide intellisense:
import { defineConfig } from '@workleap/create-schemas'

export default defineConfig({
// ...
// example
})
```

### root
## root
- **Type:** `string`
- **Default:** `process.cwd()`

Project root directory used to resolve relative paths. Can be an absolute path, or a path relative to the current working directory.

### input
## input
- **Type:** `string`

Path to the OpenAPI schema file. Can be a local path or URL to a remote file.

### outdir
## outdir
- **Type:** `string`
- **Default:** `"./dist"`

Output directory path.
Output directory path. The files that will be generated in this directory
depends on the plugins being used.

### watch
## watch
- **Type:** `boolean`
- **Default:** `false`

Enable watch mode.
Enable watch mode. Watch mode will regenerate the code whenever the input file
or the configuration file changes.

### openApiTsOptions
## plugins
- **Type:** `Plugin[]`
- **Default:** `[]`

Array of plugins to use. See [Using Plugins](./using-plugins) for more details.

## openApiTsOptions

- **Type:** `OpenApiTsOptions`
- **Default:** `{}`
Expand Down

0 comments on commit 2d6db32

Please sign in to comment.