OpenAPITools / OpenAPITools/openapi-generator

[BUG][OpenAPI] Conversion from Swagger (v2) host field to server url field (v3) results in an additional trailing slash at the end of the url

Open
#16,559 0 comments 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?
Description

Conversion from Swagger (v2) host field to server url field (v3) results in an additional trailing slash at the end of the url.

openapi-generator version

7.0.1-SNAPSHOT (docker)

OpenAPI declaration file content or url

INPUT

swagger: "2.0"
info:
  title: Title
  version: version
host: someHost

OUTPUT

openapi: 3.0.1
info:
  title: Title
  version: version
servers:
- url: https://someHost/
                     # ^ This slash is extra
Generation Details
docker run --rm -v ${PWD}:/local openapitools/openapi-generator-cli generate --remove-operation-id-prefix -p outputFile=openapi.yaml -i /local/swagger.yaml -g openapi-yaml -o /local/gen/openapi-v3
Steps to reproduce

Generate using the provided command on the provided swagger v2 file.

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 provided Docker generation command with the minimal Swagger 2.0 input and inspect the conversion path that produces the OpenAPI 3 servers.url value. Compare the generated URL with the expected value and add or update coverage for the absent trailing slash; done means the conversion preserves the host without adding an extra slash.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi
Domain
api, tooling
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.