Skip to content

JSPWIKI-1310 Add reading of pages, their history and their attachments to the REST API - #645

Draft
arturobernalg wants to merge 23 commits into
apache:masterfrom
arturobernalg:feature/JSPWIKI-1310-pages-read
Draft

arturobernalg wants to merge 23 commits into
apache:masterfrom
arturobernalg:feature/JSPWIKI-1310-pages-read

Conversation

@arturobernalg

Copy link
Copy Markdown
Member

Part of JSPWIKI-1310. This pull request builds on #589 and #590, so it shows their commits until they are merged; the new commit is the last one.

Adds three read-only endpoints to the REST API version 1, all described in openapi.yaml:

  • GET /api/v1/pages/{name}: name, version, author, last modified and the wiki markup of the page. The optional parameter version asks for an older version.
  • GET /api/v1/pages/{name}/history: the versions of the page, latest first.
  • GET /api/v1/pages/{name}/attachments: the attachments of the page, sorted by name, with size and version.

The caller needs the view permission on the page: 401 for an anonymous caller, 403 for a logged in one. The permission is checked before the existence of the page, so the answer does not tell whether a page is there. A page that does not exist is 404 and a version that is not a positive integer is 400.

Two details worth a look. A provider that keeps no old versions numbers its only version -1, which the API reports as 1. A page that was put in the page directory by hand has no history, and its history lists the current version.

There is no writing in this pull request on purpose. Creating, editing and deleting need decisions about CSRF and ACLs that I would like to discuss first.

Tested with ApiV1ServletTest, 32 tests, each answer compared with openapi.yaml. Also run on a war in Tomcat 10.1: page, unknown page, page with an ACL (401), version=0 (400), history and attachments. Not tried: a logged in caller on the running wiki (covered only by the test), and attachments with a provider other than the default.

…n OpenAPI file that a test compares with the answers
…o feature/JSPWIKI-1310-plugins-suggestions

# Conflicts:
#	ChangeLog.md
…310-plugins-suggestions

# 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
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.

1 participant