guardrail-dev / guardrail-dev/guardrail
Getting "incorrectly formatted" errors for openapi: 3.0.1 YAML and JSON resource file on windows 10
- Dominant language
- Scala
- Stars
- 541
- Forks
- 138
- PR merge metrics
- No merged PRs in 30d
Description
Using "sbt-guardrail" % "0.62.0" in a project causes
`Spec file service.yml is incorrectly formatted.`
Running exactly the same on Mac OSX works with both file types.
Env:
sbt 1.4.6 (AdoptOpenJDK Java 1.8.0_275)
Resource files:
https://github.com/pbernet/akka_streams_tutorial/blob/guardrail/src/main/resources/events.yaml
https://github.com/pbernet/akka_streams_tutorial/blob/guardrail/src/main/resources/json.yaml
Reproducer:
https://github.com/pbernet/akka_streams_tutorial/tree/guardrail
Contributor guide
Research direction
Start with the linked guardrail reproducer and the resource files src/main/resources/events.yaml and src/main/resources/json.yaml, using sbt-guardrail 0.62.0 on Windows 10. Compare the result with macOS and identify why both OpenAPI formats are rejected on Windows; done means the files are accepted consistently on both platforms.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, scala
- Domain
- api
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100