diff --git a/changelog.html b/changelog.html index aefb2217b..0fb620576 100644 --- a/changelog.html +++ b/changelog.html @@ -47,6 +47,7 @@

1.12.1 (to be determined)

-

Available REST API clients

-

REST API clients are implementations of the REST API in a specific programming language.

-

Official

+

Generating a REST API client

+

The plugin publishes an OpenAPI specification that describes all of its endpoints. Rather + than relying on a hand-written client library, use this specification to generate a client for your programming + language of choice, using tools like OpenAPI Generator.

+

When the plugin is installed, the specification is available at:

-

Third party

- +

An interactive version of the documentation, based on this specification, is linked from the plugin's page in the + Openfire admin console.

Installation

Copy restAPI.jar into the plugins directory of your Openfire server. The plugin will be automatically deployed. To upgrade to a newer version, overwrite the restAPI.jar file with the new one.

Important Step: To enable the plugin make sure to set the system property adminConsole.access.allow-wildcards-in-excludes to true

diff --git a/readme.md b/readme.md index bacf218d7..9f4b97905 100644 --- a/readme.md +++ b/readme.md @@ -26,17 +26,17 @@ Issues may be reported to the [forums](https://discourse.igniterealtime.org) or * Get clustering status of Openfire * Get overview of 'readiness' and 'liveness' state of Openfire -## Available REST API clients -REST API clients are implementations of the REST API in a specific programming language. +## Generating a REST API client +The plugin publishes an [OpenAPI](https://www.openapis.org/) specification that describes all of its endpoints. Rather +than relying on a hand-written client library, use this specification to generate a client for your programming +language of choice, using tools like [OpenAPI Generator](https://openapi-generator.tech/). -### Official -* JAVA: https://github.com/igniterealtime/REST-API-Client +When the plugin is installed, the specification is available at: +* `http://example.org:9090/plugins/restapi/v1/openapi.yaml` (YAML) +* `http://example.org:9090/plugins/restapi/v1/openapi.json` (JSON) -### Third party -* PHP: https://github.com/gidkom/php-openfire-restapi (partly implemented) -* PHP: https://github.com/gnello/php-openfire-restapi (partly implemented) -* GO Lang: https://github.com/Urethramancer/fireman (partly implemented) -* Python: https://github.com/seamus-45/openfire-restapi (partly implemented) +An interactive version of the documentation, based on this specification, is linked from the plugin's page in the +Openfire admin console. ## Installation