Etherpad API
Etherpad is a real-time collaborative editor scalable to thousands of simultaneous real time users
COMMUNITYAPI KEY0 INSTALLS
OpenAPI Specificationv3.0
{
"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",
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_apis.guru_assets_images_no-logo.svg"
}
},
"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": {
"type": "string"
},
"time": {
"type": "integer"
},
"userId": {
"type": "string"
},
"userName": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"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 chat history",
"tags": [
"pad"
]
},
"post": {
"operationId": "getChatHistoryUsingPOST",
"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": {
"type": "string"
},
"time": {
"type": "integer"
},
"userId": {
"type": "string"
},
"userName": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"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 chat history",
"tags": [
"pad"
]
}
},
"/getHTML": {
"get": {
"operationId": "getHTMLUsingGET",
"parameters": [
{
"in": "query",
"name": "padID",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "rev",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"html": {
"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": "returns the text of a pad formatted as HTML",
"tags": [
"pad"
]
},
"post": {
"operationId": "getHTMLUsingPOST",
"parameters": [
{
"in": "query",
"name": "padID",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "rev",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"html": {
"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": "returns the text of a pad formatted as HTML",
"tags": [
"pad"
]
}
},
"/getLastEdited": {
"get": {
"operationId": "getLastEditedUsingGET",
"parameters": [
{
"in": "query",
"name": "padID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"lastEdited": {
"type": "integer"
}
},
"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 timestamp of the last revision of the pad",
"tags": [
"pad"
]
},
"post": {
"operationId": "getLastEditedUsingPOST",
"parameters": [
{
"in": "query",
"name": "padID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"lastEdited": {
"type": "integer"
}
},
"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 timestamp of the last revision of the pad",
"tags": [
"pad"
]
}
},
"/getPadID": {
"get": {
"operationId": "getPadIDUsingGET",
"parameters": [
{
"in": "query",
"name": "roID",
"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": "getPadIDUsingPOST",
"parameters": [
{
"in": "query",
"name": "roID",
"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)"
}
}
}
},
"/getPublicStatus": {
"get": {
"operationId": "getPublicStatusUsingGET",
"parameters": [
{
"in": "query",
"name": "padID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"publicStatus": {
"type": "boolean"
}
},
"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": "return true of false",
"tags": [
"pad"
]
},
"post": {
"operationId": "getPublicStatusUsingPOST",
"parameters": [
{
"in": "query",
"name": "padID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"publicStatus": {
"type": "boolean"
}
},
"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": "return true of false",
"tags": [
"pad"
]
}
},
"/getReadOnlyID": {
"get": {
"operationId": "getReadOnlyIDUsingGET",
"parameters": [
{
"in": "query",
"name": "padID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"readOnlyID": {
"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": "returns the read only link of a pad",
"tags": [
"pad"
]
},
"post": {
"operationId": "getReadOnlyIDUsingPOST",
"parameters": [
{
"in": "query",
"name": "padID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"readOnlyID": {
"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": "returns the read only link of a pad",
"tags": [
"pad"
]
}
},
"/getRevisionChangeset": {
"get": {
"operationId": "getRevisionChangesetUsingGET",
"parameters": [
{
"in": "query",
"name": "padID",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "rev",
"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": "getRevisionChangesetUsingPOST",
"parameters": [
{
"in": "query",
"name": "padID",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "rev",
"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)"
}
}
}
},
"/getRevisionsCount": {
"get": {
"operationId": "getRevisionsCountUsingGET",
"parameters": [
{
"in": "query",
"name": "padID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"revisions": {
"type": "integer"
}
},
"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 number of revisions of this pad",
"tags": [
"pad"
]
},
"post": {
"operationId": "getRevisionsCountUsingPOST",
"parameters": [
{
"in": "query",
"name": "padID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"revisions": {
"type": "integer"
}
},
"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 number of revisions of this pad",
"tags": [
"pad"
]
}
},
"/getSavedRevisionsCount": {
"get": {
"operationId": "getSavedRevisionsCountUsingGET",
"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": "getSavedRevisionsCountUsingPOST",
"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)"
}
}
}
},
"/getSessionInfo": {
"get": {
"operationId": "getSessionInfoUsingGET",
"parameters": [
{
"in": "query",
"name": "sessionID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"info": {
"properties": {
"authorID": {
"type": "string"
},
"groupID": {
"type": "string"
},
"id": {
"type": "string"
},
"validUntil": {
"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 informations about a session",
"tags": [
"session"
]
},
"post": {
"operationId": "getSessionInfoUsingPOST",
"parameters": [
{
"in": "query",
"name": "sessionID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"info": {
"properties": {
"authorID": {
"type": "string"
},
"groupID": {
"type": "string"
},
"id": {
"type": "string"
},
"validUntil": {
"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 informations about a session",
"tags": [
"session"
]
}
},
"/getStats": {
"get": {
"operationId": "getStatsUsingGET",
"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)"
}
}
},
"post": {
"operationId": "getStatsUsingPOST",
"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)"
}
}
}
},
"/getText": {
"get": {
"operationId": "getTextUsingGET",
"parameters": [
{
"in": "query",
"name": "padID",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "rev",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"text": {
"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": "returns the text of a pad",
"tags": [
"pad"
]
},
"post": {
"operationId": "getTextUsingPOST",
"parameters": [
{
"in": "query",
"name": "padID",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "rev",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"text": {
"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": "returns the text of a pad",
"tags": [
"pad"
]
}
},
"/listAllGroups": {
"get": {
"operationId": "listAllGroupsUsingGET",
"parameters": [],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"groupIDs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"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": [
"group"
]
},
"post": {
"operationId": "listAllGroupsUsingPOST",
"parameters": [],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"groupIDs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"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": [
"group"
]
}
},
"/listAllPads": {
"get": {
"operationId": "listAllPadsUsingGET",
"parameters": [],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"padIDs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"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": "list all the pads",
"tags": [
"pad"
]
},
"post": {
"operationId": "listAllPadsUsingPOST",
"parameters": [],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"padIDs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"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": "list all the pads",
"tags": [
"pad"
]
}
},
"/listAuthorsOfPad": {
"get": {
"operationId": "listAuthorsOfPadUsingGET",
"parameters": [
{
"in": "query",
"name": "padID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"authorIDs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"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 an array of authors who contributed to this pad",
"tags": [
"pad"
]
},
"post": {
"operationId": "listAuthorsOfPadUsingPOST",
"parameters": [
{
"in": "query",
"name": "padID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"authorIDs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"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 an array of authors who contributed to this pad",
"tags": [
"pad"
]
}
},
"/listPads": {
"get": {
"operationId": "listPadsUsingGET",
"parameters": [
{
"in": "query",
"name": "groupID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"padIDs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"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 all pads of this group",
"tags": [
"group"
]
},
"post": {
"operationId": "listPadsUsingPOST",
"parameters": [
{
"in": "query",
"name": "groupID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"padIDs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"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 all pads of this group",
"tags": [
"group"
]
}
},
"/listPadsOfAuthor": {
"get": {
"operationId": "listPadsOfAuthorUsingGET",
"parameters": [
{
"in": "query",
"name": "authorID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"padIDs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"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 an array of all pads this author contributed to",
"tags": [
"author"
]
},
"post": {
"operationId": "listPadsOfAuthorUsingPOST",
"parameters": [
{
"in": "query",
"name": "authorID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"padIDs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"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 an array of all pads this author contributed to",
"tags": [
"author"
]
}
},
"/listSavedRevisions": {
"get": {
"operationId": "listSavedRevisionsUsingGET",
"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": "listSavedRevisionsUsingPOST",
"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)"
}
}
}
},
"/listSessionsOfAuthor": {
"get": {
"operationId": "listSessionsOfAuthorUsingGET",
"parameters": [
{
"in": "query",
"name": "authorID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"sessions": {
"items": {
"properties": {
"authorID": {
"type": "string"
},
"groupID": {
"type": "string"
},
"id": {
"type": "string"
},
"validUntil": {
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"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 all sessions of an author",
"tags": [
"author"
]
},
"post": {
"operationId": "listSessionsOfAuthorUsingPOST",
"parameters": [
{
"in": "query",
"name": "authorID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"sessions": {
"items": {
"properties": {
"authorID": {
"type": "string"
},
"groupID": {
"type": "string"
},
"id": {
"type": "string"
},
"validUntil": {
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"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 all sessions of an author",
"tags": [
"author"
]
}
},
"/listSessionsOfGroup": {
"get": {
"operationId": "listSessionsOfGroupUsingGET",
"parameters": [
{
"in": "query",
"name": "groupID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"sessions": {
"items": {
"properties": {
"authorID": {
"type": "string"
},
"groupID": {
"type": "string"
},
"id": {
"type": "string"
},
"validUntil": {
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"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": [
"group"
]
},
"post": {
"operationId": "listSessionsOfGroupUsingPOST",
"parameters": [
{
"in": "query",
"name": "groupID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"sessions": {
"items": {
"properties": {
"authorID": {
"type": "string"
},
"groupID": {
"type": "string"
},
"id": {
"type": "string"
},
"validUntil": {
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"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": [
"group"
]
}
},
"/movePad": {
"get": {
"operationId": "movePadUsingGET",
"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": "movePadUsingPOST",
"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)"
}
}
}
},
"/padUsers": {
"get": {
"operationId": "padUsersUsingGET",
"parameters": [
{
"in": "query",
"name": "padID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"padUsers": {
"items": {
"properties": {
"colorId": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"timestamp": {
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"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 list of users that are currently editing this pad",
"tags": [
"pad"
]
},
"post": {
"operationId": "padUsersUsingPOST",
"parameters": [
{
"in": "query",
"name": "padID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"padUsers": {
"items": {
"properties": {
"colorId": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"timestamp": {
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"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 list of users that are currently editing this pad",
"tags": [
"pad"
]
}
},
"/padUsersCount": {
"get": {
"operationId": "padUsersCountUsingGET",
"parameters": [
{
"in": "query",
"name": "padID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"padUsersCount": {
"type": "integer"
}
},
"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 number of user that are currently editing this pad",
"tags": [
"pad"
]
},
"post": {
"operationId": "padUsersCountUsingPOST",
"parameters": [
{
"in": "query",
"name": "padID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 0,
"type": "integer"
},
"data": {
"properties": {
"padUsersCount": {
"type": "integer"
}
},
"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 number of user that are currently editing this pad",
"tags": [
"pad"
]
}
},
"/restoreRevision": {
"get": {
"operationId": "restoreRevisionUsingGET",
"parameters": [
{
"in": "query",
"name": "padID",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "rev",
"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": "restoreRevisionUsingPOST",
"parameters": [
{
"in": "query",
"name": "padID",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "rev",
"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)"
}
}
}
},
"/saveRevision": {
"get": {
"operationId": "saveRevisionUsingGET",
"parameters": [
{
"in": "query",
"name": "padID",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "rev",
"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": "saveRevisionUsingPOST",
"parameters": [
{
"in": "query",
"name": "padID",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "rev",
"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)"
}
}
}
},
"/sendClientsMessage": {
"get": {
"operationId": "sendClientsMessageUsingGET",
"parameters": [
{
"in": "query",
"name": "padID",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "msg",
"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": "sends a custom message of type msg to the pad",
"tags": [
"pad"
]
},
"post": {
"operationId": "sendClientsMessageUsingPOST",
"parameters": [
{
"in": "query",
"name": "padID",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "msg",
"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": "sends a custom message of type msg to the pad",
"tags": [
"pad"
]
}
},
"/setHTML": {
"get": {
"operationId": "setHTMLUsingGET",
"parameters": [
{
"in": "query",
"name": "padID",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "html",
"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": "sets the text of a pad with HTML",
"tags": [
"pad"
]
},
"post": {
"operationId": "setHTMLUsingPOST",
"parameters": [
{
"in": "query",
"name": "padID",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "html",
"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": "sets the text of a pad with HTML",
"tags": [
"pad"
]
}
},
"/setPublicStatus": {
"get": {
"operationId": "setPublicStatusUsingGET",
"parameters": [
{
"in": "query",
"name": "padID",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "publicStatus",
"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": "sets a boolean for the public status of a pad",
"tags": [
"pad"
]
},
"post": {
"operationId": "setPublicStatusUsingPOST",
"parameters": [
{
"in": "query",
"name": "padID",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "publicStatus",
"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": "sets a boolean for the public status of a pad",
"tags": [
"pad"
]
}
},
"/setText": {
"get": {
"operationId": "setTextUsingGET",
"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)"
}
},
"summary": "sets the text of a pad",
"tags": [
"pad"
]
},
"post": {
"operationId": "setTextUsingPOST",
"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)"
}
},
"summary": "sets the text of a pad",
"tags": [
"pad"
]
}
}
},
"components": {
"parameters": {
"authorID": {
"in": "query",
"name": "authorID",
"schema": {
"type": "string"
}
},
"authorMapper": {
"in": "query",
"name": "authorMapper",
"schema": {
"type": "string"
}
},
"destinationID": {
"in": "query",
"name": "destinationID",
"schema": {
"type": "string"
}
},
"end": {
"in": "query",
"name": "end",
"schema": {
"type": "string"
}
},
"endRev": {
"in": "query",
"name": "endRev",
"schema": {
"type": "string"
}
},
"force": {
"in": "query",
"name": "force",
"schema": {
"type": "string"
}
},
"groupID": {
"in": "query",
"name": "groupID",
"schema": {
"type": "string"
}
},
"groupMapper": {
"in": "query",
"name": "groupMapper",
"schema": {
"type": "string"
}
},
"html": {
"in": "query",
"name": "html",
"schema": {
"type": "string"
}
},
"msg": {
"in": "query",
"name": "msg",
"schema": {
"type": "string"
}
},
"name": {
"in": "query",
"name": "name",
"schema": {
"type": "string"
}
},
"padID": {
"in": "query",
"name": "padID",
"schema": {
"type": "string"
}
},
"padName": {
"in": "query",
"name": "padName",
"schema": {
"type": "string"
}
},
"publicStatus": {
"in": "query",
"name": "publicStatus",
"schema": {
"type": "string"
}
},
"rev": {
"in": "query",
"name": "rev",
"schema": {
"type": "string"
}
},
"roID": {
"in": "query",
"name": "roID",
"schema": {
"type": "string"
}
},
"sessionID": {
"in": "query",
"name": "sessionID",
"schema": {
"type": "string"
}
},
"sourceID": {
"in": "query",
"name": "sourceID",
"schema": {
"type": "string"
}
},
"start": {
"in": "query",
"name": "start",
"schema": {
"type": "string"
}
},
"startRev": {
"in": "query",
"name": "startRev",
"schema": {
"type": "string"
}
},
"text": {
"in": "query",
"name": "text",
"schema": {
"type": "string"
}
},
"time": {
"in": "query",
"name": "time",
"schema": {
"type": "string"
}
},
"validUntil": {
"in": "query",
"name": "validUntil",
"schema": {
"type": "string"
}
}
},
"responses": {
"ApiError": {
"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)"
},
"InternalError": {
"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)"
},
"NotFound": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"example": 3,
"type": "integer"
},
"data": {
"example": null,
"type": "object"
},
"message": {
"example": "no such function",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "no such function (code 4)"
},
"Success": {
"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)"
},
"Unauthorized": {
"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)"
}
},
"schemas": {
"Message": {
"properties": {
"text": {
"type": "string"
},
"time": {
"type": "integer"
},
"userId": {
"type": "string"
},
"userName": {
"type": "string"
}
},
"type": "object"
},
"SessionInfo": {
"properties": {
"authorID": {
"type": "string"
},
"groupID": {
"type": "string"
},
"id": {
"type": "string"
},
"validUntil": {
"type": "integer"
}
},
"type": "object"
},
"UserInfo": {
"properties": {
"colorId": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"timestamp": {
"type": "integer"
}
},
"type": "object"
}
},
"securitySchemes": {
"ApiKey": {
"in": "query",
"name": "apikey",
"type": "apiKey"
}
}
}
}