docs(upgrade): say that four api.v2.* keys were renamed in 15.8 - #506
Open
marevol wants to merge 1 commit into
Open
docs(upgrade): say that four api.v2.* keys were renamed in 15.8#506marevol wants to merge 1 commit into
marevol wants to merge 1 commit into
Conversation
Four /api/v2 configuration keys lost their api.v2. prefix in 15.8 and no backward-compatible alias was kept, so a setting left under its old name is ignored without a warning and the shipped default takes effect instead. That reaches an existing deployment on upgrade and was not written down. api.v2.chat.stream.keepalive.interval.ms -> api.chat.stream.keepalive.interval.ms api.v2.param.max.length -> api.param.max.length api.v2.param.max.array.size -> api.param.max.array.size api.v2.click.max.rt -> api.click.max.timestamp The first is the one most likely to have been tuned: it sets how often a keep-alive frame is sent while POST /api/v2/chat/stream waits for the model, so a lost setting shows up in AI search mode. The last also changed name for accuracy - it bounds a click log's rt value, which is a timestamp rather than a response time. Values, defaults and behaviour are otherwise unchanged, and only an explicit setting is affected. Added to the 15.8 migration section in all seven languages.
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
1 participant
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.
What
Adds a subsection to the 15.8 migration guide (all seven languages) covering four
configuration keys that were renamed in
codelibs/fess#3280.Why
The keys lost their
api.v2.prefix and no backward-compatible alias was kept. Asetting left under its old name is ignored without any warning, and the shipped default
takes effect instead - so this reaches an existing deployment silently on upgrade.
api.v2.chat.stream.keepalive.interval.msapi.chat.stream.keepalive.interval.ms15000api.v2.param.max.lengthapi.param.max.length1000api.v2.param.max.array.sizeapi.param.max.array.size100api.v2.click.max.rtapi.click.max.timestamp9999999999999Verified against 15.8.0 rather than taken from the commit message:
api.*keys infess_config.propertiesthat changed;no
api.v2.*key remains in itgrepoversrc/mainfinds no code path reading an old name, so there is no aliasapi.chat.stream.keepalive.interval.msis read byChatStreamHandler, which is why thesection calls out AI search mode as where a lost setting becomes visible
api.click.max.timestampis read byClickHandlerto bound thertfield of a clicklog - a timestamp, not a response time, which is what the rename corrects
Values, defaults and behaviour are otherwise unchanged, and only an explicit setting is
affected, so the section says that too rather than sending everyone to check.
Placement
Immediately before the "plugin versions" subsection, which is the last entry of the 15.8
migration section in each language - the same slot
#503used for the LDAP note.Verification
.rststructure checked with docutils for all seven files (no structural warnings; thelist-tablerenders with its five rows in each). A full Sphinx build was not usable as agate here:
conf/conf.py:228fails under the Sphinx version in this environment(
ConfigError: truncated \uXXXX escape), which is pre-existing and unrelated - this PRtouches only
.rstfiles.