Skip to content
This repository was archived by the owner on Jan 30, 2018. It is now read-only.

Commit 776e140

Browse files
committed
Wrap the example #indexes in the apidocs. Also include the api include[] API.
1 parent 50cd73a commit 776e140

39 files changed

+156
-89
lines changed

app/controllers/api_v1/activities_controller.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ def show
2020
end
2121

2222
if current_user.project_ids.include? @activity.project_id
23-
api_respond @activity, :include => [:project, :target, :users]
23+
api_respond @activity, :include => [:project, :target, :user]
2424
else
2525
api_status :unauthorized
2626
end

app/controllers/api_v1/comments_controller.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ def index
88
end
99

1010
def show
11-
api_respond @comment
11+
api_respond @comment, :include => [:user]
1212
end
1313

1414
def create

app/controllers/api_v1/conversations_controller.rb

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ def index
99
end
1010

1111
def show
12-
api_respond @conversation, :include => [:comments, :users]
12+
api_respond @conversation, :include => api_include
1313
end
1414

1515
def create
@@ -91,5 +91,9 @@ def add_watchers(hash)
9191
end
9292
end
9393
end
94+
95+
def api_include
96+
[:comments, :user] & (params[:include]||{}).map(&:to_sym)
97+
end
9498

9599
end

app/controllers/api_v1/dividers_controller.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ def index
1010
end
1111

1212
def show
13-
api_respond @divider
13+
api_respond @divider, :include => [:page_slot]
1414
end
1515

1616
def create

app/controllers/api_v1/invitations_controller.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ def index
1111
end
1212

1313
def show
14-
api_respond @invitation
14+
api_respond @invitation, :include => [:project, :user]
1515
end
1616

1717
def create

app/controllers/api_v1/memberships_controller.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ def index
99
end
1010

1111
def show
12-
api_respond @membership, :include => [:projects, :members, :people]
12+
api_respond @membership, :include => [:user]
1313
end
1414

1515
def update

app/controllers/api_v1/notes_controller.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ def index
1010
end
1111

1212
def show
13-
api_respond @note
13+
api_respond @note, :include => [:page_slot]
1414
end
1515

1616
def create

app/controllers/api_v1/organizations_controller.rb

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ class ApiV1::OrganizationsController < ApiV1::APIController
55

66
def index
77
@organizations = current_user.organizations
8-
api_respond current_user.organizations, :include => [:projects, :members], :references => []
8+
api_respond current_user.organizations, :references => []
99
end
1010

1111
def show
12-
api_respond @organization, :include => [:projects, :members, :people]
12+
api_respond @organization, :include => api_include
1313
end
1414

1515
def create
@@ -51,4 +51,8 @@ def can_modify?
5151
end
5252
end
5353

54+
def api_include
55+
[:projects, :members] & (params[:include]||{}).map(&:to_sym)
56+
end
57+
5458
end

app/controllers/api_v1/pages_controller.rb

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,9 @@ class ApiV1::PagesController < ApiV1::APIController
33
before_filter :check_permissions, :only => [:create,:update,:reorder,:resort,:destroy]
44

55
def index
6-
@pages = if @current_project
7-
@current_project.pages.all(:conditions => api_range, :limit => api_limit, :order => 'id ASC', :include => [:project, :user])
8-
else
9-
Page.find_all_by_project_id(current_user.project_ids, :conditions => api_range, :limit => api_limit, :include => [:project, :user])
10-
end
6+
@pages = @current_project.pages.all(:conditions => api_range, :limit => api_limit, :order => 'id ASC', :include => [:project, :user])
117

12-
api_respond @pages, :include => :slots, :references => [:project, :user]
8+
api_respond @pages, :include => :slots, :references => [:user]
139
end
1410

1511
def create

app/controllers/api_v1/people_controller.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ class ApiV1::PeopleController < ApiV1::APIController
55
def index
66
@people = @current_project.people(:include => [:project, :user])
77

8-
api_respond @people, :include => [:project, :user], :references => [:project, :user]
8+
api_respond @people, :references => [:user]
99
end
1010

1111
def show
12-
api_respond @person
12+
api_respond @person, :include => [:user]
1313
end
1414

1515
def update

0 commit comments

Comments
 (0)