swagger-api / swagger-api/swagger-parser
Relative paths are not OS-cross compatible (does not work on Windows)
Open
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 867
- Forks
- 560
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 7
Description
If I use the following
def config = new CodegenConfigurator()
config.setInputSpec("my-file-relative-path.json")
It will work in mac/unix, but not on windows, so I have to do the following:
config.setInputSpec(file("my-file-relative-path.json").path)
or I'll get "missing swagger input or config!" due to the file not being picked up.
Problem is probably on Swagger20parser.java. read(String location, List auths)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in Swagger20parser.java at read(String location, List auths), using the relative input example from the issue to trace why the path is not picked up on Windows. Verify that a relative config.setInputSpec path works on Windows without the file(...).path workaround while preserving the existing macOS and Unix behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100