Skip to content

[java] Support 'time-local' format#23555

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

[java] Support 'time-local' format#23555
Allsimon wants to merge 1 commit intoOpenAPITools:masterfrom
Allsimon:timeLocal

Conversation

@Allsimon
Copy link
Copy Markdown

@Allsimon Allsimon commented Apr 15, 2026

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

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

Adds support for the OpenAPI time-local format in Java generators. Models now use java.time.LocalTime with correct default handling when using the java8 date library.

  • New Features
    • Map time-local to LocalTime and add the import when using the java8 date library.
    • Generate defaults with LocalTime.parse(...); keep string defaults for non-java8.
    • Add ModelUtils.isTimeLocalSchema and handle nested property defaults.
    • Update Spring tests and petstore samples (new feedingTime property).

Written for commit 97fe053. 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.

3 issues 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="samples/openapi3/client/petstore/spring-cloud-date-time/src/main/java/org/openapitools/model/Pet.java">

<violation number="1" location="samples/openapi3/client/petstore/spring-cloud-date-time/src/main/java/org/openapitools/model/Pet.java:44">
P2: New `LocalTime` model field is generated without Spring `@DateTimeFormat`, unlike other temporal fields, creating a Spring formatting/binding parity gap for `time-local`.</violation>
</file>

<file name="samples/client/petstore/spring-cloud-date-time/src/main/java/org/openapitools/model/Pet.java">

<violation number="1" location="samples/client/petstore/spring-cloud-date-time/src/main/java/org/openapitools/model/Pet.java:44">
P2: New `LocalTime` model field is missing `@DateTimeFormat(iso = DateTimeFormat.ISO.TIME)`, causing inconsistent and potentially non-ISO Spring binding versus other temporal fields.</violation>
</file>

<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: `time-local` defaults are skipped for `java8-localdatetime` because default generation checks `"java8".equals(getDateLibrary())` while type mapping uses `dateLibrary.startsWith("java8")`.</violation>
</file>

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

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

private LocalTime feedingTime = LocalTime.parse("10:15:30");
Copy link
Copy Markdown
Contributor

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

Choose a reason for hiding this comment

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

P2: New LocalTime model field is generated without Spring @DateTimeFormat, unlike other temporal fields, creating a Spring formatting/binding parity gap for time-local.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At samples/openapi3/client/petstore/spring-cloud-date-time/src/main/java/org/openapitools/model/Pet.java, line 44:

<comment>New `LocalTime` model field is generated without Spring `@DateTimeFormat`, unlike other temporal fields, creating a Spring formatting/binding parity gap for `time-local`.</comment>

<file context>
@@ -40,6 +41,8 @@ public class Pet {
   @DateTimeFormat(iso = DateTimeFormat.ISO.DATE)
   private LocalDate dateOfBirth = LocalDate.parse("2021-01-01");
 
+  private LocalTime feedingTime = LocalTime.parse("10:15:30");
+
   public Pet() {
</file context>
Suggested change
private LocalTime feedingTime = LocalTime.parse("10:15:30");
@DateTimeFormat(iso = DateTimeFormat.ISO.TIME)
private LocalTime feedingTime = LocalTime.parse("10:15:30");
Fix with Cubic

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.

@DateTimeFormat is not needed since Spring Boot 3

Do I need to add it ? I'm not sure any Spring Boot 2 users will want to use a recent generator anyway... see #23269

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.

I'm also open to create another PR that drop this annotation

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

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

Choose a reason for hiding this comment

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

P2: time-local defaults are skipped for java8-localdatetime because default generation checks "java8".equals(getDateLibrary()) while type mapping uses dateLibrary.startsWith("java8").

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>`time-local` defaults are skipped for `java8-localdatetime` because default generation checks `"java8".equals(getDateLibrary())` while type mapping uses `dateLibrary.startsWith("java8")`.</comment>

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

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant