swagger-api / swagger-api/swagger-parser
SwaggerParseResult Messages Should have a Type
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 867
- Forks
- 560
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 7
Description
when trying to parse an spec - there are different types of messages which is hard to discerns the behaviour for example a retrieval error is [unable to read location 'xzy'] which is pretty fatal to the process, where something like [attribute paths is missing] isn't (when using OAS for a domain model for example)
it would be good if this was an Object itself as opposed to a list of strings with some categorisation attached - FATAL, ERROR, WARN, INFO, otherwise every time a new message gets added people have to keep trying to handle them as a string
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
The issue names SwaggerParseResult but no files, tests, or entry points. Start by locating SwaggerParseResult and the code that creates or consumes its messages, then clarify the severity categories and compatibility expectations; done means messages expose a defined type instead of requiring string matching, with affected tests updated.
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
- 30/100