swagger-api / swagger-api/swagger-parser
[Feature]: Introduce resolveResponsesFully
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 867
- Forks
- 560
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 7
Description
Feature Description
The resolveResponses option has been introduced to fix the responses resolving step, but it will automatically inline responses, which we not always want to.
Use Case
Being able to resolve responses without inlining them.
Suggested Solution (optional)
To support both use cases, we may want to make the resolveResponses option resolve responses, but not inlining responses by default, and introduce resolveResponsesFully which will do the same but also inlining responses (what is currently done by the resolveResponses option).
Alternatives Considered
None :/
Additional Context
Checklist
- I have searched the existing issues to ensure this is not a duplicate.
- This feature would be useful to more than just my use case.
- I have provided enough detail for the maintainers to understand the scope of the request.
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 by reading the linked pull request 2127 and locating the current implementation and tests for the resolveResponses option. Determine how response resolution and inlining are currently coupled. Done means callers can resolve responses without inlining by default, while a separate resolveResponsesFully option preserves the existing fully inlined behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100