feat(packages): add option to filter generated endpoints (#810)

In the case orval is run on a system with a lot of endpoints,
it can be useful to limit which endpoints are actually generated.

Author: yesyesufcurs

docs/src/pages/reference/configuration/input.md

@@ -63,6 +63,27 @@ module.exports = {
 
 Example of transformer <a href="https://github.com/anymaniax/orval/blob/master/samples/basic/api/transformer/add-version.js" target="_blank">here</a>
 
+### 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`.
+
+```js
+module.exports = {
+  petstore: {
+    input: {
+      filters: {
+        tags: ['pets'],
+      },
+    },
+  },
+};
+```
+
 ### converterOptions
 
 Type: `Object`.

packages/core/src/generators/verbs-options.ts

@@ -18,6 +18,7 @@ import {
   ContextSpecs,
   GeneratorVerbOptions,
   GeneratorVerbsOptions,
+  NormalizedInputOptions,
   NormalizedOperationOptions,
   NormalizedOutputOptions,
   NormalizedOverrideOutput,
@@ -188,17 +189,19 @@ const generateVerbOptions = async ({
 
 export const generateVerbsOptions = ({
   verbs,
+  input,
   output,
   route,
   context,
 }: {
   verbs: PathItemObject;
+  input: NormalizedInputOptions;
   output: NormalizedOutputOptions;
   route: string;
   context: ContextSpecs;
 }): Promise<GeneratorVerbsOptions> =>
   asyncReduce(
-    Object.entries(verbs),
+    filteredVerbs(verbs, input.filters),
     async (acc, [verb, operation]: [string, OperationObject]) => {
       if (isVerb(verb)) {
         const verbOptions = await generateVerbOptions({
@@ -217,3 +220,18 @@ export const generateVerbsOptions = ({
     },
     [] as GeneratorVerbsOptions,
   );
+
+const filteredVerbs = (
+  verbs: PathItemObject,
+  filters: NormalizedInputOptions['filters'],
+) => {
+  if (filters === undefined || filters.tags === undefined) {
+    return Object.entries(verbs);
+  }
+
+  return Object.entries(verbs).filter(
+    ([_verb, operation]: [string, OperationObject]) => {
+      return operation.tags?.some((tag) => filters.tags?.includes(tag));
+    },
+  );
+};

packages/core/src/types.ts

@@ -137,6 +137,9 @@ export type NormalizedInputOptions = {
   override: OverrideInput;
   converterOptions: swagger2openapi.Options;
   parserOptions: SwaggerParserOptions;
+  filters?: {
+    tags?: string[];
+  };
 };
 
 export type OutputClientFunc = (
@@ -169,6 +172,9 @@ export type InputOptions = {
   override?: OverrideInput;
   converterOptions?: swagger2openapi.Options;
   parserOptions?: SwaggerParserOptions;
+  filters?: {
+    tags?: string[];
+  };
 };
 
 export type OutputClient =

packages/orval/src/api.ts

@@ -7,6 +7,7 @@ import {
   GeneratorSchema,
   getRoute,
   isReference,
+  NormalizedInputOptions,
   NormalizedOutputOptions,
   resolveRef,
 } from '@orval/core';
@@ -21,9 +22,11 @@ import {
 } from './client';
 
 export const getApiBuilder = async ({
+  input,
   output,
   context,
 }: {
+  input: NormalizedInputOptions;
   output: NormalizedOutputOptions;
   context: ContextSpecs;
 }): Promise<GeneratorApiBuilder> => {
@@ -52,6 +55,7 @@ export const getApiBuilder = async ({
 
       let verbsOptions = await generateVerbsOptions({
         verbs: resolvedVerbs,
+        input,
         output,
         route,
         context: resolvedContext,

packages/orval/src/import-open-api.ts

@@ -33,6 +33,7 @@ export const importOpenApi = async ({
   const schemas = getApiSchemas({ output, target, workspace, specs });
 
   const api = await getApiBuilder({
+    input,
     output,
     context: {
       specKey: target,

packages/orval/src/utils/options.ts

@@ -103,6 +103,7 @@ export const normalizeOptions = async (
         parserDefaultOptions,
         inputOptions.parserOptions ?? {},
       ),
+      filters: inputOptions.filters,
     },
     output: {
       target: globalOptions.output