swagger-api / swagger-api/swagger-core
Include fluent methods in Schema to add types and examples
Open
Nobody has claimed this yet.
backlog
- Dominant language
- Java
- Stars
- 7.5k
- Forks
- 2.3k
- Avg merge
- 18h 1m
- Merged PRs (30d)
- 10
Description
In order to allow chaining with the rest of fluent methods in Schema (of swagger-models), there should be methods to add a type or an example that return the updated Schema, similar to existing ones such as addRequiredItem or addProperty.
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 the swagger-models Schema class and inspect the existing fluent methods such as addRequiredItem and addProperty. Add the requested fluent methods for a type and an example, ensuring they return the updated Schema so they can be chained.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100