swagger-api/swagger-codegen

[Lua] Enhancements to Lua generator

Open

#6,284 opened on Aug 10, 2017

View on GitHub
 (0 comments) (0 reactions) (0 assignees)HTML (5,474 forks)batch import
Client: LuaEnhancement: Generalhelp wanted

Repository metrics

Stars
 (12,701 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Description

Here are a list of enhancements to Lua generator:

  • add auto-generated README.md
  • add auto-generated API, model documentation
  • generate a .rockspec file
  • better detection of code injection
  • add lua linting to .travis.yml
  • update CONTRIBUTING.md with Lua style guide
  • better support for query parameters
  • setup CI to cover Lua Petstore client
Swagger-codegen version

Latest master

Related issues/PRs

https://github.com/swagger-api/swagger-codegen/pull/6252

If anyone has other suggestions or wants work on any of these enhancements, please reply to let us know.

Contributor guide

Research direction
Start by implementing the auto generated README.md feature for the Lua generator. Investigate how other generators (e.g., Python, Ruby) generate README files, then adapt the Lua template.
Tech stack
lua
Domain
backend
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.
3-5 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.
Clear
Prerequisites
Lua
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65