forked from vieter-v/vieter
WIP docs(slate): start of GitRepo docs
parent
a02b70e9a5
commit
808e0f59e8
|
|
@ -0,0 +1,52 @@
|
||||||
|
# Git Repositories
|
||||||
|
|
||||||
|
<aside class="notice">
|
||||||
|
|
||||||
|
All routes in this section require authentication.
|
||||||
|
|
||||||
|
</aside>
|
||||||
|
|
||||||
|
Endpoints for interacting with the list of Git repositories stored on the
|
||||||
|
server.
|
||||||
|
|
||||||
|
## List repos
|
||||||
|
|
||||||
|
Retrieve a list of Git repositories.
|
||||||
|
|
||||||
|
> JSON Output format
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "",
|
||||||
|
"data": [
|
||||||
|
{
|
||||||
|
"id": 1,
|
||||||
|
"url": "https://aur.archlinux.org/discord-ptb.git",
|
||||||
|
"branch": "master",
|
||||||
|
"repo": "bur",
|
||||||
|
"schedule": "",
|
||||||
|
"arch": [
|
||||||
|
{
|
||||||
|
"id": 1,
|
||||||
|
"repo_id": 1,
|
||||||
|
"value": "x86_64"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### HTTP Request
|
||||||
|
|
||||||
|
`GET /api/repos`
|
||||||
|
|
||||||
|
### Query Parameters
|
||||||
|
|
||||||
|
Parameter | Description
|
||||||
|
--------- | -----------
|
||||||
|
limit | Maximum amount of results to return.
|
||||||
|
offset | Offset of results.
|
||||||
|
repo | Limit results to repositories that publish to the given repo.
|
||||||
|
|
||||||
|
</aside>
|
||||||
Loading…
Reference in New Issue