Commit Graph

50 Commits (f0e5bff84fb8821947dd3bdefddd9b9485f74372)

Author SHA1 Message Date
Chocobozzz 82b919fc65 api: add getStats() function 2020-04-04 22:03:46 +02:00
Viljami Kuosmanen e821bbcad8 openapi: add documentation, small optimisation 2020-04-03 01:03:11 +02:00
Ray Bellis fc661ee13a core: allow URL parameters and POST bodies to co-exist.
Node 8.14.0 prohibits HTTP headers that exceed 8 KB (source:
https://nodejs.org/en/blog/vulnerability/november-2018-security-releases/#denial-of-service-with-large-http-headers-cve-2018-12121).

This patch allows for the parameters within the body of an HTTP POST request to
be used in addition to those within the URL (and will override them).

Closes #3568.

---
Muxator 2019-10-19:
- this commit was cherry-picked from 882b93487f
- it was modified to include the necessary changes in the documentation
2019-06-27 00:52:53 +02:00
muxator 705cc6f5e4 Change everywhere the link to https://etherpad.org (it was plain http) 2019-04-16 00:54:54 +02:00
HairyFotr fce55df2b7 Fix typos 2019-01-16 11:14:04 +01:00
muxator e9fb63f426 docs: "```js" -> "```json" in Markdown of some json blocks 2018-08-09 22:27:56 +02:00
HairyFotr c7548450c0
Typos and minor fixes in bin, doc, and root 2017-09-14 13:33:27 +02:00
Alexander Lorz cd7f01f40a minor changes in docs
- correct link to doc generation tool.
 - fixed incomplete sentence regarding API client libraries
2016-12-26 20:18:34 +01:00
Luc Didry 2341d09807 Add undocumented API function restoreRevision to doc
This commit is dedicated to Schoumi. Thx for supporting me on Tipeee :-)
2016-11-16 10:36:18 +01:00
Ted Mielczarek c70d655b96 Add appendText API (from #2810) to docs. 2016-01-13 07:26:20 -05:00
Stefan c8d7e6e0b8 Add appendChatMessage API to docs 2015-08-15 22:41:09 +02:00
John McLear 1d44490dc4 Merge pull request #2599 from Gared/doc_api_fix
Fix documentation for deleteSession api method
2015-04-11 15:07:18 +01:00
Stefan a842eb4f5c Fix documentation for deleteSession api method 2015-04-11 16:05:41 +02:00
John McLear 84b3f1728f Merge pull request #2597 from Gared/increase_api_version
increase http api version to latest version
2015-04-11 14:56:47 +01:00
Stefan d26c3d5f7e increase http api version 2015-04-11 13:45:59 +02:00
Stefan 601be46993 Add docs for new error message for createPad api method 2015-04-11 13:16:03 +02:00
Luc Didry 845788c39d Add a saveRevision API function
Calling saveRevision create an author which name is "API"
2015-02-25 01:04:27 +01:00
Luc Didry a08c50a77d Fixes #1870
Add two functions to API :
 * getSavedRevisionsCount
 * listSavedRevisions
2015-02-24 23:42:35 +01:00
Luc Didry 4166f19078 Set correct API version in doc
The doc says current version is 1.2.9, but there is getPadID which uses 1.2.10 API.
2015-02-22 22:32:18 +01:00
Stephan Jauernick bbd50dfc62 Added documentation for the newly added API method getPadID 2014-06-02 20:25:16 +02:00
Marcel Klehr a7671a690b docs: update api version 2014-03-30 15:10:29 +02:00
Lennart Brinkmann 7dd29454e9 Remove duplicate doc entry for setHTML() 2013-12-14 21:11:37 +01:00
John McLear 58bbfd8a65 resolve merge conflict 2013-12-09 21:55:04 +00:00
s1341 5409cdaa3f add some documentation for move/copy 2013-11-18 14:38:44 +02:00
Luc Didry b769acaee0 Forgot to bump the API version 2013-11-07 23:28:07 +01:00
Luc Didry 5bccfdf060 Forgot a small chunck of documentation for getRevisionChangeset 2013-11-07 22:46:35 +01:00
Luc Didry a4194efaf1 Fixed #1981 - uncomplete HTTP API documentation 2013-11-07 22:22:37 +01:00
Eric Schrijver b34224559d ‘Etherpad Lite’ -> ‘Etherpad’ 2013-09-29 13:57:37 +02:00
neurolit e96baf6ef1 API documentation: listAllPads() returns {padIDs: [...]} instead of [...] 2013-03-26 16:37:57 +01:00
John McLear 9e1dfc9487 docs for setHTML 2013-02-12 23:44:09 +00:00
Manuel Knitza fde10052ca Update doc/api/http_api.md
Updated
2013-02-12 21:57:01 +01:00
John McLear a19ad983f1 docs for api change 2013-01-29 16:48:56 +00:00
mluto cb2b93b133 Added getChatHistory and getChatHead (api+code+doc) 2013-01-26 14:35:26 +01:00
John McLear 654654b4e1 Merge pull request #1342 from spcsser/feature/padlisting
API & backend to list pads on epl instance
2013-01-14 08:13:57 -08:00
spcsser 062dbff738 Added listAllPads api docu 2013-01-11 12:59:02 +01:00
Stephan Jauernick 9f9f7a627e corrected a documentation glitch for checkToken - clarified which token is validated 2013-01-02 15:14:46 +01:00
Marcel Klehr b31563ea07 Fix docs: Correct API version for listAllGroups endpoint 2012-12-28 15:37:10 +01:00
Marcel Klehr ffc9bcf028 Bump API version for checkToken endpoint 2012-12-27 22:09:22 +01:00
Stephan Jauernick c2cc292324 Update doc/api/http_api.md
Added docs for the checkToken function
2012-12-07 11:28:03 +01:00
Hyacinthe Cartiaux d6027726e6
Fix urls, use github.com/ether
Signed-off-by: Hyacinthe Cartiaux <hyacinthe.cartiaux@uni.lu>
2012-11-22 01:12:30 +01:00
Marcel Klehr dd1e383d6e Bump api version in #usage section 2012-10-30 14:35:26 +01:00
Marcel Klehr ef923209b0 Refactor structure of api/http_api.md and add api version numbers for all endpoints. 2012-10-30 14:18:50 +01:00
Marcel Klehr f8f002adc0 Add listAllGroups API endpoint
Adds a database key that lists all groups
2012-09-17 23:03:56 +02:00
Marcel Klehr eeb605334f Add in docs for getAuthorName API method 2012-09-06 12:13:41 +02:00
Marcel Klehr 8a696ab77d Expect a comma seperated list of sessionIDs in session cookie
This allows people to be active on more than one group.
2012-09-02 19:51:12 +02:00
Mark Holmquist f9469ef256 Add in padUsers HTTP API call
I needed the list of users this time, so I got it. There are docs
and everything.
2012-08-17 13:39:16 -07:00
Mark Holmquist 17375b2eed Fix doc format, add in makefile for docs
OK, first up, SOMEBODY *cough*analphabet*cough* screwed up the docs
by making them all use the wrong heading level. Not cool, guy. I
had to change them so they would compile right.

But anyway, now the docs will build into sexy-looking HTML and will
shortly be hosted on marktraceur.info.

Fixed the makefile to work properly.

Run:
 * `make clean` for removing old doc-build(s)
 * `make docs` for running new doc-build(s)
2012-08-13 21:11:39 -07:00
Mark Holmquist e491476a0f Added in docs for the HTTP call I just added 2012-08-08 10:26:18 -07:00
Marcel Klehr 70fb765118 Restructure headings. 2012-08-07 20:19:37 +02:00
Marcel Klehr 5fac05a395 Add docs. 2012-08-03 22:04:06 +02:00