Input

target

Type: String.

Valid values: path or link to the specification.

1 module.exports = {
2   petstore: {
3     input: {
4       target: './petstore.yaml',
5     },
6   },
7 };

validation

Type: Boolean.

Default Value: false.

To enforce the best quality as possible of specification, we have integrated the amazing OpenAPI linter from IBM. We strongly encourage you to setup your custom rules with a .validaterc file, you can find all useful information about this configuration here.

1 module.exports = {
2   petstore: {
3     input: {
4       validation: true,
5     },
6   },
7 };

override

Type: Object.

Give you the possibility to override the specification

transformer

Type: String or Function.

Valid values: path or implementation of the transformer function.

This function is executed when you generate and take in argument an OpenAPIObject and should return an OpenAPIObject.

1 module.exports = {
2   input: {
3     override: {
4       transformer: 'src/api/transformer/add-version.js',
5     },
6   },
7 };

Example of transformer here

filters

Type: Object.

If specified, Orval only generates the endpoints after applying the filter. It is possible to filter on tags.

For instance the example below only generates the endpoints that contain the tag pets.

1 module.exports = {
2   petstore: {
3     input: {
4       filters: {
5         tags: ['pets'],
6       },
7     },
8   },
9 };

converterOptions

Type: Object.

Default Value: {}.

Orval convert Swagger 2.0 definitions into OpenAPI 3.0.x. You can use the converterOptions property to provide custom config for that. Check here available options.

1 module.exports = {
2   petstore: {
3     input: {
4       converterOptions: true,
5     },
6   },
7 };

parserOptions

Type: Object.

Default Value: { resolve: { github: githubResolver }, validate: true }.

Orval use a parser to handle multiple files specification. You can use the parserOptions property to provide custom config for that parser. Check here available options. Be default Orval add a github parser but you can add own if you have a private specification or other requirement.

Your specification is automatically validated by default.

1 module.exports = {
2   petstore: {
3     input: {
4       parserOptions: {
5         resolve: { gitlab: gitlabResolver },
6       },
7     },
8   },
9 };