swagger-api / swagger-api/swagger-parser
Providing line and column numbers in parsed Swagger object
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 867
- Forks
- 560
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 7
Description
We are currently building an API linter based on your parser library (https://github.com/zalando-incubator/zally). So, thanks for providing such a nice library. :-)
We had the feature request of providing line and column number information if there is a violation in a given swagger file. As I've understood the code correctly, every given Swagger spec is transformed into a JSON object before parsed. We thought about providing line and column information for yaml files - most users of our service have yaml files.
Is this on your roadmap?
What would be necessary to include those information into swagger-parser? Maybe you already have an implementation idea in mind.
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
No source files, tests, or entry points are named. Start by tracing the parser's transformation of Swagger or YAML input into JSON objects, then determine how line and column metadata could remain attached to parsed objects; done means linter consumers can access that location information for violations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100