0x2620/pandora
2
1
Fork 1
Code Issues 1.3k Pull requests Releases Wiki Activity

update api docs (omissions, wording, typos)

Browse source
This commit is contained in:
rolux 2014-12-21 13:03:49 +00:00
parent 8b6b23eaf5
commit ea1a94e9e4
7 changed files with 8 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
pandora/archive/views.py
View file

@ -341,7 +341,7 @@ def direct_upload(request):
@login_required_json @login_required_json
def taskStatus(request, data): def taskStatus(request, data):
''' '''
Gets the status for a task Gets the status for a given task
takes { takes {
taskId: string // taskId taskId: string // taskId
} }

2
pandora/document/views.py
View file

@ -247,7 +247,7 @@ actions.register(removeDocument, cache=False)
@login_required_json @login_required_json
def sortDocuments(request, data): def sortDocuments(request, data):
''' '''
Sets the sort order for the documents related to a given item Sets the sort order for the documents associated with a given item
takes { takes {
item: string, // item id item: string, // item id
ids: [string] // ordered list of document ids ids: [string] // ordered list of document ids

3
pandora/edit/views.py
View file

@ -200,7 +200,7 @@ def _order_clips(edit, sort):
def sortClips(request, data): def sortClips(request, data):
''' '''
Updates sort order of clips within an edit Updates the sort order of clips within an edit
takes { takes {
edit: string, // edit id edit: string, // edit id
sort: object // sort sort: object // sort
@ -480,6 +480,7 @@ actions.register(unsubscribeFromEdit, cache=False)
@login_required_json @login_required_json
def sortEdits(request, data): def sortEdits(request, data):
''' '''
Sets the order of edits in a given section
takes { takes {
section: string, // 'personal', 'favorite' or 'featured' section: string, // 'personal', 'favorite' or 'featured'
ids: [string] // ordered list of edit ids ids: [string] // ordered list of edit ids

2
pandora/itemlist/views.py
View file

@ -192,7 +192,7 @@ actions.register(removeListItems, cache=False)
@login_required_json @login_required_json
def orderListItems(request, data): def orderListItems(request, data):
''' '''
Sets the manual orderings of items in a given list Sets the manual ordering of items in a given list
takes { takes {
list: string, // list id list: string, // list id
ids: [string] // ordered list of item ids ids: [string] // ordered list of item ids

2
pandora/text/views.py
View file

@ -311,7 +311,7 @@ actions.register(unsubscribeFromText, cache=False)
@login_required_json @login_required_json
def sortTexts(request, data): def sortTexts(request, data):
''' '''
Sets manual ordering of texts in a given folder Sets the order of texts in a given section
takes { takes {
section: string, // 'personal', 'favorite' or 'featured' section: string, // 'personal', 'favorite' or 'featured'
ids: [string] // ordered list of text ids ids: [string] // ordered list of text ids

2
pandora/tv/views.py
View file

@ -11,7 +11,7 @@ from ox.django.api import actions
def tv(request, data): def tv(request, data):
''' '''
Gets TV program for a given list Gets the current TV program for a given list
takes { takes {
list: string // list name list: string // list name
} }

2
pandora/user/views.py
View file

@ -213,7 +213,7 @@ actions.register(signup, cache=False)
def resetPassword(request, data): def resetPassword(request, data):
''' '''
Resets password for a given user Resets the password for a given user
takes { takes {
username: string, // username username: string, // username
password: string, // password password: string, // password