OpenAPITools / OpenAPITools/openapi-generator
[REQ] Merge OAS vendor extensions support pages
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.
Migrate to single list of supported OAS vendor extensions.
Today, it seems like there are two different lists, where neither is a superset of the other.
Wiki: https://github.com/OpenAPITools/openapi-generator/wiki/Vendor-Extensions
This page includes
x-generate-alias-as-modelwhich is supported by all generators but not included in the following repo page.
Repo: https://github.com/OpenAPITools/openapi-generator/blob/master/docs/templating.md#extensions
This page includes
x-enum-varnamesandx-enum-descriptionswhich are supported by all generators but not listed in the wiki page.
Describe the solution you'd like
Single location which describes supported vendor extensions. It seems like it would be preferable to maintain this in a version controlled page. It would also be nice if this was a stand-alone page for vendor extensions, vs. being embedded in a larger templating page.
The page not chosen as the single location could be updated with a deprecation message and link to updated single list.
Describe alternatives you've considered
None.
Additional context
For reference, Redocly documents their OAS vendor extensions as follows:
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
Compare the vendor-extension lists in the Wiki page and docs/templating.md#extensions, including the referenced Redocly examples. Choose the version-controlled location for a standalone combined list, then update the other page with a deprecation notice and link. Done means the supported extensions are documented in one location without losing any entries.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100