OpenAPITools / OpenAPITools/openapi-generator
[REQ] Add support for documentation cross-referencing
Nobody has claimed this yet.
- 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.
I have a setup where I generate a Python SDK using an OpenAPI specification file. This SDK is also used by other packages and I would like to be able to cross-reference the generated SDK objects in the documentation of those other packages.
My specific use case uses MKDocs and MKDocstrings to automatically generate documentation for my other packages. It has a feature where you can cross reference other projects' inventories. An example below shows how this adds a neat link to the Python str object, using the Python objects.inv file.
Describe the solution you'd like
It would be great if the OpenAPI Generator was also able to automatically generate such an inventory .inv file which could be used to cross-reference in other documentation. This could be added to the docs folder for example.
Describe alternatives you've considered
As far as I know, there is no other way to add cross-referencing using anything generated from the Python generator.
Additional context
/
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names no repository files or tests. Start by locating the Python generator's documentation output path and understanding how MKDocs/MKDocstrings inventories are consumed; done means generating a usable .inv file that lets external documentation cross-reference the generated SDK objects.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, python
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100