docs: Add information about version validation of models#2379
Merged
triceo merged 1 commit intoJun 24, 2026
Conversation
diogodanielsoaresferreira
requested review from
TomCools and
triceo
as code owners
diogodanielsoaresferreira
temporarily deployed
to
internal
GitHub Actions
Inactive
mswiderski
approved these changes
Jun 17, 2026
rsynek
approved these changes
Jun 22, 2026
rsynek
reviewed
Jun 22, 2026
| - The request query string includes parameters such as `type`, `registrationKey`, `handleSubscription`, and (for shared type) multiple `restrictedTo` entries for tenants | ||
| - If the platform responds with 409 (conflict) and `timefold.model.overwrite=true`, the plugin will PATCH `/api/platform/v1/models/{registrationKey}` to update the existing model | ||
| - The plugin reads the model descriptor to obtain name/id by extracting `timefold-model-descriptor.json` from the archive (or reading `target/timefold/timefold-model-descriptor.json` when present) | ||
| - The platform validates the model version (`timefold.application.version`) on registration. It must be a release version `vN` (e.g. `v1`), a git commit hash (1–40 lowercase hex characters), or the literal `SNAPSHOT`; any other value is rejected with HTTP 400. |
Collaborator
There was a problem hiding this comment.
Does the maven plugin also provide explanation of the reason why the registration failed with HTTP 400?
Contributor
Author
There was a problem hiding this comment.
We return the error message in the 4xx error, and the maven plugin should show it in case of failed model register.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related with: https://github.com/TimefoldAI/timefold-platform/pull/4870