swagger-api / swagger-api/swagger-codegen

[Eiffel] Enhancements to the Eiffel generator

Open
#6,057 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Client: Eiffel Enhancement: General help wanted
Dominant language
Mustache
Stars
17.8k
Forks
6k
PR merge metrics
No merged PRs in 30d

Description

Description

Here is a list of enhancements I can think of.

  • Create shell scripts, batch files to generate Eiffel Petstore samples
  • Setup CI (travis, shippable, etc) to cover the Eiffel Petstore samples.
  • Refactor part of the code into an Abstract Eiffel base class, which can be later used in Eiffel server stub generators
  • Add Eiffel Style guide to the contribution guidelines so that Eiffel contributors know what to follow in terms of code style
  • Add {{#required}} .. {{/required}} to make sure the parameters (query, form, header, body) is non-null (exmaple)
  • Add support for validation rules defined in the spec (e.g. validation for parameters in Ruby API layer)

Please feel free to reply with other suggestions.

Swagger-codegen version

Latest master

Related issues/PRs

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

Suggest a Fix/Enhancement

If anyone wants to work on the enhancement, please reply to let us know.

cc @jvelilla

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

Review related PR #6036 and the existing Eiffel Petstore sample-generation shell and batch scripts first. Split the unchecked CI, contribution-guideline style, required-parameter template, and validation items into separately scoped work; done should be defined for each item, including CI coverage and documented Eiffel behavior.

Written by the indexing model from the issue text.

Assessment

Domain
ci-cd, documentation, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.