OpenAPITools / OpenAPITools/openapi-generator

[REQ][openapi-yaml] support merging multiple openapi YAML files into one using generator

Open
#9,979 0 comments 5 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.

No.

Describe the solution you'd like

I have multiple openapi YAML files. However the ReDoc tool I am using generates separate document per file. They don't link to each other.

In order to have a standalone doc generated, I was thinking merging all yaml files into one manually. However it increases cost of maintenance. Thus I am counting this openapi-yaml docgen to merge the YAML files automatically.

Describe alternatives you've considered

There are other tools I could use, but it means I have to introduce them into our CICD pipeline. As we are already using openapi-generator, I'm thinking why not have the generate to do the merge job as well, which is more elegant.

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 by locating the openapi-yaml documentation generator and its handling of input YAML files. Determine how multiple specifications could be supplied and what merging rules are required, then define completion as producing one standalone document from the inputs without requiring manual maintenance.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi, yaml
Domain
api, documentation, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.