Skip to content

typo fixes #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tochev wants to merge 1 commit into
base: master
Choose a base branch
from
Open

typo fixes #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 10 additions & 14 deletions api.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ so that cookie with some name will override the same GET parameter).
Response is normally JSON array with multiple fields. The key "result" is
always present. Normally result:0 means success while a non-zero result means
an error. A non-zero result also sets the "error" key with an error message.
Error codes passed by result can be seen in ERRORS array of settings.lua.
Error codes passed by result can be seen in errors.txt
When there is an error HTTP header "X-Error: xxxx" is sent with the error code.

On a single connection (i.e. keep-alive connection) you need to authenticate
Expand Down Expand Up @@ -103,7 +103,7 @@ to 64K and DOES NOT include the length of the data that may be present.
The first byte of the request gives the length of the name of the
method - method_len (bits 0-6) and indicates if the request has data (bit 7).
If the highest bit(7) is set, than the following 8 bytes represent 64 bit
number, that is thelength of the data that comes immediately after the request.
number, that is the length of the data that comes immediately after the request.
The next method_len bytes are the name of the method to be called.

The following one byte represent 8 bit number containing the number of
Expand Down Expand Up @@ -144,7 +144,7 @@ hash (like JSON object)
data

For each value, the first byte represent the type of the value. Since the
response is highly compressed, each valuetype can have multiple types:
response is highly compressed, each value type can have multiple types:

Strings:
String values can be reused values (pointer to a string value already sent)
Expand Down Expand Up @@ -446,17 +446,13 @@ processing any login parameters. In order to switch the logged user on a
connection both logout and any form of authentication should be present.

username/password -
username/passwordmd5 -
username/passworddigest/digest - General authentication methods.

Username and password are self-explanatory.

Username and passwordmd5 are the username and a plain md5() of the password, in hex,
lowercase.

Username and passworddigest/digest - you first need to call the "getdigest", and
then generate password digest by calculating md5 of the password, concatenated
with the received digest, in hex, lowercase.
then generate password digest by calculating sha1 of the password, concatenated
with the lowercased username and the received digest, in hex, lowercase.


ERRORS
Expand Down Expand Up @@ -846,7 +842,7 @@ On success it returns:
preferably in a single transaction with the event itself.
Each object will have at least keys "event", "time" and "diffid". In most
cases also "metadata" will be provided. "time" is the timestamp of the
event, "diffid" is the event's identificator. It can be used to request
event, "diffid" is the event's identifier. It can be used to request
updates since this event. Normally diffids are incrementing integers, but
one can not assume that ids are consecutive as events that cancel each other
(e.g. createfolder, deletefolder) are not displayed if they happen to be in
Expand Down Expand Up @@ -921,7 +917,7 @@ For shares, a "share" object is provided with keys:

"time" of the event is the time of the event - even if the event is
"createfolder", "time" is not guaranteed to be the folder's creation time.
The folder might be somebody elses folder,created an year ago, that was just
The folder might be somebody else's folder,created an year ago, that was just
shared with you.

!!!IMPORTANT!!! When a folder/file is created/delete/moved in or out of a
Expand Down Expand Up @@ -954,7 +950,7 @@ then resized to 128x128. To create a rectangular thumb from 4:3 image exactly
1/8 is cropped from each side. By default the thumbnail is in jpeg format.
If the "type" parameter is set to png, a png image will be produced. On success
the same data as with "getfilelink" is returned, additionally the real image
produced "size" is returned, it will match reqested "size" if "crop" is
produced "size" is returned, it will match requested "size" if "crop" is
specified or may differ otherwise.

Thumbs are created on first request and cached for unspecified amount of time
Expand Down Expand Up @@ -1349,7 +1345,7 @@ and cannot be all consecutive letters from a standard keyboard (no "qwerty"
or "poiuyt"). Also the password can not start or end with whitespace.

* lostpassword, auth: no - takes as a parameter user's 'mail' and sends to this
email address insertuctions and link to reset user's password. A successful
email address instructions and link to reset user's password. A successful
reply is sent even if there is no user of the system with 'mail' for security
reasons.

