OpenAPITools/openapi-generator

Enhancement to the Crystal client generator

Open

#8.363 geöffnet am 7. Jan. 2021

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Java (26.243 Stars) (7.516 Forks)batch import
Client: CrystalEnhancement: GeneralHacktoberfesthelp wanted

Beschreibung

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
Keine
Domain
apibackendtooling
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 days
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
Crystal language basicsOpenAPI Generator codebase navigation
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
50
Research-Richtung
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.