Skip to content

Commit

Permalink
openapi: add documentation, small optimisation
Browse files Browse the repository at this point in the history
  • Loading branch information
anttiviljami authored and muxator committed Apr 2, 2020
1 parent c2cca39 commit e821bbc
Show file tree
Hide file tree
Showing 5 changed files with 154 additions and 180 deletions.
2 changes: 2 additions & 0 deletions README.md
Expand Up @@ -111,6 +111,8 @@ For **responsible disclosure of vulnerabilities**, please write a mail to the ma
Etherpad is designed to be easily embeddable and provides a [HTTP API](https://github.com/ether/etherpad-lite/wiki/HTTP-API)
that allows your web application to manage pads, users and groups. It is recommended to use the [available client implementations](https://github.com/ether/etherpad-lite/wiki/HTTP-API-client-libraries) in order to interact with this API.

OpenAPI (previously swagger) definitions for the API are exposed under `/api/openapi.json`.

# jQuery plugin
There is a [jQuery plugin](https://github.com/ether/etherpad-lite-jquery-plugin) that helps you to embed Pads into your website.

Expand Down
4 changes: 4 additions & 0 deletions doc/api/http_api.md
Expand Up @@ -11,6 +11,10 @@ The API is designed in a way, so you can reuse your existing user system with th

Take a look at [HTTP API client libraries](https://github.com/ether/etherpad-lite/wiki/HTTP-API-client-libraries) to check if a library in your favorite programming language is available.

### OpenAPI

OpenAPI (formerly swagger) definitions are exposed under `/api/openapi.json` (latest) and `/api/{version}/openapi.json`. You can use official tools like [Swagger Editor](https://editor.swagger.io/) to view and explore them.

## Examples

### Example 1
Expand Down

0 comments on commit e821bbc

Please sign in to comment.