feat(packages): add option to filter generated endpoints

[yesyesufcurs]

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.

Status

READY

Description

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.

See: #739

Todos

• Tests
• Documentation
• Changelog Entry (unreleased)

Steps to Test or Reproduce

Outline the steps to test or reproduce the PR here.

1. Add a tag that should be filtered out to a orval.config for instance as follows:

output: {
      filterTags: ["pets"]
},

2. Only end points that contain tag "pets" will be generated.

[vercel]

Someone is attempting to deploy a commit to a Personal Account owned by @anymaniax on Vercel.

@anymaniax first needs to authorize it.

[anymaniax]

What do you think about having this.

filters?: {
  tags?: string[]
}

Like that we can add other filters like on the operation id.

What do you think about adding it in the input section and not the output one?

[yesyesufcurs]

I agree with changing it to have a filters object, that would make more sense. I will be updating this asap.

About the input section I'm not sure. I think it is more of a question how we see it:

1. We only "read in" the relevant filtered elements.
2. We only "output" the relevant filtered elements.

The first one would imply adding it in the input section, the second one the output section.
The main reason I chose to add it to the output section is since the function that I changed in the api.ts file only receives NormalizedOutputOptions as parameter. I could of course add the NormalizedInputOptions as parameter to get the desired change, or do you think there would be a smarter way to go about this?

[anymaniax]

I would do the filter here and so we don't even read the operation. And in that case, you can also pass the NormalizedInputOptions as a parameter.

[yesyesufcurs]

I have fixed it as you proposed :)

[anymaniax]

Really nice works! Thanks for the pull request