swagger-api/swagger-codegen

[Kotlin] Improve client generator functionality

Open

#5,730 opened on May 29, 2017

View on GitHub
 (8 comments) (9 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Client: KotlinEnhancement: Generalhelp wanted

Description

Description

This is a tracking issue for adding functionality to the Kotlin client generator.

  • Support "default" responses. Currently 200 OK isn't handled, for example, in PetApi#addPet. Revisit this. It appears to be an issue with the petstore.yaml used by most generators, which doesn't define a 200 or "default" response for PetApi#addPet.
  • Support enum type generation (see #5769)
  • Support inline/embedded enums (see #5769)
  • Add model tests for top-level enums and inline/embedded enums
  • Support collectionFormat (multi) (see #5792)
  • Test/Implement arrays of maps, arrays, objects
  • Test/Implement maps of arrays/maps, objects
  • Support allOf via composition
  • Support allOf via inheritance
  • (optional?) Per-request modification of headers,authorization
    • NOTE: ApiClient.defaultHeaders can be modified once to globally set headers for auth, user-agent, etc.
    • Test, or better implement basic auth support
    • Test, or better implement OAuth support
    • Test, or better implement apiKey auth
  • Generate Api tests
  • Generate Model tests
  • Generate Api docs (see #5731)
  • Generate Model docs (see #5731)
  • Update README.md to be more project-specific rather than generic information about the generator/template (see ##5731)
  • Consider an option for android targeting (--additional-properties=android=true), to use built-in serialization and other features
  • Add support for Retrofit library (Ref: https://github.com/swagger-api/swagger-codegen/issues/6368)
  • Add an option to select date library (Ref: #6892)
Related issues
  • #5071

Contributor guide

Tech stack
kotlin
Domain
backendapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
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.
needs investigation
Prerequisites
Kotlin basicsOpenAPI/Swagger knowledgeCode generation concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
15
Research direction
This tracking issue covers many sub tasks for the Kotlin client generator. First time contributors should focus on a single checkbox item, such as 'Test/Implement arrays of maps, arrays, objects' or adding model tests. Relevant files are in the Kotlin generator module (e.g., modules/swagger codegen/src/main/java/io/swagger/codegen/languages/KotlinClientCodegen.java). Review previously completed tasks linked in the issue (e.g., #5769, #5792) for patterns. The maintainers have not recent activity, so ask clarifying questions in the issue before starting.