OpenAPITools / OpenAPITools/openapi-generator

[REQ] Feature Request Description

Open
#15,460 0 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.

Support authed $ref urls so that businesses can have schema registries and refer to them from contracts. Repositories are often behind authentication.

Describe the solution you'd like

I'd like the generator to accept configuration so that, when I run it via Github action or other CI tool, I can pass a token to be used as a header when resolving certain $refs.

Describe alternatives you've considered

  • Removing authentication from our repositories, which is a non-starter in my current environment.
  • Using basic auth and rewriting the $ref urls by preprocessing, which doesn't work due to basic auth deprecation

Additional context

I've added a related issue for the specification itself: https://github.com/OAI/OpenAPI-Specification/issues/3270.

I think they are separate because I'm guessing it's easier to add support to the tool without changing the spec.

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 files, tests, or entry points are named in the issue. Define how generator configuration should provide a token header for selected authenticated $ref URLs, and verify that those references resolve correctly in CI.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.