OpenAPITools / OpenAPITools/openapi-generator
[BUG][java] JavaSpring Date PathParams serialize in the wrong format in
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Bug Report Checklist
- Have you provided a full/minimal spec to reproduce the issue?
- Have you validated the input using an OpenAPI validator (example)?
- Have you tested with the latest master to confirm the issue still exists?
- Have you searched for related issues/PRs?
- What's the actual output vs expected output?
- [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description
Date parameters in the path should be serialized according to RFC3339 (YYYY-MM-DD) but are actually serialized as M/D/YY. This was already addressed in the queryParams template by specifying a DateTimeFormat. The same logic should be used in the pathParams template.
openapi-generator version
Using OpenAPI Generator 5.3.0
OpenAPI declaration file content or url
components:
parameters:
MyDateParam:
name: myDate
in: path
required: true
type: string
format: date
Generation Details
Using the following settings:
- module: JavaSpring
- library: spring-cloud
- dateLibrary: java8
Steps to reproduce
Serialize a pathParam date using a Feign client. The resulting path will contain an incorrect date.
Suggest a fix
The same issue was already addressed in the queryParams template. Applying it to the pathParams template resolves the issue. I'll submit a PR shortly.
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 with the JavaSpring spring-cloud pathParams template and compare it with the existing queryParams template's date handling. Generate a Feign client from the supplied OpenAPI declaration using dateLibrary java8; done when a path date is serialized as RFC3339 YYYY-MM-DD rather than M/D/YY.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, openapi, spring
- Domain
- api
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100