New REST API Browser based on Swagger UI.

On  we released version 3.1.0 of Userscripts for Confluence!

New and Noteworthy

This release provides the following new and noteworthy features.

REST API Browser in Admin Section

As we have already announced to be happening, all apps with a REST API now support a Swagger UI to browse the app's Web API.

The REST API Browser is a great app. So why the change?

It is likely that the support for the Atlassian REST API Browser will be discontinued in the near future. As of today the REST API Browser does already not provide the documentation in the latest versions of Confluence. See Atlassian REST API Browser doesn’t show Java Doc Comments). It is recommended to switch to an alternative tool for using REST APIs with documentation.

We moved to Swagger.

There are no new services with this new version of the Web API Extension, but we updated the documentation and now provide examples for parameters and documents pushed via requests and received in the response.

In case the administration needs to integrate the administration tools outside of Confluence (via the simple administration tool the app provides), then this documentation is certainly handy.

Installation Instructions

Simply install the app via the Atlassian Marketplace or the downloaded OBR artifact.

If you use a previous version of Confluence, please select Userscripts for Confluence 2.4.3.

Upgrade Instructions

This version supports Confluence version 9.2.x. and later.

For previous versions of Confluence there are separate versions of the projectdoc Toolbox:

  • If you use a version of Confluence < 9.x , please select Userscripts for Confluence 2.4.3
  • For Confluence 9.0.x and 9.1.x we recommend to upgrade to Confluence 9.2.x (LTS) or alternatively use version 3.0.x of Userscripts for Confluence

List of Changes

Key Summary T P Status Resolution Description
USR4C-42 REST API Browser in Admin Section New Feature Major Done Fixed

Since the REST API Browser does not support documentation for new Confluence version we need to add a section in the administration to provide a documented Web API.

Note that this browser may be operated by anyone, while the REST services will check the required access permissions.

USR4C-44 Websudo for Configuration Improvement Major Done Fixed

Protect the Configuration Screen in the Admin Console with Websudo.

USR4C-43 Remove HTML Probe Code Improvement Major Done Fixed

The code to check if the script code is a HTML page is too crude to be effective (too many false positives).

We remove that code.