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 (26,243 stars) (7,516 forks)batch import
Client: CrystalEnhancement: GeneralHacktoberfesthelp wanted

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

Tech stack
None
Domain
apibackendtooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Crystal language basicsOpenAPI Generator codebase navigation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Review the referenced PR #8304 for context. The issue lists concrete tasks: remove commented Ruby code, add return types, generate docs, add tests (e.g., upload file), and improve code formatting. Look at the Crystal client generator module in the openapi generator repo (likely under modules/openapi generator/src/main/resources/com/openapitools/codegen/crystal). Start by identifying the commented code and confirming removal, then proceed with adding type annotations and docs. Tests may be in the test directory. Check maintainer comments for starting points.