docs(15.9): correct API responses and add missing plugin, label and XPath steps - #560
Merged
Merged
Conversation
…Path steps - search-scroll: a non-GET request is refused with 403 by the CSRF check before the handler answers 405; say both. - api-overview, rate-limiting: the server-wide rate limit answers with its own JSON body (rate_limit_exceeded with 429 and Retry-After, then ip_blocked with 403 while the address is blocked), not the v2 error envelope; rate_limited is what the per-endpoint limits return. - plugin-guide: describe the Local tab that uploads a jar file, and that the Remote list is read from the plugin repositories. - fess-setup: add how to install plugins on a host without Internet access by placing the jar files in app/WEB-INF/plugin/. - labeltype-guide: with a virtual host, labels whose virtual host field is empty are not shown; create one label per host with the same value. - crawler-advanced: the HTML XPath settings apply to every web crawl, unchanged documents keep their old content under incremental crawling, and field.xpath.default.content overrides the XPath per crawl config. All seven languages, 15.9 tree only.
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.
Summary
Correct places where the 15.9 documentation disagrees with the product, and add steps that were missing.
Changes
All seven languages, 15.9 tree only (7 files per language):
config/search-scroll.rst: a non-GET request to/api/v2/documents/allis refused with403 forbiddenwhen it has no valid CSRF token, becauseSearchApiV2Managerchecks the token before the handler runs. Only a request that has a valid token gets405 method_not_allowed. Previously the page said 405 for everything.api/api-overview.rst:rate_limitedis the code for the per-endpoint limits (login, password change, chat). A new note describes the server-wide rate limit (rate.limit.enabled).RateLimitFilterruns before the v2 API and does not use the v2 envelope:Retry-Afterand{"error":"rate_limit_exceeded",...,"retry_after":60}.{"error":"ip_blocked",...}and noRetry-After.config/rate-limiting.rst: an address blocked for exceeding the limit also gets 403, and the page now shows both response bodies.admin/plugin-guide.rst:.jarfile. The "Remote" selection must stay on its first entry, because the upload is chosen by that value.plugin.repositories.install/fess-setup.rst: new "no Internet access" subsection. It covers:app/WEB-INF/plugin/, or uploading them on the install page;admin/labeltype-guide.rst: when a request comes through a virtual host, only labels with that host in their Virtual Host field are listed, so labels with an empty field are hidden (LabelTypeHelper#getLabelTypeItemList). To show a label on several hosts, create one label per host with the same value.config/crawler-advanced.rst, covering thecrawler.document.html.*.xpathsettings:Last-Modifiedis not newer than the indexed one is not fetched again, so it keeps the content extracted with the old XPath (FessCrawlerThread#isContentUpdated).field.xpath.default.content(and.lang/.digest) in a web crawl config's parameters overrides them for that config (FessXpathTransformer#getContentXpath).Checks
python3 tools/check_headings.pyon every changed file: no mismatchesfess-setup-offlinelabel resolves