Skip to content

Commit 5aa3c4f

Browse files
committed
IBX-9369: GET orders/orders?limit&offet (#2600)
* ibexa-orders.raml: GET orders/orders?limit&offset * OrderList.json.example: Add count * ibexa-types.raml: Add count to OrderList * Regenerate REST API Ref HTML (cherry picked from commit a2c739d)
1 parent 8d27a53 commit 5aa3c4f

File tree

4 files changed

+78
-2
lines changed

4 files changed

+78
-2
lines changed

docs/api/rest_api/rest_api_reference/input/examples/orders/GET/OrderList.json.example

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"OrderList": {
33
"_media-type": "application/vnd.ibexa.api.OrderList+json",
4+
"count": 10,
45
"Order": [
56
{
67
"_media-type": "application/vnd.ibexa.api.Order+json",

docs/api/rest_api/rest_api_reference/input/ibexa-orders.raml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,13 @@ displayName: Orders
3232
get:
3333
displayName: Load orders
3434
description: Loads a list of orders.
35+
queryParameters:
36+
offset:
37+
description: The offset of the result set.
38+
type: integer
39+
limit:
40+
description: The number of orders returned.
41+
type: integer
3542
headers:
3643
Accept:
3744
description: OrderList - If set, the orders list returned in XML or JSON format.

docs/api/rest_api/rest_api_reference/input/ibexa-types.raml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5315,6 +5315,8 @@ OrderList:
53155315
description: 'This class represents an orders list.'
53165316
type: object
53175317
properties:
5318+
count:
5319+
type: integer
53185320
Order:
53195321
type: Order[]
53205322

docs/api/rest_api/rest_api_reference/rest_api_reference.html

Lines changed: 68 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86497,7 +86497,59 @@ <h6 class="heading text-gray border-bottom pb-2">Header parameters</h6>
8649786497
</div>
8649886498
</div>
8649986499

86500-
86500+
<div class="py-3">
86501+
<h6 class="heading text-gray border-bottom pb-2">Query parameters</h6>
86502+
<div class="table-responsive">
86503+
<table class="table">
86504+
<thead>
86505+
<tr>
86506+
<th scope="col">Property</th>
86507+
<th scope="col">Type</th>
86508+
<th scope="col">Value</th>
86509+
</tr>
86510+
</thead>
86511+
<tbody>
86512+
<tr>
86513+
<td>
86514+
offset
86515+
</td>
86516+
<td>
86517+
86518+
<span>
86519+
integer
86520+
</span>
86521+
86522+
86523+
86524+
</td>
86525+
<td>
86526+
<p>The offset of the result set.</p>
86527+
86528+
</td>
86529+
</tr>
86530+
<tr>
86531+
<td>
86532+
limit
86533+
</td>
86534+
<td>
86535+
86536+
<span>
86537+
integer
86538+
</span>
86539+
86540+
86541+
86542+
</td>
86543+
<td>
86544+
<p>The number of orders returned.</p>
86545+
86546+
</td>
86547+
</tr>
86548+
</tbody>
86549+
</table>
86550+
</div>
86551+
</div>
86552+
8650186553
<div class="py-3">
8650286554
<h6 class="heading text-gray border-bottom pb-2">Possible responses</h6>
8650386555
<div class="table-responsive">
@@ -86609,6 +86661,7 @@ <h6 class="heading text-gray border-bottom pb-2">Types</h6>
8660986661
<code class="json">{
8661086662
&quot;OrderList&quot;: {
8661186663
&quot;_media-type&quot;: &quot;application/vnd.ibexa.api.OrderList+json&quot;,
86664+
&quot;count&quot;: 10,
8661286665
&quot;Order&quot;: [
8661386666
{
8661486667
&quot;_media-type&quot;: &quot;application/vnd.ibexa.api.Order+json&quot;,
@@ -86632,7 +86685,7 @@ <h6 class="heading text-gray border-bottom pb-2">Types</h6>
8663286685
&quot;email&quot;: &quot;[email protected]&quot;
8663386686
},
8663486687
&quot;OrderCurrency&quot;: {
86635-
&quot;_media-</code>
86688+
</code>
8663686689
</pre>
8663786690
</div>
8663886691
<a href="" data-toggle="modal" data-target="#orders-orders-get-response-200Modal" class="btn btn--example-view-more text-center">View more</a>
@@ -86695,6 +86748,7 @@ <h6 class="heading text-gray border-bottom pb-2">Types</h6>
8669586748
<code class="json">{
8669686749
&quot;OrderList&quot;: {
8669786750
&quot;_media-type&quot;: &quot;application/vnd.ibexa.api.OrderList+json&quot;,
86751+
&quot;count&quot;: 10,
8669886752
&quot;Order&quot;: [
8669986753
{
8670086754
&quot;_media-type&quot;: &quot;application/vnd.ibexa.api.Order+json&quot;,
@@ -164398,6 +164452,18 @@ <h6 class="heading text-gray border-bottom pb-2">Types</h6>
164398164452
<div class="items">
164399164453
<ul class="browser-default">
164400164454
<li>
164455+
<span class="font-weight-medium">count</span>
164456+
164457+
<span class="red-text">*</span>
164458+
164459+
(<span class="font-italic">integer</span>)
164460+
-
164461+
<span>
164462+
</span>
164463+
164464+
164465+
</li>
164466+
<li>
164401164467
<span class="font-weight-medium">Order</span>
164402164468

164403164469
<span class="red-text">*</span>

0 commit comments

Comments
 (0)