Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Léo-Paul Géneau
gitlab-ce
Commits
da6f4f06
Commit
da6f4f06
authored
Jun 06, 2013
by
Dmitriy Zaporozhets
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
API: implement retrieve of repository tree
parent
470f9064
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
98 additions
and
0 deletions
+98
-0
doc/api/repositories.md
doc/api/repositories.md
+50
-0
lib/api/repositories.rb
lib/api/repositories.rb
+25
-0
spec/requests/api/repositories_spec.rb
spec/requests/api/repositories_spec.rb
+23
-0
No files found.
doc/api/repositories.md
View file @
da6f4f06
...
...
@@ -239,6 +239,56 @@ Parameters:
]
```
## List repository tree
Get a list of repository files and directories in a project.
```
GET /projects/:id/repository/tree
```
Parameters:
+
`id`
(required) - The ID of a project
+
`path`
(optional) - The path inside repository. Used to get contend of subdirectories
+
`ref_name`
(optional) - The name of a repository branch or tag or if not given the default branch
```
json
[{
"name"
:
"assets"
,
"type"
:
"tree"
,
"mode"
:
"040000"
,
"id"
:
"6229c43a7e16fcc7e95f923f8ddadb8281d9c6c6"
},
{
"name"
:
"contexts"
,
"type"
:
"tree"
,
"mode"
:
"040000"
,
"id"
:
"faf1cdf33feadc7973118ca42d35f1e62977e91f"
},
{
"name"
:
"controllers"
,
"type"
:
"tree"
,
"mode"
:
"040000"
,
"id"
:
"95633e8d258bf3dfba3a5268fb8440d263218d74"
},
{
"name"
:
"Rakefile"
,
"type"
:
"blob"
,
"mode"
:
"100644"
,
"id"
:
"35b2f05cbb4566b71b34554cf184a9d0bd9d46d6"
},
{
"name"
:
"VERSION"
,
"type"
:
"blob"
,
"mode"
:
"100644"
,
"id"
:
"803e4a4f3727286c3093c63870c2b6524d30ec4f"
},
{
"name"
:
"config.ru"
,
"type"
:
"blob"
,
"mode"
:
"100644"
,
"id"
:
"dfd2d862237323aa599be31b473d70a8a817943b"
}]
```
## Raw blob content
...
...
lib/api/repositories.rb
View file @
da6f4f06
...
...
@@ -102,6 +102,31 @@ module API
present
commits
,
with:
Entities
::
RepoCommit
end
# Get a project repository tree
#
# Parameters:
# id (required) - The ID of a project
# ref_name (optional) - The name of a repository branch or tag, if not given the default branch is used
# Example Request:
# GET /projects/:id/repository/tree
get
":id/repository/tree"
do
authorize!
:download_code
,
user_project
ref
=
params
[
:ref_name
]
||
user_project
.
try
(
:default_branch
)
||
'master'
path
=
params
[
:path
]
||
nil
commit
=
user_project
.
repository
.
commit
(
ref
)
tree
=
Tree
.
new
(
user_project
.
repository
,
commit
.
id
,
ref
,
path
)
trees
=
[]
%w(trees blobs submodules)
.
each
do
|
type
|
trees
+=
tree
.
send
(
type
).
map
{
|
t
|
{
name:
t
.
name
,
type:
type
.
singularize
,
mode:
t
.
mode
,
id:
t
.
id
}
}
end
trees
end
# Get a raw file contents
#
# Parameters:
...
...
spec/requests/api/repositories_spec.rb
View file @
da6f4f06
...
...
@@ -111,6 +111,29 @@ describe API::API do
end
end
describe
"GET /projects/:id/repository/tree"
do
context
"authorized user"
do
before
{
project
.
team
<<
[
user2
,
:reporter
]
}
it
"should return project commits"
do
get
api
(
"/projects/
#{
project
.
id
}
/repository/tree"
,
user
)
response
.
status
.
should
==
200
json_response
.
should
be_an
Array
json_response
.
first
[
'name'
].
should
==
'app'
json_response
.
first
[
'type'
].
should
==
'tree'
json_response
.
first
[
'mode'
].
should
==
'040000'
end
end
context
"unauthorized user"
do
it
"should not return project commits"
do
get
api
(
"/projects/
#{
project
.
id
}
/repository/tree"
)
response
.
status
.
should
==
401
end
end
end
describe
"GET /projects/:id/repository/commits/:sha/blob"
do
it
"should get the raw file contents"
do
get
api
(
"/projects/
#{
project
.
id
}
/repository/commits/master/blob?filepath=README.md"
,
user
)
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment