OpenAPITools / OpenAPITools/openapi-generator

[REQ][webclient] Use of extension x-webclient-return-except-except-list-of-string

Open
#16,620 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Is your feature request related to a problem? Please describe.

In this PR, a bug with string arrays for webclient was fixed but in my opinion I think the resolution is not complete/optimal.

It is a breaking change and to maintain backwards compatibility you would have to add the x-webclient-return-except-except-list-of-string extension to each operation in each API.

  • We have a large number of apis and operations so we would have to add the extension one by one.

  • In my opinion, a particular extension of a technology (webclient) should not be in an API contract. API's should be technology agnostic as one API can be consumed by n technologies.

Describe the solution you'd like

@wing328 I think the ideal would be in the configuration to create a global property to set the behaviour

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing PR #16326 and the current handling of the x-webclient-return-except-except-list-of-string extension. Trace how generator configuration reaches webclient operations, then define a global setting that preserves backwards compatibility without requiring per-operation extensions. Done means the behavior can be selected globally and existing API contracts remain technology agnostic.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.