Skip to content

Instantly share code, notes, and snippets.

@tomnomnom

tomnomnom/spec-1.2.7.json

Created February 19, 2013 14:15
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save tomnomnom/4986279 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save tomnomnom/4986279 to your computer and use it in GitHub Desktop.
Download ZIP
Example Etherpad Lite API spec file
Raw
spec-1.2.7.json
{
"version": "1.2.7",
"methods": [
{
"name": "createGroup",
"httpMethod": "POST",
"arguments": [
]
},
{
"name": "createGroupIfNotExistsFor",
"httpMethod": "POST",
"arguments": [
{
"name": "groupMapper",
"type": "string",
"required": true
}
]
},
{
"name": "deleteGroup",
"httpMethod": "POST",
"arguments": [
{
"name": "groupID",
"type": "string",
"required": true
}
]
},
{
"name": "listPads",
"httpMethod": "GET",
"arguments": [
{
"name": "groupID",
"type": "string",
"required": true
}
]
},
{
"name": "listAllPads",
"httpMethod": "GET",
"arguments": [
]
},
{
"name": "createDiffHTML",
"httpMethod": "POST",
"arguments": [
{
"name": "padID",
"type": "string",
"required": true
},
{
"name": "startRev",
"type": "string",
"required": true
},
{
"name": "endRev",
"type": "string",
"required": true
}
]
},
{
"name": "createPad",
"httpMethod": "POST",
"arguments": [
{
"name": "padID",
"type": "string",
"required": true
},
{
"name": "text",
"type": "string",
"required": true
}
]
},
{
"name": "createGroupPad",
"httpMethod": "POST",
"arguments": [
{
"name": "groupID",
"type": "string",
"required": true
},
{
"name": "padName",
"type": "string",
"required": true
},
{
"name": "text",
"type": "string",
"required": true
}
]
},
{
"name": "createAuthor",
"httpMethod": "POST",
"arguments": [
{
"name": "name",
"type": "string",
"required": true
}
]
},
{
"name": "createAuthorIfNotExistsFor",
"httpMethod": "POST",
"arguments": [
{
"name": "authorMapper",
"type": "string",
"required": true
},
{
"name": "name",
"type": "string",
"required": true
}
]
},
{
"name": "listPadsOfAuthor",
"httpMethod": "GET",
"arguments": [
{
"name": "authorID",
"type": "string",
"required": true
}
]
},
{
"name": "createSession",
"httpMethod": "POST",
"arguments": [
{
"name": "groupID",
"type": "string",
"required": true
},
{
"name": "authorID",
"type": "string",
"required": true
},
{
"name": "validUntil",
"type": "string",
"required": true
}
]
},
{
"name": "deleteSession",
"httpMethod": "POST",
"arguments": [
{
"name": "sessionID",
"type": "string",
"required": true
}
]
},
{
"name": "getSessionInfo",
"httpMethod": "GET",
"arguments": [
{
"name": "sessionID",
"type": "string",
"required": true
}
]
},
{
"name": "listSessionsOfGroup",
"httpMethod": "GET",
"arguments": [
{
"name": "groupID",
"type": "string",
"required": true
}
]
},
{
"name": "listSessionsOfAuthor",
"httpMethod": "GET",
"arguments": [
{
"name": "authorID",
"type": "string",
"required": true
}
]
},
{
"name": "getText",
"httpMethod": "GET",
"arguments": [
{
"name": "padID",
"type": "string",
"required": true
},
{
"name": "rev",
"type": "string",
"required": true
}
]
},
{
"name": "setText",
"httpMethod": "POST",
"arguments": [
{
"name": "padID",
"type": "string",
"required": true
},
{
"name": "text",
"type": "string",
"required": true
}
]
},
{
"name": "getHTML",
"httpMethod": "GET",
"arguments": [
{
"name": "padID",
"type": "string",
"required": true
},
{
"name": "rev",
"type": "string",
"required": true
}
]
},
{
"name": "setHTML",
"httpMethod": "POST",
"arguments": [
{
"name": "padID",
"type": "string",
"required": true
},
{
"name": "html",
"type": "string",
"required": true
}
]
},
{
"name": "getRevisionsCount",
"httpMethod": "GET",
"arguments": [
{
"name": "padID",
"type": "string",
"required": true
}
]
},
{
"name": "getLastEdited",
"httpMethod": "GET",
"arguments": [
{
"name": "padID",
"type": "string",
"required": true
}
]
},
{
"name": "deletePad",
"httpMethod": "POST",
"arguments": [
{
"name": "padID",
"type": "string",
"required": true
}
]
},
{
"name": "getReadOnlyID",
"httpMethod": "GET",
"arguments": [
{
"name": "padID",
"type": "string",
"required": true
}
]
},
{
"name": "setPublicStatus",
"httpMethod": "POST",
"arguments": [
{
"name": "padID",
"type": "string",
"required": true
},
{
"name": "publicStatus",
"type": "string",
"required": true
}
]
},
{
"name": "getPublicStatus",
"httpMethod": "GET",
"arguments": [
{
"name": "padID",
"type": "string",
"required": true
}
]
},
{
"name": "setPassword",
"httpMethod": "POST",
"arguments": [
{
"name": "padID",
"type": "string",
"required": true
},
{
"name": "password",
"type": "string",
"required": true
}
]
},
{
"name": "isPasswordProtected",
"httpMethod": "GET",
"arguments": [
{
"name": "padID",
"type": "string",
"required": true
}
]
},
{
"name": "listAuthorsOfPad",
"httpMethod": "GET",
"arguments": [
{
"name": "padID",
"type": "string",
"required": true
}
]
},
{
"name": "padUsersCount",
"httpMethod": "GET",
"arguments": [
{
"name": "padID",
"type": "string",
"required": true
}
]
},
{
"name": "getAuthorName",
"httpMethod": "GET",
"arguments": [
{
"name": "authorID",
"type": "string",
"required": true
}
]
},
{
"name": "padUsers",
"httpMethod": "GET",
"arguments": [
{
"name": "padID",
"type": "string",
"required": true
}
]
},
{
"name": "sendClientsMessage",
"httpMethod": "GET",
"arguments": [
{
"name": "padID",
"type": "string",
"required": true
},
{
"name": "msg",
"type": "string",
"required": true
}
]
},
{
"name": "listAllGroups",
"httpMethod": "GET",
"arguments": [
]
},
{
"name": "checkToken",
"httpMethod": "GET",
"arguments": [
]
},
{
"name": "getChatHistory",
"httpMethod": "GET",
"arguments": [
{
"name": "padID",
"type": "string",
"required": true
},
{
"name": "start",
"type": "string",
"required": true
},
{
"name": "end",
"type": "string",
"required": true
}
]
},
{
"name": "getChatHead",
"httpMethod": "GET",
"arguments": [
{
"name": "padID",
"type": "string",
"required": true
}
]
}
]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment