API: add project snippets listing

Nihad Abbasov
1 parent ad5b5d1e
Showing 4 changed files with 29 additions and 1 deletions Show diff stats
CHANGELOG
doc/api/snippets.md
lib/api/projects.rb
spec/requests/api/projects_spec.rb
 master
+  - [API] add project snippets list
   - [API] allow to authorize using private token in HTTP header
   - [API] add user creation
 ## List snippets
-Not implemented.
+Get a list of project snippets.
+
+```
+GET /projects/:id/snippets
+```
+
+Parameters:
+
++ `id` (required) - The ID or code name of a project
 ## Single snippet
@@ -228,6 +228,16 @@ module Gitlab
         present CommitDecorator.decorate(commits), with: Entities::RepoCommit
       end
+      # Get a project snippets
+      #
+      # Parameters:
+      #   id (required) - The ID or code name of a project
+      # Example Request:
+      #   GET /projects/:id/snippets
+      get ":id/snippets" do
+        present paginate(user_project.snippets), with: Entities::ProjectSnippet
+      end
+
       # Get a project snippet
       #
       # Parameters:
@@ -220,6 +220,15 @@ describe Gitlab::API do
     end
   end
+  describe "GET /projects/:id/snippets" do
+    it "should return a project snippet" do
+      get api("/projects/#{project.code}/snippets", user)
+      response.status.should == 200
+      json_response.should be_an Array
+      json_response.first['title'].should == snippet.title
+    end
+  end
+
   describe "GET /projects/:id/snippets/:snippet_id" do
     it "should return a project snippet" do
       get api("/projects/#{project.code}/snippets/#{snippet.id}", user)
1	master	1	master
		2	+ - [API] add project snippets list
2	- [API] allow to authorize using private token in HTTP header	3	- [API] allow to authorize using private token in HTTP header
3	- [API] add user creation	4	- [API] add user creation
4		5
1	## List snippets	1	## List snippets
2		2
3	-Not implemented.	3	+Get a list of project snippets.
		4	+
		5	+```
		6	+GET /projects/:id/snippets
		7	+```
		8	+
		9	+Parameters:
		10	+
		11	++ `id` (required) - The ID or code name of a project
4		12
5	## Single snippet	13	## Single snippet
6		14
	@@ -228,6 +228,16 @@ module Gitlab		@@ -228,6 +228,16 @@ module Gitlab
228	present CommitDecorator.decorate(commits), with: Entities::RepoCommit	228	present CommitDecorator.decorate(commits), with: Entities::RepoCommit
229	end	229	end
230		230
		231	+ # Get a project snippets
		232	+ #
		233	+ # Parameters:
		234	+ # id (required) - The ID or code name of a project
		235	+ # Example Request:
		236	+ # GET /projects/:id/snippets
		237	+ get ":id/snippets" do
		238	+ present paginate(user_project.snippets), with: Entities::ProjectSnippet
		239	+ end
		240	+
231	# Get a project snippet	241	# Get a project snippet
232	#	242	#
233	# Parameters:	243	# Parameters:
	@@ -220,6 +220,15 @@ describe Gitlab::API do		@@ -220,6 +220,15 @@ describe Gitlab::API do
220	end	220	end
221	end	221	end
222		222
		223	+ describe "GET /projects/:id/snippets" do
		224	+ it "should return a project snippet" do
		225	+ get api("/projects/#{project.code}/snippets", user)
		226	+ response.status.should == 200
		227	+ json_response.should be_an Array
		228	+ json_response.first['title'].should == snippet.title
		229	+ end
		230	+ end
		231	+
223	describe "GET /projects/:id/snippets/:snippet_id" do	232	describe "GET /projects/:id/snippets/:snippet_id" do
224	it "should return a project snippet" do	233	it "should return a project snippet" do
225	get api("/projects/#{project.code}/snippets/#{snippet.id}", user)	234	get api("/projects/#{project.code}/snippets/#{snippet.id}", user)