OpenAPITools/openapi-generator

Enhancement to the Crystal client generator

Open

#8,363 opened on Jan 7, 2021

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Java (7,516 forks)batch import
Client: CrystalEnhancement: GeneralHacktoberfesthelp wanted

Repository metrics

Stars
 (26,243 stars)
PR merge metrics
 (Avg merge 9d 1h) (123 merged PRs in 30d)

Description

Description

Here is a list of pending enhancements.

  • remove commented code: some code (ruby) was commented out. If confirmed these code do not need to be plotted to Crystal, we can safely remove it
  • add return type to the function signature
  • add auto-generated doc (api, model, readme)
  • add more tests (e.g. upload file filie)
  • better code format

If anyone wants to help, please reply to let us know and we can share some good starting points.

openapi-generator version

Latest master

Related issues/PRs

https://github.com/OpenAPITools/openapi-generator/pull/8304

Contributor guide

Research direction
Focus on the Crystal client generator module in the openapi generator codebase. Locate the files containing commented Ruby code and remove them. Then, add return types to function signatures in the generated Crystal code. Follow the existing pattern to add auto generated documentation. Write additional tests, such as for file upload. Finally, improve code formatting.
Tech stack
java
Domain
apitooling
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitOpenAPI Specification
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70