Skip to content

Commit

Permalink
Documented some undocumented related_list params
Browse files Browse the repository at this point in the history
  • Loading branch information
Sean Hammond committed Oct 15, 2012
1 parent 9ae6d0f commit b625eb5
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions ckan/logic/action/get.py
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,16 @@ def related_list(context, data_dict=None):
:type id: string
:param dataset: dataset dictionary of the dataset (optional)
:type dataset: dictionary
:param type_filter: the type of related item to show (optional,
default: None, show all items)
:type type_filter: string
:param sort: the order to sort the related items in, possible values are
'view_count_asc', 'view_count_desc', 'created_asc' or 'created_desc'
(optional)
:type sort: string
:param featured: whether or not to restrict the results to only featured
related items (optional, default: False)
:type featured: bool
:rtype: list of dictionaries
Expand Down

0 comments on commit b625eb5

Please sign in to comment.