Input

target

Type: String.

Valid values: path or link to the specification.

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

validation

Type: Boolean or Object

Default Value: false.

To enforce the best quality as possible of specification, we have integrated the amazing OpenAPI linter from IBM.

Specifying true will by default use the IBM Cloud Validation Ruleset. Specifying an Object will use the provided ruleset instead. You can learn more about creating rulesets here.

1module.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.

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

Example of transformer here

filters

Type: Object.

Default Value: {}.

If specified, Orval only generates the endpoints after applying the filter.

mode

Type: String.

Valid values: include, exclude.

Default Value: include.

Combined with tags or schemas, this setting determines whether to include or exclude the specified items. For instance, the example below generates endpoints that do not contain the tag pets.

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

tags

Type: Array of string or RegExp.

Default Value: [].

It is possible to filter on tags. For instance the example below only generates the endpoints that contain the tag pets or matches the regular expression /health/.

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

schemas

Type: Array of string or RegExp.

Only schemas names match the specified string or RegExp will be automatically generated. For instance the example below only generates the schema object that matches string Error or regular expression /Cat/.

1module.exports = {
2  petstore: {
3    input: {
4      filters: {
5        schemas: ['Error', /Cat/],
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.

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

parserOptions

Type: Object.

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

Orval utilizes a parser to process multiple file specifications. You can customize its behavior using the parserOptions property. See the available options for configuration. By default, Orval includes a GitHub parser, but you can add your own for private specifications or other specific needs.

Your specification is automatically validated by default.

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