OpenAPITools / OpenAPITools/openapi-generator

[REQ][openapi-generator-gradle-plugin] Load inputSpec from classpath

Open
#19,935 1 comment 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.

In maven project if I define dependency to a library within plugin I can use a relative path to a inputSpec from the classpath. This is not possible in the current gradle plugin.

Currently there needs to be some workaround with an unpack of a library which is not very convenient.

Describe the solution you'd like

It would be nice if it's possible to reference inputSpec from a classpath
for example:

  • I have library file within library openapi-commons => openapi-commons/src/main/resources/commons/openapi.yaml
  • I include that library in different poject (e.g. dependencies { api(project(":openapi-commons"))})
  • In openApiGenerate (and possibly others) I can the reference inputSpec like inputSpec.set("commons/openapi.yaml")

Describe alternatives you've considered

Additional context

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

Start at the Gradle plugin's openApiGenerate entry point and trace how the inputSpec value is currently resolved. Verify how a dependency such as openapi-commons is exposed to the plugin, then confirm that inputSpec.set("commons/openapi.yaml") can load the resource without unpacking the library.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.