OpenAPITools / OpenAPITools/openapi-generator

[REQ] Feature Checklist

Open
#3,810 3 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

Question:

I am currently trying to create a new generator. Before I start with the implementation I want to have a checklist what I have to implement to support all features of openapi. If that is not available I am not able to create a transparent well documented python generator with a feature list of what I already have implemented and what not.

Describe the solution you'd like

I would like to create a new markdown documentation file/guide for the generator on how to create a new generator listing all features which are supported and have to be implemented to archive a generator which is supporting all needed features to fully support the openapi-specification. For that I am trying to collect/create a full list of features which does have to be implemented to fully support the current openapi-specifications.

what this issue is about

I will start to create a checklist/featurelist in this issue which will/could be added to the project later via a pull request adding a new markdown file containing that checklist

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

The issue does not identify an existing file, test, or entry point. Start by collecting the features required by the current OpenAPI specifications and organize them into the proposed Markdown guide and checklist for a new generator. Done means the guide documents the feature list and allows implementation status to be recorded.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, python
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.