OpenAPITools / OpenAPITools/openapi-generator

[BUG] [scala-akka-server] generator handles optional post request body incorrectly

Open
#12,147 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description

The output of the scala-akka-http-server generator should output entity(as[Option[Schema]]) instead of entity(as[Schema]) when setting post request body option required to false.

openapi-generator version

6.0.0-beta

OpenAPI declaration file content or url

example

Generation Details

npm wrapper with default configuration

openapi-generator-cli generate --generator-name scala-akka-http-server -i swagger.yaml
Actual vs. Expected Output

Actual:

  lazy val route: Route =
    path("path") { 
      post {  
            entity(as[Schema1]){ body =>
              defaultService.pathPost(body = body)
            }
      }
    }

Expected:

  lazy val route: Route =
    path("path") { 
      post {  
            entity(as[Option[Schema1]]){ body =>
              defaultService.pathPost(body = body)
            }
      }
    }

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 running the stated openapi-generator-cli command with the linked OpenAPI example and inspect the scala-akka-http-server generator's generated route. Compare output for a request body with required set to false against the expected Option[Schema] entity type. Done means the generated route uses the optional type while preserving the service call behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
api, backend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.