Skip to content

docs: correct double version prefix - #2515

Merged
TomCools merged 10 commits into
TimefoldAI:mainfrom
TomCools:docs/774
Jul 17, 2026
Merged

docs: correct double version prefix#2515
TomCools merged 10 commits into
TimefoldAI:mainfrom
TomCools:docs/774

Conversation

@TomCools

Copy link
Copy Markdown
Contributor

Solves #774

Copilot AI left a comment

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.

Pull request overview

This PR updates the service documentation to clarify that the REST API version prefix is applied automatically (via quarkus.rest.path) and to remove the duplicated /v1/v1/... path pattern from examples.

Changes:

  • Update @Path examples to exclude the version prefix and explain how /v1 is prepended at runtime.
  • Adjust quickstart configuration to set model.api.version=v1 and align the REST resource path example accordingly.
  • Refresh related REST API documentation text/links and correct a score type in a converter snippet.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File Description
docs/src/modules/ROOT/pages/running-timefold-solver/service/rest-api.adoc Updates REST root/version-prefix explanation and adjusts @Path examples to avoid double version prefixes.
docs/src/modules/ROOT/pages/quickstart/service/getting-started.adoc Updates quickstart configuration and @Path guidance to use model.api.version and omit the version in @Path.

Comment thread docs/src/modules/ROOT/pages/running-timefold-solver/service/rest-api.adoc Outdated
Comment thread docs/src/modules/ROOT/pages/running-timefold-solver/service/rest-api.adoc Outdated
Comment thread docs/src/modules/ROOT/pages/quickstart/service/getting-started.adoc
Comment thread docs/src/modules/ROOT/pages/quickstart/service/getting-started.adoc Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot AI left a comment

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.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

Comment thread docs/src/modules/ROOT/pages/quickstart/service/getting-started.adoc
Comment thread docs/src/modules/ROOT/pages/running-timefold-solver/service/rest-api.adoc Outdated
Comment thread docs/src/modules/ROOT/pages/running-timefold-solver/service/rest-api.adoc Outdated
Copilot AI review requested due to automatic review settings July 17, 2026 05:57

Copilot AI left a comment

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.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

Comment thread docs/src/modules/ROOT/pages/running-timefold-solver/service/rest-api.adoc Outdated
Comment thread docs/src/modules/ROOT/pages/quickstart/service/getting-started.adoc

Copilot AI left a comment

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.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.

Comment thread docs/src/modules/ROOT/pages/running-timefold-solver/service/rest-api.adoc Outdated
Comment thread docs/src/modules/ROOT/pages/running-timefold-solver/service/rest-api.adoc Outdated
Comment thread docs/src/modules/ROOT/pages/quickstart/service/getting-started.adoc Outdated
Comment thread docs/src/modules/ROOT/pages/quickstart/service/getting-started.adoc Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot AI left a comment

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.

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

Comment thread docs/src/modules/ROOT/pages/running-timefold-solver/service/rest-api.adoc Outdated
Comment thread docs/src/modules/ROOT/pages/quickstart/service/getting-started.adoc Outdated
Copilot AI review requested due to automatic review settings July 17, 2026 08:49

Copilot AI left a comment

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.

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

Comment thread docs/src/modules/ROOT/pages/quickstart/service/getting-started.adoc Outdated

Copilot AI left a comment

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.

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

Comments suppressed due to low confidence (1)

docs/src/modules/ROOT/pages/running-timefold-solver/service/rest-api.adoc:252

  • This change makes the Java TimetableConvertor example use HardSoftScore while the Kotlin example below still uses HardMediumSoftScore, so the documentation becomes internally inconsistent.
public class TimetableConvertor implements ModelConvertor<HardMediumSoftScore, TimetableDto, EmptyModelConfigOverrides, Timetable, TimetableDto> {

Comment thread docs/src/modules/ROOT/pages/quickstart/service/getting-started.adoc
Copilot AI review requested due to automatic review settings July 17, 2026 09:23
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot AI left a comment

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.

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

Comment thread docs/src/modules/ROOT/pages/quickstart/service/getting-started.adoc Outdated
Copilot AI review requested due to automatic review settings July 17, 2026 09:27
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot AI left a comment

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.

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

Comment thread docs/src/modules/ROOT/pages/quickstart/service/getting-started.adoc
Copilot AI review requested due to automatic review settings July 17, 2026 09:31

Copilot AI left a comment

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.

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.

@TomCools
TomCools merged commit 6bb404e into TimefoldAI:main Jul 17, 2026
4 checks passed
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.

3 participants