OpenAPITools / OpenAPITools/openapi-generator

[REQ] [Dart] Generated code ready to be published to pub

Open
#3,912 4 comments 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

Is your feature request related to a problem? Please describe.

The generated code can not be published to pub without manual post-processing due to mismatch with the Dart guidelines.

  1. The docs directory should be named doc
  2. The pubspec is missing the author and homepage
  3. The overall score in the pub analyzis is very low (Example)
    3.1 CHANGELOG.md and examples are missing
    3.2. As described in #3633 variables should not be initialized with null

Describe the solution you'd like

  • Solution to 1. and 2. is part of pull request #3911
  • CHANGELOG.md could be an empty file to satisfy pub analyzis
  • Generation of examples could be done fairly easy with what is available in the "Getting started" section of the generated README.md

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 pull request #3911 and the generated Dart package's pubspec, docs directory, and README.md Getting started section. Check the pub analysis example and issue #3633 for the remaining expectations around CHANGELOG.md, examples, and null initialization. Done means generated output follows Dart package guidelines and can be published to pub without manual post-processing.

Written by the indexing model from the issue text.

Assessment

Tech stack
dart
Domain
release, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.