sr.ht-docs/git.sr.ht/api.md -rw-r--r-- 9.0 KiB View raw
                                                                                
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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
---
title: git.sr.ht API reference
---

The git.sr.ht API allows you to browse, create, and manage repositories on
git.sr.ht programmatically. This API follows the [standard sourcehut API
conventions](../api-conventions.md).

## Authentication

Authentication is done via the [meta.sr.ht OAuth
flow](https://man.sr.ht/meta.sr.ht/oauth-api.md). The following OAuth scopes are
available for git.sr.ht:

- **info:read**, **info:write**: read & write repository details
- **access:read**, **access:write**: read & write access control lists
- **data:read**: read git data

## Git protocols

The high and low-level data endpoints are basic and provided as a convenience.
For write operations or more complex read operations, we recommend using the
git interface. git.sr.ht supports the [smart protocol][protocols] over HTTPS
(read-only) and SSH (read/write).

[protocols]: https://git-scm.com/book/en/v2/Git-Internals-Transfer-Protocols

## Resources

### Commit resource

```json
{
  "id": "sha-1 hash",
  "short_id": "truncated hash",
  "author": {
    "email": "email address",
    "name": "author name"
  },
  "committer": {
    "email": "email address",
    "name": "committer name"
  },
  "timestamp": "timestamp",
  "message": "commit message",
  "tree": "tree ID (sha-1 hash)",
  "parents": [ list of parent IDs (string, sha-1 hash) ],
  "signature": {
    "signature": "base64 encoded PGP signature",
    "data": "base64 encoded signed payload"
  } or null
}
```

### Tree resource

```json
{
  "id": "sha-1 hash",
  "short_id": "truncated hash",
  "entries": [
    {
      "name": "entry name",
      "id": "sha-1 hash",
      "type": "tree" | "blob",
      "mode": unix file mode
    }
  ]
}
```

### Reference resource

```json
{
  "name": "name of reference (e.g. refs/heads/master)",
  "target": "reference target (sha-1 hash)"
}
```

### Repository resource

```json
{
  "id": integer,
  "created": "timestamp",
  "subject": "message subject",
  "name": "repository name",
  "description": "repository description (markdown)",
  "visibility": "public" | "unlisted" | "private"
}
```

## Endpoints

**Note**: usernames are prefixed with `~`.

### GET /api/user/:username

Retrieves a user resource.

### GET /api/user

Equivalent to [/api/user/:username](#GET-apiuserusername), implies the authenticated
user.

### GET /api/:username/repos

List of [repository resources](#repository-resource) owned by this user.

**OAuth scope**: `info:read`

### GET /api/repos

Equivalent to [/api/:username/repos](#GET-apiusernamerepos), implies the
authenticated user.

### POST /api/repos

Creates a new [repository resource](#repository-resource).

**OAuth scope**: `info:write`

**Request body**

```json
{
  "name": "repository name",
  "description": "repository description (markdown)" (optional)
  "visibility": "public" | "unlisted" | "private" (optional: default public)
}
```

**Response**

The new [repository resource](#repository-resource)

### GET /api/:username/repos/:name

Retrieves a [repository resource](#repository-resource).

**OAuth scope**: `info:read`

### GET /api/repos/:name

Equivalent to [/api/:username/repos/:name](#GET-apiusernamereposname), implies
the authenticated user.

### PUT /api/repos/:name

Updates a [repository resource](#repository-resource).

**OAuth scope**: `info:write`

**Request body**

```json
{
  "name": "repository name" (optional),
  "description": "repository description (markdown)" (optional),
  "visibility": "public" | "unlisted" | "private" (optional)
}
```

**Notes**

- Updating the name will create a redirect.

### DELETE /api/repos/:name

Deletes a [repository resource](#repository-resource).

**OAuth scope**: `info:write`

## Common data endpoints

Endpoints for fetching git data from repos.

### GET /api/:username/repos/:name/refs

List of [reference resources](#reference-resource) in this git repository.

**OAuth scope**: `data:read`

### GET /api/repos/:name/refs

Equivalent to [/api/:username/repos/refs](#GET-apiusernamereposnamerefs),
implies the authenticated user.

### GET /api/:username/repos/:name/log

List of the latest [commit resources](#commit-resource) on the default branch.

**OAuth scope**: `data:read`

### GET /api/repos/:name/log

Equivalent to [/api/:username/repos/:name/log](#GET-apiusernamereposnamelog),
implies the authenticated user.

### GET /api/:username/repos/:name/log/:ref

List of the latest [commit resources](#commit-resource) starting from the given
reference (sha-1 ID or name).

**OAuth scope**: `data:read`

### GET /api/repos/:name/log/:ref

Equivalent to [/api/:username/repos/:name/log/:ref](#GET-apiusernamereposnamelogref),
implies the authenticated user.

## High-level data endpoints

The endpoints work with paths instead of object IDs.

### GET /api/:username/repos/:name/tree

Returns the [tree resource](#tree-resource) for the latest commit to the default
branch.

**OAuth scope**: `data:read`

### GET /api/repos/:name/tree

Equivalent to [/api/:username/repos/:name/tree](#GET-apiusernamereposnametree),
implies the authenticated user.

### GET /api/:username/repos/:name/tree/:ref

Returns the [tree resource](#tree-resource) for the given reference.

**OAuth scope**: `data:read`

### GET /api/repos/:name/tree/:ref

Equivalent to [/api/:username/repos/:name/tree/:ref](#GET-apiusernamereposnametreeref),
implies the authenticated user.

### GET /api/:username/repos/:name/tree/:ref/:path

Returns the [tree resource](#tree-resource) for the given reference, following
the parent trees until the requested tree is found. In other words, this lists
the contents of a subdirectory by path.

**OAuth scope**: `data:read`

### GET /api/repos/:name/tree/:ref/:path

Equivalent to [/api/:username/repos/:name/tree/:ref/:path](#GET-apiusernamereposnametreerefpath),
implies the authenticated user.

### GET /api/:username/repos/:name/blob/:ref/:path

Returns the blob at the given path of the tree specified by the given reference.

**OAuth scope**: `data:read`

**Response**

The contents of the requested blob, as text/plain or as application/octet-stream
for binary blobs.

### GET /api/repos/:name/blob/:ref/:path

Equivalent to [/api/:username/repos/:name/blob/:ref/:path](#GET-apiusernamereposnameblobrefpath),
implies the authenticated user.

## Low-level data endpoints

These endpoints work with object IDs instead of paths.

### GET /api/:username/repos/:name/tree/:id

Returns the [tree resource](#tree-resource) with the given ID.

**OAuth scope**: `data:read`

### GET /api/repos/:name/tree/:id

Equivalent to [/api/:username/repos/:name/tree/:id](#GET-apiusernamereposnametreeid),
implies the authenticated user.

### GET /api/:username/repos/:name/blob/:id

Returns the blob with the given ID.

**OAuth scope**: `data:read`

**Response**

The contents of the requested blob, as text/plain or as application/octet-stream
for binary blobs.

### GET /api/repos/:name/blob/:id

Equivalent to [/api/:username/repos/:name/blob/:id](#GET-apiusernamereposnameblobid),
implies the authenticated user.

## Webhooks

### /api/user/...

Webhook for user events. Includes the [standard webhook
endpoints](../api-conventions.md#webhooks)

#### repo:create

Issued when the user creates a new repository.

**OAuth scope**: `info:read`

**Request body**

The new [repository resource](#repository-resource).

#### repo:update

Issued when the user updates repository details, such as name or description.

**OAuth scope**: `info:read`

**Request body**

The updated [repository resource](#repository-resource).

**Notes**

- When the name of the repository changes, the URL at which its webhooks are
  managed is updated accordingly. Users of the repository webhooks may wish to
  act accordingly. The ID will remain consistent.

#### repo:delete

Issued when the user deletes a repository.

**OAuth scope**: `info:read`

**Request body**

```json
{
  "id": integer ID of the affected repository resource
}
```

### /api/:username/repos/:name/...

Webhook for repository events. Includes the [standard webhook
endpoints](../api-conventions.md#webhooks). You may pass an additional parameter
to the webhook creation endpoint named "sync", which shall be a boolean value.

#### repo:post-update

Called after refs have been updated. If the `sync` flag on this webhook is set
to true, the webhook is invoked *during* `git-receive-pack`'s [`post-update`
hook][post-update] and the response text is printed to the console of the user
executing `git push`. Your server has 5 seconds to respond to the HTTP request.

[post-update]: https://git-scm.com/docs/git-receive-pack#_post_update_hook

**OAuth scope**: `data:read`

**Request body**

```json
{
  "push": "uuid assigned to this push event",
  "pusher": { user resource },
  "refs": [
    {
      "name": "updated ref, e.g. refs/heads/master",
      "annotated_tag": {
        "name": "tag name",
        "message": "tag message"
      }, # may not be present
      "old": {
        commit resource this ref used to refer to, or null in the case of new
        refs
      },
      "new": {
        commit resource this ref now refers to, or null in the case of deleted
        refs
      }
    }
  ]
}
```