Skip to content

docs: demo data add note on decoupling and return type #2627

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

Merged
rsynek merged 2 commits into from
Sep 1, 2026
+7 −1
Merged

docs: demo data add note on decoupling and return type #2627

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4baea34
docs: demo data add note on decoupling and return type
TomCools Aug 31, 2026
08be216
docs: code review suggestions
TomCools Aug 31, 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
8 changes: 7 additions & 1 deletion docs/src/modules/ROOT/pages/running-timefold-solver/service/demo-data.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ To provide consumers of your model with example datasets, implement the `DemoDat
This interface requires you to implement 2 methods:

- `demoMetaData()`: returns a list of metadata, listing all the different datasets available.
- `generateDemoData(String demoDataId)`: generates the dataset with the given id, usually retrieved from the metadata.
- `generateDemoData(String demoDataId)`: generates the dataset with the given id, usually retrieved from the metadata. This method returns a `DemoData` object wrapping a `ModelRequest`, whose `ModelInput_` type parameter must match the `ModelInput` implementation used by your REST API (see xref:./rest-api.adoc[REST API]).

[WARNING]
====
Expand Down Expand Up @@ -137,6 +137,12 @@ When implementing these generator methods, construct a `ModelRequest` to wrap th
`ModelRequest` has two constructors: `ModelRequest(ModelInput_ modelInput)`, which defaults the configuration to `null`, and `ModelRequest(Configuration<ModelConfigurationOverrides_> configuration, ModelInput_ modelInput)`, if you also want to set a non-default configuration.
There is no constructor that takes the model config overrides directly; overrides are wrapped in a `Configuration` object first.

[NOTE]
====
If you xref:./rest-api.adoc#modelConverter[decouple your REST API classes from your solver domain] using a `ModelConvertor`, `ModelRequest` must wrap your `ModelInput` implementation, not the `SolverModel` (the `@PlanningSolution` class).
Pay extra attention to returning the correct class here, since both may look similar but only the `ModelInput` implementation is valid.
====

With this interface implemented, Timefold Solver will automatically expose these methods as REST endpoints.
These endpoints are *not* nested under your `ModelRest` resource path: they only share its version prefix.
See xref:./rest-api.adoc#generatedEndpoints[Generated endpoints] for the exact path.
Expand Down