softwaremill / softwaremill/tapir

Openapi codegen inner model normalization

Open
#843 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

openapi-codegen
Dominant language
Scala
Stars
1.5k
Forks
468
Avg merge
5h 37m
Merged PRs (30d)
34

Description

At the point when I started the generator, I wrote a new class hierarchy to parse the input yaml. BUT we probably could use the already written model classes. I think using one model representation is generally better, but using that model hierarchy is probably much harder.

Contributor guide

No contributing guide indexed for this repository

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 at the OpenAPI code generator's YAML parsing and inner-model normalization, then compare its class hierarchy with the existing model classes in apispec/openapi-model/src/main/scala/sttp/tapir/openapi. Determine whether the generator can use that existing representation; done means the generator relies on one model representation without losing required normalization behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, scala
Domain
backend-api-design, tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.