Repository navigation
JSPWIKI-1310 Add the list of pages, the references of a page and its HTML to the REST API - #646
Draft
arturobernalg wants to merge 27 commits into
Draft
arturobernalg wants to merge 27 commits into
arturobernalg wants to merge 27 commits into
Conversation
…n OpenAPI file that a test compares with the answers
… the REST API version 1
# Conflicts: # ChangeLog.md
…o feature/JSPWIKI-1310-plugins-suggestions # Conflicts: # ChangeLog.md
…310-plugins-suggestions
…310-search # Conflicts: # ChangeLog.md
…310-plugins-suggestions # Conflicts: # ChangeLog.md
…s to the REST API version 1
…310-search # Conflicts: # ChangeLog.md
…o feature/JSPWIKI-1310-plugins-suggestions # Conflicts: # ChangeLog.md # jspwiki-main/src/main/java/org/apache/wiki/search/DefaultSearchManager.java
…gestions' into feature/JSPWIKI-1310-pages-read
…HTML to the REST API version 1
…the pages in the REST API
… into feature/JSPWIKI-1310-pages-list # Conflicts: # jspwiki-main/src/test/java/org/apache/wiki/rest/ApiV1ServletTest.java
…t do not wait for it
…o feature/JSPWIKI-1310-plugins-suggestions
…gestions' into feature/JSPWIKI-1310-pages-read
… into feature/JSPWIKI-1310-pages-list
…o feature/JSPWIKI-1310-plugins-suggestions
…gestions' into feature/JSPWIKI-1310-pages-read # Conflicts: # ChangeLog.md
… into feature/JSPWIKI-1310-pages-list # Conflicts: # ChangeLog.md
This was referenced Nov 20, 2026
Draft
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.
Part of JSPWIKI-1310. This pull request builds on #589, #590 and #645, so it shows their commits until they are merged; the new commit is the last one.
Adds three more read-only endpoints to the REST API version 1, all described in
openapi.yaml:GET /api/v1/pages: the names of the pages the caller may view, sorted by name. The parametersmax(default 20) andoffsetread a long list in chunks.GET /api/v1/pages/{name}/references: the pages that link to the page (referredBy) and the pages it links to (refersTo). Pages the caller may not view are left out; a link to a page that is not written yet is kept.GET /api/v1/pages/{name}/html: the page rendered to HTML as the wiki shows it to the caller, without the template. The optional parameterversionworks as in the endpoint that reads the markup.The same rules as in the other endpoints apply: view permission is needed (401 for anonymous, 403 for a logged in caller), a page that does not exist is 404, and an offset that is not an integer of zero or more is 400.
Tested with
ApiV1ServletTest, 40 tests, each answer compared withopenapi.yaml, including that a page with an ACL is neither listed nor linked nor rendered for a caller who may not view it. Also run on a war in Tomcat 10.1: list, chunks, bad offset, references in both directions, HTML, a page with an ACL (401) and an unknown page (404). Not tried: a logged in caller on the running wiki (covered only by the test).