mirrors/etherpad-lite
1
0
Fork 0
mirror of https://github.com/ether/etherpad-lite.git synced 2025-04-27 19:06:15 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

openapi: add documentation, small optimisation

Browse source
This commit is contained in:
Viljami Kuosmanen 2020-03-29 20:25:43 +02:00 • committed by muxator
parent c2cca39c7d
commit e821bbcad8
5 changed files with 154 additions and 180 deletions
Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

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