Skip to content

chore: restructure packages of the definition module #2813

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
rsynek wants to merge 9 commits into
base: main
Choose a base branch
from
Draft

chore: restructure packages of the definition module #2813

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
bde607c
chore: make demo data a preview API
rsynek Nov 5, 2026
0829077
chore: remove unused UserModel
rsynek Nov 9, 2026
a800abf
chore: new package structure
rsynek Nov 9, 2026
528c569
address review comments
rsynek Nov 10, 2026
db67a9b
chore: remove the SPI package
rsynek Nov 10, 2026
151383a
chore: provide migration recipe for changed packages
rsynek Nov 11, 2026
15f10f2
chore: restructure the enterprise definition packages
rsynek Nov 12, 2026
be0f7b6
chore: add missing recipe steps
rsynek Nov 12, 2026
b1a4266
chore: fix formatting and test model openapi.json
rsynek Nov 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/src/modules/ROOT/pages/running-timefold-solver/service/rest-api.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ Additionally, more fields might be added for specific model implementations:

[NOTE]
====
This envelope is represented in Java/Kotlin by the `ModelResponse` record (`ai.timefold.solver.service.definition.api.domain.ModelResponse`).
This envelope is represented in Java/Kotlin by the `ModelResponse` record (`ai.timefold.solver.service.definition.api.dto.dataset.ModelResponse`).
Its accessor is named `outputMetrics()`, not `kpis()`; only the JSON serialization uses the `kpis` key (via `@JsonProperty("kpis")`).
The score itself is not a top-level field: it's nested inside `metadata.score`, not `metadata.run.score` or a top-level `score`.
====
Expand Down
4 changes: 4 additions & 0 deletions service/definition/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,10 @@
<plugin>
<groupId>org.revapi</groupId>
<artifactId>revapi-maven-plugin</artifactId>
<configuration>
<!-- Temporary override to skip the package changes introduced in 2.9.0. -->
<skip>true</skip>
</configuration>
</plugin>
</plugins>
</build>
Expand Down
30 changes: 30 additions & 0 deletions service/definition/src/build/revapi-differences.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,36 @@
"new": "class ai.timefold.solver.service.definition.api.domain.RunConfiguration",
"annotationType": "org.eclipse.microprofile.openapi.annotations.media.Schema",
"justification": "RunConfiguration now carries a free-form options map, so the class-level @Schema(additionalProperties = Schema.False.class) was intentionally removed to allow arbitrary option keys."
},
{
"ignore": true,
"code": "java.class.removed",
"old": "class ai.timefold.solver.service.definition.api.data.AbstractBasicDemoDataGenerator<ModelInput_ extends ai.timefold.solver.service.definition.api.ModelInput, ModelConfigOverrides_ extends ai.timefold.solver.service.definition.api.ModelConfigOverrides>",
"justification": "Not yet ready as a public API"
},
{
"ignore": true,
"code": "java.class.removed",
"old": "class ai.timefold.solver.service.definition.api.data.DemoData",
"justification": "Not yet ready as a public API"
},
{
"ignore": true,
"code": "java.class.removed",
"old": "class ai.timefold.solver.service.definition.api.data.DemoDataConfigEntry",
"justification": "Not yet ready as a public API"
},
{
"ignore": true,
"code": "java.class.removed",
"old": "interface ai.timefold.solver.service.definition.api.data.DemoDataGenerator",
"justification": "Not yet ready as a public API"
},
{
"ignore": true,
"code": "java.class.removed",
"old": "class ai.timefold.solver.service.definition.api.data.DemoMetaData",
"justification": "Not yet ready as a public API"
}
]
}
Expand Down
2 changes: 2 additions & 0 deletions ...finition/src/main/java/ai/timefold/solver/service/definition/api/AbstractSimpleModel.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
import ai.timefold.solver.core.api.domain.solution.PlanningScore;
import ai.timefold.solver.core.api.domain.solution.PlanningSolution;
import ai.timefold.solver.core.api.score.HardMediumSoftScore;
import ai.timefold.solver.service.definition.api.dto.dataset.ModelInput;
import ai.timefold.solver.service.definition.api.dto.dataset.ModelOutput;
import ai.timefold.solver.service.definition.api.metrics.InputMetricsAware;
import ai.timefold.solver.service.definition.api.metrics.ModelInputMetrics;
import ai.timefold.solver.service.definition.api.metrics.ModelOutputMetrics;
Expand Down
5 changes: 0 additions & 5 deletions ...inition/src/main/java/ai/timefold/solver/service/definition/api/ModelConfigOverrides.java
View file
Open in desktop

