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 | Object

Default value: false.

To enforce the quality of your OpenAPI specification, Orval supports validating specifications with the OpenAPI linter from IBM.

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

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

override

Type: Object.

Allows overriding the specification

transformer

Type: String | Function.

Valid values: path or implementation of a transformer function.

This function is executed when Orval generates clients. The function should accept an argument of the type OpenAPIObject, and should return a transformed OpenAPIObject.

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

An example of a transformer function can be found 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.

This settings determines whether the provided tags or schemas are excluded or included from the specification. 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: (String | RegExp)[].

Default Value: [].

This option allows filtering 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: (String | RegExp)[].

Only schema names that 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 converts Swagger 2.0 definitions into OpenAPI 3.0.x using swagger2openapi. Use the converterOptions property to provide custom config for that. See the available options here.

Example:

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

parserOptions

Type: Object.

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

Orval utilizes a parser to process multiple file specifications. This behavior can be customized 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.

The specification is automatically validated by default.

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