aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorV.Krishn <vkrishn4@gmail.com>2016-06-20 08:00:31 +0530
committerV.Krishn <vkrishn4@gmail.com>2016-06-20 08:00:31 +0530
commitd2aa51c23236a2f2fda7f22ca00efc614dc23cfa (patch)
treec84c6f06f99b9185c33ac5e88fc319dc73a44ec7
parent0367703fdd967f727545ce75752de3899b9a7dac (diff)
downloadaport-api-d2aa51c23236a2f2fda7f22ca00efc614dc23cfa.tar.bz2
docs clean
-rw-r--r--docs/api-json.md11
1 files changed, 6 insertions, 5 deletions
diff --git a/docs/api-json.md b/docs/api-json.md
index fc7f6d3..5d1a2a2 100644
--- a/docs/api-json.md
+++ b/docs/api-json.md
@@ -11,7 +11,7 @@ Currently, any JOINS in database is being avoided and maybe used if needed.
## Relationships
-Following relationships exists, *emanating* from a base *package<name>*
+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)
@@ -31,7 +31,7 @@ Get packages list (paginated 50 items)
* eg. `curl https://api.alpinelinux.org/packages | jq . | less`
-### searching
+### search
__api uri__: `<BaseURL>/search/<where>/key1/value1/key2/value2`
1. where = packages|contents
@@ -75,9 +75,10 @@ new=$(curl api.alpinelinux.org/flagged/new | jq .data[].relationships.packages.l
```
### maintainers
-* Get first page
-`<BaseURL>/maintainer/names`
+__api uri__: `<BaseURL>/maintainer/names`
+* Get maintainers names (50 per/page default)
+
+__api uri__: `<BaseURL>/maintainer/names/page/<num>`
* Get other pages
-`<BaseURL>/maintainer/names/page/<num>`