This file was deleted.

5 changes: 0 additions & 5 deletions service/definition/src/main/java/ai/timefold/solver/service/definition/api/ModelInput.java
View file
Open in desktop

This file was deleted.

5 changes: 0 additions & 5 deletions service/definition/src/main/java/ai/timefold/solver/service/definition/api/ModelOutput.java
View file
Open in desktop

This file was deleted.

4 changes: 0 additions & 4 deletions service/definition/src/main/java/ai/timefold/solver/service/definition/api/ResourceType.java
View file
Open in desktop

This file was deleted.

25 changes: 0 additions & 25 deletions service/definition/src/main/java/ai/timefold/solver/service/definition/api/UserModel.java
View file
Open in desktop

This file was deleted.

12 changes: 8 additions & 4 deletions ...ervice/definition/api/ModelConvertor.java → ...nition/api/conversion/ModelConvertor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
package ai.timefold.solver.service.definition.api;
package ai.timefold.solver.service.definition.api.conversion;

import java.util.Optional;

import ai.timefold.solver.core.api.score.Score;
import ai.timefold.solver.service.definition.api.domain.ModelConfig;
import ai.timefold.solver.service.definition.api.domain.ModelRequest;
import ai.timefold.solver.service.definition.api.domain.ModelResponse;
import ai.timefold.solver.service.definition.api.SolverModel;
import ai.timefold.solver.service.definition.api.dto.dataset.ModelConfig;
import ai.timefold.solver.service.definition.api.dto.dataset.ModelConfigOverrides;
import ai.timefold.solver.service.definition.api.dto.dataset.ModelInput;
import ai.timefold.solver.service.definition.api.dto.dataset.ModelOutput;
import ai.timefold.solver.service.definition.api.dto.dataset.ModelRequest;
import ai.timefold.solver.service.definition.api.dto.dataset.ModelResponse;

import org.jspecify.annotations.NullMarked;

Expand Down
2 changes: 1 addition & 1 deletion ...ce/definition/api/ModelConvertorBase.java → ...on/api/conversion/ModelConvertorBase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package ai.timefold.solver.service.definition.api;
package ai.timefold.solver.service.definition.api.conversion;

