OpenAPITools / OpenAPITools/openapi-generator

[REQ] Table of supported features

Open
#2,256 0 comments 1 reaction 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.

It's hard to know which features of OpenAPI 2.0 or 3.0 I can expect to work, with different languages.

Describe the solution you'd like

It might be nice to have a table, in a wiki or some other document, that lists all language generators, and has Y/N values for features that are supported. The features could be added as necessary, but they could be things like:

  • is collectionFormat (OpenAPI 2) supported for params?
  • are form|simple|spaceDelimited|pipeDelimited (OpenAPI 3) supported for params?
  • are allOf|oneOf|anyOf supported?

This would also be helpful as a user (and potential contributor) when deciding whether to focus on OpenAPI 2.0 or 3.0.

Describe alternatives you've considered

Testing manually, or looking through Github issues and trying to figure out the latest status.

Additional context

N/A

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 reviewing the OpenAPI 2.0 and 3.0 features named in the issue, then inventory the language generators whose support should be compared. Define the table's location and feature scope, document Y/N support values with the relevant generator context, and consider the work done when users can compare feature support across generators.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
documentation
Issue type
Documentation
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.