swagger-api/swagger-codegen

[SWIFT] No README.md file generated for Swift Client

Open

#3,088 opened on Jun 8, 2016

View on GitHub
 (6 comments) (1 reaction) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Client: SwiftFeature: Documentationhelp wanted

Description

Description

I used swagger-codegen from a web-api but I don't get a readme file for SWIFT. I am not sure exactly which objects have to be used/configured and in what order. Is there any guide for this? If I generate for Objective-C or some other languages, there is a readme file generated that explains this...

Swagger-codegen version

swagger code generated from website

Swagger declaration file content or url
Command line used for generation
Steps to reproduce

Generate Swift Client Files

Related issues
Suggest a Fix

Generate a readme file explaining how to configure & use the swift objects

Contributor guide

Tech stack
swift
Domain
documentationapi
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-3 hours
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.
clear
Prerequisites
familiarity with Mustache templatesknowledge of Swift client generation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
This issue requests adding a README.md template for the Swift client generator. Review existing README templates for other languages (e.g., Objective C) in the `modules/swagger codegen/src/main/resources` directory. Identify the template variables and logic used, then create a Swift specific README.md.mustache file. The maintainer's comments (if any) should be checked for guidance on configuration details.