swagger-api / swagger-api/swagger-codegen

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

Open
#3,088 6 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Client: Swift Feature: Documentation help wanted
Dominant language
Mustache
Stars
17.8k
Forks
6k
PR merge metrics
No merged PRs in 30d

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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by generating the Swift client and comparing its output with the Objective-C client, which includes a README. Identify where generated documentation is selected for Swift; done means Swift output includes a README explaining how to configure and use the generated objects.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.