From bb71a868676b6de9fbe407f9b9cd02dd118f550f Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Tue, 21 Jan 2025 18:10:13 +0100 Subject: [PATCH 1/6] ibexa-orders.raml: GET orders/orders?limit&offset --- .../rest_api/rest_api_reference/input/ibexa-orders.raml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-orders.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-orders.raml index 383d2b68ec..b487b71fc4 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-orders.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-orders.raml @@ -32,6 +32,13 @@ displayName: Orders get: displayName: Load orders description: Loads a list of orders. + queryParameters: + offset: + description: The offset of the result set. + type: integer + limit: + description: The number of orders returned. + type: integer headers: Accept: description: OrderList - If set, the orders list returned in XML or JSON format. From 3ae98e2497d7ede40eabe9a3e1fb35bb9906a410 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Tue, 21 Jan 2025 18:10:31 +0100 Subject: [PATCH 2/6] Regenerate REST API Ref HTML --- .../rest_api_reference.html | 54 ++++++++++++++++++- 1 file changed, 53 insertions(+), 1 deletion(-) diff --git a/docs/api/rest_api/rest_api_reference/rest_api_reference.html b/docs/api/rest_api/rest_api_reference/rest_api_reference.html index 24a8e95427..f1cd516b27 100644 --- a/docs/api/rest_api/rest_api_reference/rest_api_reference.html +++ b/docs/api/rest_api/rest_api_reference/rest_api_reference.html @@ -83575,7 +83575,59 @@
Header parameters
- +
+
Query parameters
+
+ + + + + + + + + + + + + + + + + + + + +
PropertyTypeValue
+ offset + + + + integer + + + + + +

The offset of the result set.

+ +
+ limit + + + + integer + + + + + +

The number of orders returned.

+ +
+
+
+
Possible responses
From dd376bc4f04a815a50b56d32ae0c2183ee615e90 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Thu, 20 Feb 2025 13:03:41 +0100 Subject: [PATCH 3/6] OrderList.json.example: Add count --- .../input/examples/orders/GET/OrderList.json.example | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/api/rest_api/rest_api_reference/input/examples/orders/GET/OrderList.json.example b/docs/api/rest_api/rest_api_reference/input/examples/orders/GET/OrderList.json.example index 431563be62..db2233af95 100644 --- a/docs/api/rest_api/rest_api_reference/input/examples/orders/GET/OrderList.json.example +++ b/docs/api/rest_api/rest_api_reference/input/examples/orders/GET/OrderList.json.example @@ -1,6 +1,7 @@ { "OrderList": { "_media-type": "application/vnd.ibexa.api.OrderList+json", + "count": 10, "Order": [ { "_media-type": "application/vnd.ibexa.api.Order+json", From b1e83af17f8767ac4a83b95e15f554cb21ab46a1 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Thu, 20 Feb 2025 13:05:07 +0100 Subject: [PATCH 4/6] Regenerate REST API Ref HTML --- docs/api/rest_api/rest_api_reference/rest_api_reference.html | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/api/rest_api/rest_api_reference/rest_api_reference.html b/docs/api/rest_api/rest_api_reference/rest_api_reference.html index f099fa452f..122d43a146 100644 --- a/docs/api/rest_api/rest_api_reference/rest_api_reference.html +++ b/docs/api/rest_api/rest_api_reference/rest_api_reference.html @@ -83746,6 +83746,7 @@
Types
{ "OrderList": { "_media-type": "application/vnd.ibexa.api.OrderList+json", + "count": 10, "Order": [ { "_media-type": "application/vnd.ibexa.api.Order+json", @@ -83769,7 +83770,7 @@
Types
"email": "aa@aa.aa" }, "OrderCurrency": { - "_media- +
View more @@ -83832,6 +83833,7 @@
Types
{ "OrderList": { "_media-type": "application/vnd.ibexa.api.OrderList+json", + "count": 10, "Order": [ { "_media-type": "application/vnd.ibexa.api.Order+json", From 140eebaa603fdc2c96f2fea6b49eaf3e49698cd8 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Tue, 4 Mar 2025 09:20:51 +0100 Subject: [PATCH 5/6] ibexa-types.raml: Add count to OrderList --- docs/api/rest_api/rest_api_reference/input/ibexa-types.raml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-types.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-types.raml index bc9d3398af..503fe13982 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-types.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-types.raml @@ -5210,6 +5210,8 @@ OrderList: description: 'This class represents an orders list.' type: object properties: + count: + type: integer Order: type: Order[] From e86571cae9b6d66c748a3d28c84f8fbf5e36fd1b Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Tue, 4 Mar 2025 09:21:30 +0100 Subject: [PATCH 6/6] Regenerate REST API Ref --- .../rest_api_reference/rest_api_reference.html | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/api/rest_api/rest_api_reference/rest_api_reference.html b/docs/api/rest_api/rest_api_reference/rest_api_reference.html index 122d43a146..d0a5592b72 100644 --- a/docs/api/rest_api/rest_api_reference/rest_api_reference.html +++ b/docs/api/rest_api/rest_api_reference/rest_api_reference.html @@ -161104,6 +161104,18 @@
Types
  • + count + + * + +(integer) + - + + + + +
    • +
  • Order *