OpenAPITools / OpenAPITools/openapi-generator

[REQ] Add ability to skip some of the web services in an openapi contract

Open
#18,897 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Is your feature request related to a problem? Please describe.

Sometimes the openapi is huge and you only want a small number of web services to be included in the generator output.

Describe the solution you'd like

Configuration options:

  • includeResources - Inclusive paths of resources to include. Anything outside of these would be skipped.

Example:

<includedResources>
  <includedResource>/hello-world</includedResource>
  <includedResource>/hello-world2</includedResource>
</includedResources>
  • excludeResources - Paths of resources to exclude. Anything matching these would be skipped. Example:
<excludedResources>
  <excludedResources>/hello-world</excludedResource>
  <excludedResources>/hello-world2</excludedResource>
</excludedResources>

Describe alternatives you've considered

None of the other work arounds are as simple. Editing the openapi yaml is not attractive option. etc. The other exclusion options are not very declarative and seem to be bugged.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No file or test is named in the request. Start by locating the generator configuration handling and the existing exclusion options, then trace how resource paths are selected; done means includeResources and excludeResources can declaratively filter generated output and are covered by tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi
Domain
api, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.