Skip to content

[spring] Support 'date-time-local' format#23395

Open
Allsimon wants to merge 1 commit intoOpenAPITools:masterfrom
Allsimon:dateTimeLocal
Open

[spring] Support 'date-time-local' format#23395
Allsimon wants to merge 1 commit intoOpenAPITools:masterfrom
Allsimon:dateTimeLocal

Conversation

@Allsimon
Copy link
Copy Markdown

@Allsimon Allsimon commented Mar 29, 2026

See https://spec.openapis.org/registry/format/date-time-local.html

fixes #13889

@cachescrubber (2022/02) @welshm (2022/02) @MelleD (2022/02) @atextor (2022/02) @manedev79 (2022/02) @javisst (2022/02) @borsch (2022/02) @banlevente (2022/02) @Zomzog (2022/09) @martin-mfg (2023/08)

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Summary by cubic

Add support for the OpenAPI date-time-local format in the Java/Spring generator. Maps to LocalDateTime (java.time.LocalDateTime) and parses defaults when the java8 date library is used; fixes #13889.

  • New Features
    • Map date-time-localLocalDateTime in AbstractJavaCodegen; always import java.time.LocalDateTime; add ModelUtils.isDateTimeLocalSchema.
    • Parse date-time-local defaults via LocalDateTime.parse(...) for the java8 date library (including nested object property defaults); add unit tests (Java + Spring) and regenerate samples (Pet.adoptionDate with default).

Written for commit aee5ba3. Summary will update on new commits.

Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 issue found across 3 files

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractJavaCodegen.java">

<violation number="1" location="modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractJavaCodegen.java:2661">
P2: New format handling uses mismatched keys (`date-time-local` vs `local-date`), so the added `date-time-local` property post-processing branch will not execute.</violation>
</file>

Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I expect @wing328 to suggest to simply move this into an existing spec rather than creating a new one 😅

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I almost put it in date-time-parameter-types-for-testing.yml but wasn't sure if this was the best move, I'll update the PR 👍

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@wing328
Copy link
Copy Markdown
Member

wing328 commented Apr 1, 2026

https://github.com/OpenAPITools/openapi-generator/actions/runs/23816722621/job/69487441944?pr=23395

please update the samples to fix this

@DateTimeFormat(iso = DateTimeFormat.ISO.DATE)
private LocalDate dateOfBirth = LocalDate.parse("2021-01-01");

private LocalDateTime adoptionDate = "2007-12-03T10:15:30";
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks off?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah sorry about that, I was in a rush and git push'd as soon as the build passed.
I noticed after pushing and marked the PR as draft but not fast enough to not waste your time

It should be good now

@Allsimon Allsimon force-pushed the dateTimeLocal branch 2 times, most recently from b5c45a8 to c33bc7f Compare April 5, 2026 11:08
@Allsimon Allsimon marked this pull request as ready for review April 5, 2026 11:14
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 issue found across 7 files

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractJavaCodegen.java">

<violation number="1" location="modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractJavaCodegen.java:1417">
P2: `date-time-local` default generation is incorrectly limited to `dateLibrary=java8`, so `java8-localdatetime` silently loses declared defaults.</violation>
</file>

Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.

return null;
} else if (ModelUtils.isDateTimeLocalSchema(schema)) {
if (schema.getDefault() != null) {
if ("java8".equals(getDateLibrary())) {
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai bot Apr 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2: date-time-local default generation is incorrectly limited to dateLibrary=java8, so java8-localdatetime silently loses declared defaults.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractJavaCodegen.java, line 1417:

<comment>`date-time-local` default generation is incorrectly limited to `dateLibrary=java8`, so `java8-localdatetime` silently loses declared defaults.</comment>

<file context>
@@ -1411,6 +1412,13 @@ public String toDefaultValue(CodegenProperty cp, Schema schema) {
             return null;
+        } else if (ModelUtils.isDateTimeLocalSchema(schema)) {
+            if (schema.getDefault() != null) {
+                if ("java8".equals(getDateLibrary())) {
+                    return String.format(Locale.ROOT, "LocalDateTime.parse(\"%s\")", String.valueOf(schema.getDefault()));
+                }
</file context>
Fix with Cubic

Copy link
Copy Markdown
Contributor

@Chrimle Chrimle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG][JAVA] Implement adapter for java.time.LocalDateTime in client code

3 participants