From 002c19bed3f7d0fc5d3daf151c2c847d9e651e2d Mon Sep 17 00:00:00 2001 From: Lukas Metzger Date: Fri, 5 Jan 2018 16:35:30 +0100 Subject: [PATCH] Updated API Domains (markdown) --- API-Domains.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/API-Domains.md b/API-Domains.md index e094b19..1bdad4a 100644 --- a/API-Domains.md +++ b/API-Domains.md @@ -1,6 +1,12 @@ # Domains ## Get list of domains -`GET /domains?query=foo&sort=id-asc,name-desc,type-asc,records-asc` +`GET /domains?page=5&pagesize=10&query=foo&sort=id-asc,name-desc,type-asc,records-asc` +| parameter | explanation | +| --- | --- | +| page | The page of the results to return | +| pagesize | How many items should be on each page | +| query | A search query | +| sort | A comma separated list of field names to sort (in this order) combined with the sort order (see example) | ### Response | code | result | @@ -9,9 +15,10 @@ ```json { - "pages": { - "current": 21, - "total": 42 + "paging": { + "page": 5, + "total": 20, + "pagesize": 10 }, "results": [ {