docs: correct double version prefix - #2515
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
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
@Pathexamples to exclude the version prefix and explain how/v1is prepended at runtime. - Adjust quickstart configuration to set
model.api.version=v1and 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. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
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
TimetableConvertorexample useHardSoftScorewhile the Kotlin example below still usesHardMediumSoftScore, so the documentation becomes internally inconsistent.
public class TimetableConvertor implements ModelConvertor<HardMediumSoftScore, TimetableDto, EmptyModelConfigOverrides, Timetable, TimetableDto> {
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
triceo
approved these changes
Jul 17, 2026
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
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.
Solves #774