OpenAPITools / OpenAPITools/openapi-generator

[REQ] Generator: Documentation -> LLM / RAG compatible output

Open
#20,382 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

Would be great to have a generator (probably under the Documentation section) that outputs a format friendly to LLMs to help with RAG related tasks. The current markdown one is pretty close, but has a lot of noise

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 examining the current markdown generator referenced in the issue and how it is organized under the Documentation section. Define the reduced, LLM/RAG-friendly output requirements and consider the issue complete when a generator produces that format without the noise identified in the current markdown output.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.