add a description to People API

Aurélio A. Heckert
1 parent 2077d2b6
Showing 1 changed file with 4 additions and 0 deletions Show diff stats
lib/noosfero/api/v1/people.rb
@@ -4,6 +4,8 @@ module Noosfero
       class People < Grape::API
         before { authenticate! }
  
+        desc 'API Root'
+
         resource :people do
  
           # -- A note about privacy --
@@ -26,6 +28,8 @@ module Noosfero
           # Example Request:
           #  GET /people?from=2013-04-04-14:41:43&until=2014-04-04-14:41:43&limit=10
           #  GET /people?reference_id=10&limit=10&oldest
+
+          desc "Find environment's people"
           get do
             people = select_filtered_collection_of(environment, 'people', params)
             people = people.visible_for_person(current_person)
...	...	@@ -4,6 +4,8 @@ module Noosfero
4	4	class People < Grape::API
5	5	before { authenticate! }
6	6
	7	+ desc 'API Root'
	8	+
7	9	resource :people do
8	10
9	11	# -- A note about privacy --
...	...	@@ -26,6 +28,8 @@ module Noosfero
26	28	# Example Request:
27	29	# GET /people?from=2013-04-04-14:41:43&until=2014-04-04-14:41:43&limit=10
28	30	# GET /people?reference_id=10&limit=10&oldest
	31	+
	32	+ desc "Find environment's people"
29	33	get do
30	34	people = select_filtered_collection_of(environment, 'people', params)
31	35	people = people.visible_for_person(current_person)
...	...