openapi-directory/api/etherpad.local.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.2","servers":[{"url":"http://etherpad.local"},{"url":"http://pads.mro.name/api/1.2.15"}],"info":{"contact":{"email":"support@example.com","name":"The Etherpad Foundation","url":"https://etherpad.org/"},"description":"Etherpad is a real-time collaborative editor scalable to thousands of simultaneous real time users. It provides full data export capabilities, and runs on your server, under your control.","license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0.html"},"termsOfService":"https://etherpad.org/","title":"Etherpad API","version":"1.2.15","x-apisguru-categories":["developer_tools"],"x-origin":[{"format":"openapi","url":"https://pads.mro.name/api/openapi.json","version":"3.0"}],"x-providerName":"etherpad.local"},"security":[{"ApiKey":[]}],"paths":{"/appendChatMessage":{"get":{"operationId":"appendChatMessageUsingGET","parameters":[{"in":"query","name":"padID","schema":{"type":"string"}},{"in":"query","name":"text","schema":{"type":"string"}},{"in":"query","name":"authorID","schema":{"type":"string"}},{"in":"query","name":"time","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}},"summary":"appends a chat message","tags":["pad"]},"post":{"operationId":"appendChatMessageUsingPOST","parameters":[{"in":"query","name":"padID","schema":{"type":"string"}},{"in":"query","name":"text","schema":{"type":"string"}},{"in":"query","name":"authorID","schema":{"type":"string"}},{"in":"query","name":"time","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}},"summary":"appends a chat message","tags":["pad"]}},"/appendText":{"get":{"operationId":"appendTextUsingGET","parameters":[{"in":"query","name":"padID","schema":{"type":"string"}},{"in":"query","name":"text","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}}},"post":{"operationId":"appendTextUsingPOST","parameters":[{"in":"query","name":"padID","schema":{"type":"string"}},{"in":"query","name":"text","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}}}},"/checkToken":{"get":{"operationId":"checkTokenUsingGET","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}},"summary":"returns ok when the current api token is valid","tags":["pad"]},"post":{"operationId":"checkTokenUsingPOST","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}},"summary":"returns ok when the current api token is valid","tags":["pad"]}},"/copyPad":{"get":{"operationId":"copyPadUsingGET","parameters":[{"in":"query","name":"sourceID","schema":{"type":"string"}},{"in":"query","name":"destinationID","schema":{"type":"string"}},{"in":"query","name":"force","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}}},"post":{"operationId":"copyPadUsingPOST","parameters":[{"in":"query","name":"sourceID","schema":{"type":"string"}},{"in":"query","name":"destinationID","schema":{"type":"string"}},{"in":"query","name":"force","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}}}},"/copyPadWithoutHistory":{"get":{"operationId":"copyPadWithoutHistoryUsingGET","parameters":[{"in":"query","name":"sourceID","schema":{"type":"string"}},{"in":"query","name":"destinationID","schema":{"type":"string"}},{"in":"query","name":"force","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}}},"post":{"operationId":"copyPadWithoutHistoryUsingPOST","parameters":[{"in":"query","name":"sourceID","schema":{"type":"string"}},{"in":"query","name":"destinationID","schema":{"type":"string"}},{"in":"query","name":"force","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}}}},"/createAuthor":{"get":{"operationId":"createAuthorUsingGET","parameters":[{"in":"query","name":"name","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"properties":{"authorID":{"type":"string"}},"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}},"summary":"creates a new author","tags":["author"]},"post":{"operationId":"createAuthorUsingPOST","parameters":[{"in":"query","name":"name","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"properties":{"authorID":{"type":"string"}},"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}},"summary":"creates a new author","tags":["author"]}},"/createAuthorIfNotExistsFor":{"get":{"operationId":"createAuthorIfNotExistsForUsingGET","parameters":[{"in":"query","name":"authorMapper","schema":{"type":"string"}},{"in":"query","name":"name","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"properties":{"authorID":{"type":"string"}},"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}},"summary":"this functions helps you to map your application author ids to Etherpad author ids","tags":["author"]},"post":{"operationId":"createAuthorIfNotExistsForUsingPOST","parameters":[{"in":"query","name":"authorMapper","schema":{"type":"string"}},{"in":"query","name":"name","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"properties":{"authorID":{"type":"string"}},"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}},"summary":"this functions helps you to map your application author ids to Etherpad author ids","tags":["author"]}},"/createDiffHTML":{"get":{"operationId":"createDiffHTMLUsingGET","parameters":[{"in":"query","name":"padID","schema":{"type":"string"}},{"in":"query","name":"startRev","schema":{"type":"string"}},{"in":"query","name":"endRev","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"properties":{},"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}},"summary":"","tags":["pad"]},"post":{"operationId":"createDiffHTMLUsingPOST","parameters":[{"in":"query","name":"padID","schema":{"type":"string"}},{"in":"query","name":"startRev","schema":{"type":"string"}},{"in":"query","name":"endRev","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"properties":{},"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}},"summary":"","tags":["pad"]}},"/createGroup":{"get":{"operationId":"createGroupUsingGET","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"properties":{"groupID":{"type":"string"}},"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}},"summary":"creates a new group","tags":["group"]},"post":{"operationId":"createGroupUsingPOST","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"properties":{"groupID":{"type":"string"}},"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}},"summary":"creates a new group","tags":["group"]}},"/createGroupIfNotExistsFor":{"get":{"operationId":"createGroupIfNotExistsForUsingGET","parameters":[{"in":"query","name":"groupMapper","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"properties":{"groupID":{"type":"string"}},"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}},"summary":"this functions helps you to map your application group ids to Etherpad group ids","tags":["group"]},"post":{"operationId":"createGroupIfNotExistsForUsingPOST","parameters":[{"in":"query","name":"groupMapper","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"properties":{"groupID":{"type":"string"}},"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}},"summary":"this functions helps you to map your application group ids to Etherpad group ids","tags":["group"]}},"/createGroupPad":{"get":{"operationId":"createGroupPadUsingGET","parameters":[{"in":"query","name":"groupID","schema":{"type":"string"}},{"in":"query","name":"padName","schema":{"type":"string"}},{"in":"query","name":"text","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}},"summary":"creates a new pad in this group","tags":["group"]},"post":{"operationId":"createGroupPadUsingPOST","parameters":[{"in":"query","name":"groupID","schema":{"type":"string"}},{"in":"query","name":"padName","schema":{"type":"string"}},{"in":"query","name":"text","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}},"summary":"creates a new pad in this group","tags":["group"]}},"/createPad":{"get":{"description":"creates a new (non-group) pad. Note that if you need to create a group Pad, you should call createGroupPad","operationId":"createPadUsingGET","parameters":[{"in":"query","name":"padID","schema":{"type":"string"}},{"in":"query","name":"text","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}},"tags":["pad"]},"post":{"description":"creates a new (non-group) pad. Note that if you need to create a group Pad, you should call createGroupPad","operationId":"createPadUsingPOST","parameters":[{"in":"query","name":"padID","schema":{"type":"string"}},{"in":"query","name":"text","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}},"tags":["pad"]}},"/createSession":{"get":{"operationId":"createSessionUsingGET","parameters":[{"in":"query","name":"groupID","schema":{"type":"string"}},{"in":"query","name":"authorID","schema":{"type":"string"}},{"in":"query","name":"validUntil","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"properties":{"sessionID":{"type":"string"}},"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}},"summary":"creates a new session. validUntil is an unix timestamp in seconds","tags":["session"]},"post":{"operationId":"createSessionUsingPOST","parameters":[{"in":"query","name":"groupID","schema":{"type":"string"}},{"in":"query","name":"authorID","schema":{"type":"string"}},{"in":"query","name":"validUntil","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"properties":{"sessionID":{"type":"string"}},"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}},"summary":"creates a new session. validUntil is an unix timestamp in seconds","tags":["session"]}},"/deleteGroup":{"get":{"operationId":"deleteGroupUsingGET","parameters":[{"in":"query","name":"groupID","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}},"summary":"deletes a group","tags":["group"]},"post":{"operationId":"deleteGroupUsingPOST","parameters":[{"in":"query","name":"groupID","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}},"summary":"deletes a group","tags":["group"]}},"/deletePad":{"get":{"operationId":"deletePadUsingGET","parameters":[{"in":"query","name":"padID","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}},"summary":"deletes a pad","tags":["pad"]},"post":{"operationId":"deletePadUsingPOST","parameters":[{"in":"query","name":"padID","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}},"summary":"deletes a pad","tags":["pad"]}},"/deleteSession":{"get":{"operationId":"deleteSessionUsingGET","parameters":[{"in":"query","name":"sessionID","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}},"summary":"deletes a session","tags":["session"]},"post":{"operationId":"deleteSessionUsingPOST","parameters":[{"in":"query","name":"sessionID","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}},"summary":"deletes a session","tags":["session"]}},"/getAttributePool":{"get":{"operationId":"getAttributePoolUsingGET","parameters":[{"in":"query","name":"padID","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}}},"post":{"operationId":"getAttributePoolUsingPOST","parameters":[{"in":"query","name":"padID","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}}}},"/getAuthorName":{"get":{"operationId":"getAuthorNameUsingGET","parameters":[{"in":"query","name":"authorID","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"properties":{"info":{"properties":{"colorId":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"timestamp":{"type":"integer"}},"type":"object"}},"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}},"summary":"Returns the Author Name of the author","tags":["author"]},"post":{"operationId":"getAuthorNameUsingPOST","parameters":[{"in":"query","name":"authorID","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"properties":{"info":{"properties":{"colorId":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"timestamp":{"type":"integer"}},"type":"object"}},"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}},"summary":"Returns the Author Name of the author","tags":["author"]}},"/getChatHead":{"get":{"operationId":"getChatHeadUsingGET","parameters":[{"in":"query","name":"padID","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"properties":{"chatHead":{"properties":{"text":{"type":"string"},"time":{"type":"integer"},"userId":{"type":"string"},"userName":{"type":"string"}},"type":"object"}},"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}},"summary":"returns the chatHead (chat-message) of the pad","tags":["pad"]},"post":{"operationId":"getChatHeadUsingPOST","parameters":[{"in":"query","name":"padID","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"properties":{"chatHead":{"properties":{"text":{"type":"string"},"time":{"type":"integer"},"userId":{"type":"string"},"userName":{"type":"string"}},"type":"object"}},"type":"object"},"message":{"example":"ok","type":"string"}},"type":"object"}}},"description":"ok (code 0)"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"example":1,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"error message","type":"string"}},"type":"object"}}},"description":"generic api error (code 1)"},"401":{"content":{"application/json":{"schema":{"properties":{"code":{"example":4,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"no or wrong API key","type":"string"}},"type":"object"}}},"description":"no or wrong API key (code 4)"},"500":{"content":{"application/json":{"schema":{"properties":{"code":{"example":2,"type":"integer"},"data":{"example":null,"type":"object"},"message":{"example":"internal error","type":"string"}},"type":"object"}}},"description":"internal api error (code 2)"}},"summary":"returns the chatHead (chat-message) of the pad","tags":["pad"]}},"/getChatHistory":{"get":{"operationId":"getChatHistoryUsingGET","parameters":[{"in":"query","name":"padID","schema":{"type":"string"}},{"in":"query","name":"start","schema":{"type":"string"}},{"in":"query","name":"end","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"code":{"example":0,"type":"integer"},"data":{"properties":{"messages":{"items":{"properties":{"text":{"