OpenAPITools / OpenAPITools/openapi-generator

[Question] Should the generated Java client be sensitive to trailing slashes?

Open
#9,931 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

We (https://github.com/treeverse/lakeFS) have been using openapi-generator for a while and its been serving us great.

Lately, multiple customers have been running into problems where the Java client wasn't working. After looking into it, we found that those customers were using a URL with a trailing "/".

We have opened https://github.com/treeverse/lakeFS/issues/2214 on our end. However, would it make sense for openapi-generator to trim the "/" at runtime to avoid such situations?

If so, I would be happy to open a PR for this.

Related:

  1. https://github.com/OpenAPITools/openapi-generator/pull/678/
  2. https://github.com/OpenAPITools/openapi-generator/pull/7940/

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 reviewing the generated Java client behavior described in the issue and the related pull requests #678 and #7940. Determine where the client handles the base URL, then define and verify behavior for URLs with trailing slashes, including regression coverage if the relevant test entry point is found.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi
Domain
api, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.