Expand All @@ -1361,7 +1357,7 @@ The new password is subject to the same checks as in changepassword.
MUST be set to 'yes' if the user accepted terms of service and other
agreements. 'mail' should be user's email address and 'password' - to the user's
chosen password. Optionally 'language' SHOULD be set to one of the supported
languages and 'referer' SHOULD be the userid of the refering user. For the
languages and 'referer' SHOULD be the userid of the referring user. For the
password requirements see 'changepassword'.

* invite, auth: yes - returns 'url' of registration page with a referrer code
Expand Down
32 changes: 16 additions & 16 deletions errors.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Error codes:
2001 Invalid file/folder name.
2002 A component of parent directory does not exist.
2003 Access denied. You do not have permissions to preform this operation.
2004 File or folder alredy exists.
2004 File or folder already exists.
2005 Directory does not exist.
2006 Folder is not empty.
2007 Cannot delete the root folder.
Expand Down Expand Up @@ -89,7 +89,7 @@ Error codes:
2042 Cannot rename the root folder.
2043 Cannot move a folder to a subfolder of itself.
2044 Video links can only be generated for videos.
3000 SSL error occured. Check sslerror for more information.
3000 SSL error occurred. Check sslerror for more information.
3001 Could not create thumb from the given file.
3002 Connection to iTunes failed.
3003 iTunes error.
Expand All @@ -102,7 +102,7 @@ Error codes:
6000 Not modified
7001 Invalid link 'code'.
7002 This link is deleted by the owner.
7003 This link is deleted bacause of copyright complaint.
7003 This link is deleted because of copyright complaint.
7004 This link has expired.
7005 This link has reached its traffic limit.
7006 This link has reached maximum downloads.
Expand Down Expand Up @@ -207,7 +207,7 @@ Error codes and who throws them:
getaudiolink, getvideolink, getpublinkdownload, getpubthumblink, getthumb, getpubaudiolink, savepubthumb, deletefile, revertrevision, acceptshare, listrevisions, copypubfile, copytolink, renamefile, getfilelink, savezip, getpubthumb, getthumblink, copyfile, checksumfile, gethlslink, file_open, savepubzip, createfolder, savethumb, getfilepublink
2003 Access denied. You do not have permissions to preform this operation.
getaudiolink, deletefolder, getvideolink, file_pwrite, getthumb, savepubthumb, deletefile, revertrevision, listrevisions, copypubfile, copytolink, file_write, renamefile, getfilelink, savezip, getthumblink, renamefolder, copyfile, checksumfile, gethlslink, uploadfile, file_open, savepubzip, createfolder, savethumb, listfolder, downloadfile
2004 File or folder alredy exists.
2004 File or folder already exists.
savepubthumb, copypubfile, savezip, renamefolder, copyfile, file_open, savepubzip, createfolder, savethumb
2005 Directory does not exist.
deletefolder, renamefile, createuploadlink, renamefolder, uploadfile, getfolderpublink, sharefolder, listfolder, downloadfile
Expand Down Expand Up @@ -288,7 +288,7 @@ Error codes and who throws them:
renamefolder
2044 Video links can only be generated for videos.
getaudiolink, getvideolink, getpubaudiolink, gethlslink
3000 SSL error occured. Check sslerror for more information.
3000 SSL error occurred. Check sslerror for more information.
getcertificate
3001 Could not create thumb from the given file.
getpubthumblink, getthumb, savepubthumb, getpubthumb, getthumblink, savethumb
Expand All @@ -314,7 +314,7 @@ Error codes and who throws them:
getpubziplink, getpublinkdownload, getpubthumblink, getpubaudiolink, savepubthumb, copypubfile, getpubthumb, savepubzip, showpublink, getpubzip, getpubthumbslinks
7002 This link is deleted by the owner.
getpubziplink, getpublinkdownload, getpubthumblink, getpubaudiolink, savepubthumb, copypubfile, copytolink, getpubthumb, savepubzip, showpublink, uploadtolink, getpubzip, showuploadlink, getpubthumbslinks
7003 This link is deleted bacause of copyright complaint.
7003 This link is deleted because of copyright complaint.
7004 This link has expired.
getpubziplink, getpublinkdownload, getpubthumblink, getpubaudiolink, savepubthumb, copypubfile, copytolink, getpubthumb, savepubzip, showpublink, uploadtolink, getpubzip, showuploadlink, getpubthumbslinks
7005 This link has reached its traffic limit.
Expand Down Expand Up @@ -523,7 +523,7 @@ savepubthumb
2001 Invalid file/folder name.
2002 A component of parent directory does not exist.
2003 Access denied. You do not have permissions to preform this operation.
2004 File or folder alredy exists.
2004 File or folder already exists.
2008 User is over quota.
2009 File not found.
3001 Could not create thumb from the given file.
Expand Down Expand Up @@ -627,7 +627,7 @@ copypubfile
2001 Invalid file/folder name.
2002 A component of parent directory does not exist.
2003 Access denied. You do not have permissions to preform this operation.
2004 File or folder alredy exists.
2004 File or folder already exists.
2008 User is over quota.
2009 File not found.
2010 Invalid path.
Expand Down Expand Up @@ -749,7 +749,7 @@ savezip
2001 Invalid file/folder name.
2002 A component of parent directory does not exist.
2003 Access denied. You do not have permissions to preform this operation.
2004 File or folder alredy exists.
2004 File or folder already exists.
2008 User is over quota.
2009 File not found.
4000 Too many login tries from this IP address.
Expand Down Expand Up @@ -803,7 +803,7 @@ renamefolder
2000 Log in failed.
2001 Invalid file/folder name.
2003 Access denied. You do not have permissions to preform this operation.
2004 File or folder alredy exists.
2004 File or folder already exists.
2005 Directory does not exist.
2008 User is over quota.
2023 You are trying to place shared folder into another shared folder.
Expand All @@ -819,7 +819,7 @@ copyfile
2001 Invalid file/folder name.
2002 A component of parent directory does not exist.
2003 Access denied. You do not have permissions to preform this operation.
2004 File or folder alredy exists.
2004 File or folder already exists.
2008 User is over quota.
2009 File not found.
2010 Invalid path.
Expand Down Expand Up @@ -902,7 +902,7 @@ file_open
2001 Invalid file/folder name.
2002 A component of parent directory does not exist.
2003 Access denied. You do not have permissions to preform this operation.
2004 File or folder alredy exists.
2004 File or folder already exists.
2008 User is over quota.
2009 File not found.
2010 Invalid path.
Expand All @@ -919,7 +919,7 @@ savepubzip
2001 Invalid file/folder name.
2002 A component of parent directory does not exist.
2003 Access denied. You do not have permissions to preform this operation.
2004 File or folder alredy exists.
2004 File or folder already exists.
2008 User is over quota.
4000 Too many login tries from this IP address.
5000 Internal error. Try again later.
Expand Down Expand Up @@ -973,7 +973,7 @@ createfolder
2001 Invalid file/folder name.
2002 A component of parent directory does not exist.
2003 Access denied. You do not have permissions to preform this operation.
2004 File or folder alredy exists.
2004 File or folder already exists.
4000 Too many login tries from this IP address.
5000 Internal error. Try again later.
savethumb
Expand All @@ -986,7 +986,7 @@ savethumb
2001 Invalid file/folder name.
2002 A component of parent directory does not exist.
2003 Access denied. You do not have permissions to preform this operation.
2004 File or folder alredy exists.
2004 File or folder already exists.
2008 User is over quota.
2009 File not found.
2010 Invalid path.
Expand Down Expand Up @@ -1132,7 +1132,7 @@ getcertificate
1000 Log in required.
1003 Neither csr or publickey is provided. Please create Certificate Signing Request and pass it as 'csr' parameter or send your 'publickey'.
2000 Log in failed.
3000 SSL error occured. Check sslerror for more information.
3000 SSL error occurred. Check sslerror for more information.
4000 Too many login tries from this IP address.
changeuploadlink
1000 Log in required.
Expand Down