aboutsummaryrefslogtreecommitdiff
path: root/docs_src/API/v1/repos.md
blob: f7bb5efb1294df0ec6958af1fc41730453523ba4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191

/repos

Method: GET

Description:
Retrieves a list of available repositories.

Parameters:
None

Response:

Code Description Schema
200 A list of repositories [Repository summary]
400-599 An error Error


/repos/:repo

Method: GET

Description:
Retrieves a repository.

Parameters:

Name Location Description Required Schema
repo path The repository true string

Response:

Code Description Schema
200 A repository Repository
400-599 An error Error


/repos/:repo/tree

Method: GET

Description:
Retrieves a repository's tree.

Parameters:

Name Location Description Required Schema
repo path The repository true string
path query Path in the tree false string
branch query A branch false string

Response:

Code Description Schema
200 A tree Tree
400-599 An error Error


/repos/:repo/tree/history

Method: GET

Description:
Retrieves a tree entry's commit history.

Parameters:

Name Location Description Required Schema
repo path The repository true string
path query Path in the tree true string
branch query A branch false string
count query Number of commits false number

Response:

Code Description Schema
200 The tree entry's commit history [Commit]
400-599 An error Error


/repos/:repo/tags

Method: GET

Description:
Retrieves a repository tag.

Parameters:

Name Location Description Required Schema
repo path The repository true string

Response:

Code Description Schema
200 A tag [Tag]
400-599 An error Error


/repos/:repo/log

Method: GET

Description:
Retrieves a repository's log.

Parameters:

Name Location Description Required Schema
repo path The repository true string
branch query A branch false string

Response:

Code Description Schema
200 A log commit [Log commit]
400-599 An error Error


/repos/:repo/log/:commit

Method: GET

Description:
Retrieves a commit from a repository.

Parameters:

Name Location Description Required Schema
repo path The repository true string
commit path A commit SHA true string

Response:

Code Description Schema
200 A commit Commit
400-599 An error Error


/repos/:repo/branches

Method: GET

Description:
Retrieves a repository's branches.

Parameters:

Name Location Description Required Schema
repo path The repository true string

Response:

Code Description Schema
200 A branch [Branch summary]
400-599 An error Error


/repos/:repo/branches/:branch

Method: GET

Description:
Retrieves a branch from a repository.

Parameters:

Name Location Description Required Schema
repo path The repository true string
branch path A branch true string

Response:

Code Description Schema
200 A branch Branch
400-599 An error Error