/**
* Root interface for all {@link ModelConvertor} implementations.
Expand Down
9 changes: 0 additions & 9 deletions ...ice/definition/src/main/java/ai/timefold/solver/service/definition/api/data/DemoData.java
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion ...ition/api/domain/ConstraintReference.java → .../api/description/ConstraintReference.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package ai.timefold.solver.service.definition.api.domain;
package ai.timefold.solver.service.definition.api.description;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
Expand Down
2 changes: 1 addition & 1 deletion ...ce/definition/api/ModelMaturityLevel.java → ...n/api/description/ModelMaturityLevel.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package ai.timefold.solver.service.definition.api;
package ai.timefold.solver.service.definition.api.description;

import com.fasterxml.jackson.annotation.JsonAlias;

Expand Down
6 changes: 1 addition & 5 deletions .../definition/api/domain/Configuration.java → ...nition/api/dto/dataset/Configuration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
package ai.timefold.solver.service.definition.api.domain;

import ai.timefold.solver.service.definition.api.ModelConfigOverrides;
import ai.timefold.solver.service.definition.api.configuration.MapsConfiguration;
import ai.timefold.solver.service.definition.api.configuration.ResourcesConfiguration;
package ai.timefold.solver.service.definition.api.dto.dataset;

import org.eclipse.microprofile.openapi.annotations.media.Schema;

Expand Down
2 changes: 1 addition & 1 deletion .../api/configuration/MapsConfiguration.java → ...on/api/dto/dataset/MapsConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package ai.timefold.solver.service.definition.api.configuration;
package ai.timefold.solver.service.definition.api.dto.dataset;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
Expand Down
7 changes: 3 additions & 4 deletions ...rvice/definition/api/domain/Metadata.java → .../definition/api/dto/dataset/Metadata.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package ai.timefold.solver.service.definition.api.domain;
package ai.timefold.solver.service.definition.api.dto.dataset;

import java.time.OffsetDateTime;
import java.time.format.DateTimeFormatter;
Expand All @@ -8,10 +8,9 @@
import java.util.Set;
import java.util.UUID;

import ai.timefold.solver.service.definition.api.SolvingStatus;
import ai.timefold.solver.service.definition.api.Status;
import ai.timefold.solver.service.definition.api.validation.LegacyValidationResult;
import ai.timefold.solver.service.definition.api.dto.validation.LegacyValidationResult;
import ai.timefold.solver.service.definition.api.validation.ModelValidator;
import ai.timefold.solver.service.definition.internal.dataset.Status;

import org.eclipse.microprofile.openapi.annotations.enums.SchemaType;
import org.eclipse.microprofile.openapi.annotations.media.Schema;
Expand Down
4 changes: 1 addition & 3 deletions ...ce/definition/api/domain/ModelConfig.java → ...finition/api/dto/dataset/ModelConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
package ai.timefold.solver.service.definition.api.domain;

import ai.timefold.solver.service.definition.api.ModelConfigOverrides;
package ai.timefold.solver.service.definition.api.dto.dataset;

import org.eclipse.microprofile.openapi.annotations.enums.SchemaType;
import org.eclipse.microprofile.openapi.annotations.media.Schema;
Expand Down
5 changes: 5 additions & 0 deletions ...main/java/ai/timefold/solver/service/definition/api/dto/dataset/ModelConfigOverrides.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
package ai.timefold.solver.service.definition.api.dto.dataset;

public interface ModelConfigOverrides {

}
5 changes: 5 additions & 0 deletions ...ition/src/main/java/ai/timefold/solver/service/definition/api/dto/dataset/ModelInput.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
package ai.timefold.solver.service.definition.api.dto.dataset;

public interface ModelInput {

}
5 changes: 5 additions & 0 deletions ...tion/src/main/java/ai/timefold/solver/service/definition/api/dto/dataset/ModelOutput.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
package ai.timefold.solver.service.definition.api.dto.dataset;

public interface ModelOutput {

}
5 changes: 1 addition & 4 deletions ...e/definition/api/domain/ModelRequest.java → ...inition/api/dto/dataset/ModelRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
package ai.timefold.solver.service.definition.api.domain;

import ai.timefold.solver.service.definition.api.ModelConfigOverrides;
import ai.timefold.solver.service.definition.api.ModelInput;
package ai.timefold.solver.service.definition.api.dto.dataset;

import org.eclipse.microprofile.openapi.annotations.media.Schema;

Expand Down
3 changes: 1 addition & 2 deletions .../definition/api/domain/ModelResponse.java → ...nition/api/dto/dataset/ModelResponse.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
package ai.timefold.solver.service.definition.api.domain;
package ai.timefold.solver.service.definition.api.dto.dataset;

import ai.timefold.solver.service.definition.api.ModelOutput;
import ai.timefold.solver.service.definition.api.metrics.ModelInputMetrics;
import ai.timefold.solver.service.definition.api.metrics.ModelOutputMetrics;

Expand Down
2 changes: 1 addition & 1 deletion ...configuration/ResourcesConfiguration.java → ...i/dto/dataset/ResourcesConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package ai.timefold.solver.service.definition.api.configuration;
package ai.timefold.solver.service.definition.api.dto.dataset;

import java.util.Map;

Expand Down
4 changes: 2 additions & 2 deletions ...finition/api/domain/RunConfiguration.java → ...ion/api/dto/dataset/RunConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
package ai.timefold.solver.service.definition.api.domain;
package ai.timefold.solver.service.definition.api.dto.dataset;

import java.util.Map;
import java.util.Set;

import jakarta.validation.constraints.Positive;
import jakarta.validation.constraints.Size;

import ai.timefold.solver.service.definition.api.termination.SolverTerminationConfig;
import ai.timefold.solver.service.definition.api.dto.solve.SolverTerminationConfig;

import org.eclipse.microprofile.openapi.annotations.media.Schema;

Expand Down
2 changes: 1 addition & 1 deletion ...service/definition/api/SolvingStatus.java → ...nition/api/dto/dataset/SolvingStatus.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package ai.timefold.solver.service.definition.api;
package ai.timefold.solver.service.definition.api.dto.dataset;

/**
* Represents the dateset lifecycle.
Expand Down
2 changes: 1 addition & 1 deletion ...rvice/definition/api/error/ErrorInfo.java → ...e/definition/api/dto/error/ErrorInfo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package ai.timefold.solver.service.definition.api.error;
package ai.timefold.solver.service.definition.api.dto.error;

import java.util.UUID;

Expand Down
2 changes: 1 addition & 1 deletion ...nition/api/error/ValidationErrorInfo.java → ...on/api/dto/error/ValidationErrorInfo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package ai.timefold.solver.service.definition.api.error;
package ai.timefold.solver.service.definition.api.dto.error;

import java.util.List;
import java.util.UUID;
Expand Down
2 changes: 1 addition & 1 deletion ...r/service/definition/api/log/LogInfo.java → ...rvice/definition/api/dto/log/LogInfo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package ai.timefold.solver.service.definition.api.log;
package ai.timefold.solver.service.definition.api.dto.log;

import com.fasterxml.jackson.annotation.JsonIncludeProperties;

Expand Down
2 changes: 1 addition & 1 deletion ...rvice/definition/api/ModelInputPatch.java → ...nition/api/dto/patch/ModelInputPatch.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package ai.timefold.solver.service.definition.api;
package ai.timefold.solver.service.definition.api.dto.patch;

import java.util.Collection;

Expand Down
2 changes: 1 addition & 1 deletion ...ice/definition/api/ModelInputPatchOp.java → ...tion/api/dto/patch/ModelInputPatchOp.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package ai.timefold.solver.service.definition.api;
package ai.timefold.solver.service.definition.api.dto.patch;

public enum ModelInputPatchOp {

Expand Down
6 changes: 3 additions & 3 deletions ...on/api/domain/ModelInputPatchRequest.java → ...api/dto/patch/ModelInputPatchRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
package ai.timefold.solver.service.definition.api.domain;
package ai.timefold.solver.service.definition.api.dto.patch;

import java.util.List;

import ai.timefold.solver.service.definition.api.ModelConfigOverrides;
import ai.timefold.solver.service.definition.api.ModelInputPatch;
import ai.timefold.solver.service.definition.api.dto.dataset.Configuration;
import ai.timefold.solver.service.definition.api.dto.dataset.ModelConfigOverrides;

import org.eclipse.microprofile.openapi.annotations.media.Schema;

Expand Down
2 changes: 1 addition & 1 deletion ...ion/api/ModelConstraintJustification.java → ...nalysis/ModelConstraintJustification.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package ai.timefold.solver.service.definition.api;
package ai.timefold.solver.service.definition.api.dto.scoreanalysis;

import ai.timefold.solver.core.api.score.stream.ConstraintJustification;

Expand Down
4 changes: 3 additions & 1 deletion ...ition/api/domain/ScoreAnalysisConfig.java → ...to/scoreanalysis/ScoreAnalysisConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
package ai.timefold.solver.service.definition.api.domain;
package ai.timefold.solver.service.definition.api.dto.scoreanalysis;

import ai.timefold.solver.service.definition.api.dto.dataset.ModelConfig;

import org.eclipse.microprofile.openapi.annotations.media.Schema;

Expand Down
6 changes: 3 additions & 3 deletions ...tion/api/domain/ScoreAnalysisRequest.java → ...o/scoreanalysis/ScoreAnalysisRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package ai.timefold.solver.service.definition.api.domain;
package ai.timefold.solver.service.definition.api.dto.scoreanalysis;

import ai.timefold.solver.service.definition.api.ModelConfigOverrides;
import ai.timefold.solver.service.definition.api.ModelInput;
import ai.timefold.solver.service.definition.api.dto.dataset.ModelConfigOverrides;
import ai.timefold.solver.service.definition.api.dto.dataset.ModelInput;

import org.eclipse.microprofile.openapi.annotations.media.Schema;

Expand Down
2 changes: 1 addition & 1 deletion .../termination/SolverTerminationConfig.java → ...pi/dto/solve/SolverTerminationConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package ai.timefold.solver.service.definition.api.termination;
package ai.timefold.solver.service.definition.api.dto.solve;

import java.time.Duration;

Expand Down
2 changes: 1 addition & 1 deletion ...pi/validation/LegacyValidationResult.java → ...to/validation/LegacyValidationResult.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package ai.timefold.solver.service.definition.api.validation;
package ai.timefold.solver.service.definition.api.dto.validation;

import java.util.List;

Expand Down
4 changes: 2 additions & 2 deletions .../validation/dto/ValidationIssueTypes.java → .../dto/validation/ValidationIssueTypes.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
package ai.timefold.solver.service.definition.api.validation.dto;
package ai.timefold.solver.service.definition.api.dto.validation;

import java.util.Collection;

import ai.timefold.solver.service.definition.api.validation.IssueType;
import ai.timefold.solver.service.definition.api.dto.validation.issue.IssueType;

import org.eclipse.microprofile.openapi.annotations.media.Schema;

Expand Down
5 changes: 2 additions & 3 deletions .../api/validation/dto/ValidationResult.java → .../api/dto/validation/ValidationResult.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
package ai.timefold.solver.service.definition.api.validation.dto;
package ai.timefold.solver.service.definition.api.dto.validation;

import java.util.Collection;

import ai.timefold.solver.service.definition.api.validation.Issue;
import ai.timefold.solver.service.definition.api.validation.ValidationStatus;
import ai.timefold.solver.service.definition.api.dto.validation.issue.Issue;

import org.eclipse.microprofile.openapi.annotations.media.Schema;

Expand Down
2 changes: 1 addition & 1 deletion ...tion/api/validation/ValidationStatus.java → .../api/dto/validation/ValidationStatus.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package ai.timefold.solver.service.definition.api.validation;
package ai.timefold.solver.service.definition.api.dto.validation;

public enum ValidationStatus {

Expand Down
3 changes: 2 additions & 1 deletion ...inition/api/validation/AbstractIssue.java → ...i/dto/validation/issue/AbstractIssue.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
package ai.timefold.solver.service.definition.api.validation;
package ai.timefold.solver.service.definition.api.dto.validation.issue;

import java.util.Collections;
import java.util.List;

import ai.timefold.solver.service.definition.api.dto.validation.issue.metadata.IssueMetadata;
import ai.timefold.solver.service.definition.impl.validation.ValidationIssueTypeCatalog;

import org.eclipse.microprofile.openapi.annotations.media.Schema;
Expand Down
4 changes: 3 additions & 1 deletion ...vice/definition/api/validation/Issue.java → ...ition/api/dto/validation/issue/Issue.java
View file
Open in desktop
Comment thread
rsynek marked this conversation as resolved.
Resolved
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
package ai.timefold.solver.service.definition.api.validation;
package ai.timefold.solver.service.definition.api.dto.validation.issue;

import java.util.List;

import ai.timefold.solver.service.definition.api.dto.validation.issue.metadata.IssueMetadata;

import org.jspecify.annotations.NonNull;

/**
Expand Down
Loading
Loading