blob: 6772fb0511f46d2d4de11262147ed33bf56142eb (
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
|
# **JSONAPI** implementations for aports packages
Api is build around packages data and its relationships with other tables in database,
using, simple to-one or to-many relationships (based on *foreign-key/pid/id*).
Currently, any JOINS in database is being avoided and maybe used if needed.
## Relationships
Following relationships exists, *emanating* from a *base package<name>*
* origin (original package to which the **subpackage/named package** belongs to)
* install_if
* provides (what the package provides)
* depends (what the named package depends on)
* contents (contents of the package)
* flagged (if package is flagged, relationship to its data)
## Base URL
https://api.alpinelinux.org/
### packages
__api uri__: `GET <BaseURL>/packages/...`
Get packages list (paginated 50 items)
* eg. `curl https://api.alpinelinux.org/packages | jq . | less`
### search
__api uri__: `GET <BaseURL>/search/<where>/key1/value1/key2/value2`
1. where = packages|contents
2. keys = category|name|maintainer|flagged
__api uri__: `GET <BaseURL>/search/packages/category/<branch>:<repo>:<arch>/name/<pkgName>`
* Searches packages by categories and pkgName
* Reserved keyword in categories - ''all''
* Wildcard for package name recogonized - '_'
* eg. Basic search
`curl https://api.alpinelinux.org/search/packages/category/v3.4:all:x86/name/_bas_ | jq . | less`
* eg. Advanced search (POST)
```
curl -X POST https://api.alpinelinux.org/search/packages -d '{"name":"_bas_","category":"edge:main:x86"}' | jq . | less
```
### categories
__api uri__: `GET <BaseURL>/categories`
* Get categories available.
* Categories data are for branch:repo:arch (eg. edge:main:x86 )
* eg. Get all categories
`<BaseURL>/categories`
### flagged packages
__api uri__: `GET <BaseURL>/flagged`
* Get flagged data (paginated) (follow relationships link to get package data)
* `<BaseURL>/flagged/page/<num>` - more items (older)
__api uri__: `GET <BaseURL>/flagged/new`
* Get current flagged item
* How to get the current package that got flagged
```
new=$(curl api.alpinelinux.org/flagged/new | jq .data[].relationships.packages.links.self | sed -e 's/"//g'); curl $new | jq .data[].attributes.origin | uniq
```
### maintainers
__api uri__: `GET <BaseURL>/maintainer/names`
* Get maintainers names (50 per/page default)
__api uri__: `GET <BaseURL>/maintainer/names/page/<num>`
* Get other pages
## Resources
1. __JsonApi__ - [http://jsonapi.org/]
2. __Jq__ - a lightweight and flexible command-line JSON processor [http://stedolan.github.io/jq/]
3. __Curl__ [http://curl.haxx.se/]
|
