diff options
| author | V.Krishn <vkrishn4@gmail.com> | 2016-06-20 07:41:38 +0530 |
|---|---|---|
| committer | V.Krishn <vkrishn4@gmail.com> | 2016-06-20 07:41:38 +0530 |
| commit | 95d6123ab8f9bf4ae99acf447c25274173096f1b (patch) | |
| tree | 7b9bd132008325a63384b558d4b7feb6ed50270d | |
| parent | 10d11050f6ee052e50b7dc6bd22ec5204d624fc0 (diff) | |
| download | aport-api-95d6123ab8f9bf4ae99acf447c25274173096f1b.tar.bz2 | |
clean docs
| -rw-r--r-- | docs/api-json.md | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/docs/api-json.md b/docs/api-json.md index cf1f4ea..e58d730 100644 --- a/docs/api-json.md +++ b/docs/api-json.md @@ -1,6 +1,6 @@ -JSONAPI implementations for aports packages. +'''JSONAPI''' implementations for aports packages. Api is build around packages data and its relationships with other tables in database, @@ -36,30 +36,31 @@ Get packages list (paginated 50 items) searching ----------- api uri: `<BaseURL>/search/<where>/key1/value1/key2/value2` - 1. where = packages|contents 2. keys = category|name|maintainer|flagged api uri: `<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 '_' +* 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 + `curl -X POST https://api.alpinelinux.org/search/packages -d '{"name":"_bas_","category":"edge:main:x86"}' | jq . | less` categories ----------- api uri: `<BaseURL>/categories` +* Get categories available. +* Categories data are for branch:repo:arch (eg. edge:main:x86 ) -Get categories available. -Categories are for branch:repo:arch (eg. edge:main:x86 ) - -* eg. Get available categories +* eg. Get all categories `<BaseURL>/categories` |