OpenAPITools / OpenAPITools/openapi-generator
[BUG] JAVA GET lists with optional query params generates methods that make query params required
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Version:
<groupId>org.openapitools</groupId>
<artifactId>openapi-generator-maven-plugin</artifactId>
<version>4.3.1</version>
API specs:
/hospitals:
get:
operationId: getHospitals
tags:
- Hospital
parameters:
- in: query
name: name
schema:
type: string
Issue:
Regardless adding the required true/false value will still generate:
public ApiResponse<HospitalListGetResponseV1> getHospitalsWithHttpInfo(String name) throws ApiException {
So if you will be able to query for example for 10 fields, you will need to perform 10 times an empty string or like that as you can see in the screenshot below.
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 generating the Java client with the shown OpenAPI GET operation and inspect the generated getHospitalsWithHttpInfo signature. Verify how optional query parameters are represented and locate the related generation tests. Done means optional parameters can be omitted without passing empty strings, with regression coverage for this specification.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, openapi
- Domain
- api, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100