Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"OrderList": {
"_media-type": "application/vnd.ibexa.api.OrderList+json",
"count": 10,
"Order": [
{
"_media-type": "application/vnd.ibexa.api.Order+json",
Expand Down
7 changes: 7 additions & 0 deletions docs/api/rest_api/rest_api_reference/input/ibexa-orders.raml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
58 changes: 56 additions & 2 deletions docs/api/rest_api/rest_api_reference/rest_api_reference.html
Original file line number Diff line number Diff line change
Expand Up @@ -83582,7 +83582,59 @@ <h6 class="heading text-gray border-bottom pb-2">Header parameters</h6>
</div>
</div>


<div class="py-3">
<h6 class="heading text-gray border-bottom pb-2">Query parameters</h6>
<div class="table-responsive">
<table class="table">
<thead>
<tr>
<th scope="col">Property</th>
<th scope="col">Type</th>
<th scope="col">Value</th>
</tr>
</thead>
<tbody>
<tr>
<td>
offset
</td>
<td>

<span>
integer
</span>



</td>
<td>
<p>The offset of the result set.</p>

</td>
</tr>
<tr>
<td>
limit
</td>
<td>

<span>
integer
</span>



</td>
<td>
<p>The number of orders returned.</p>

</td>
</tr>
</tbody>
</table>
</div>
</div>

<div class="py-3">
<h6 class="heading text-gray border-bottom pb-2">Possible responses</h6>
<div class="table-responsive">
Expand Down Expand Up @@ -83694,6 +83746,7 @@ <h6 class="heading text-gray border-bottom pb-2">Types</h6>
<code class="json">{
&quot;OrderList&quot;: {
&quot;_media-type&quot;: &quot;application/vnd.ibexa.api.OrderList+json&quot;,
&quot;count&quot;: 10,
&quot;Order&quot;: [
{
&quot;_media-type&quot;: &quot;application/vnd.ibexa.api.Order+json&quot;,
Expand All @@ -83717,7 +83770,7 @@ <h6 class="heading text-gray border-bottom pb-2">Types</h6>
&quot;email&quot;: &quot;[email protected]&quot;
},
&quot;OrderCurrency&quot;: {
&quot;_media-</code>
</code>
</pre>
</div>
<a href="" data-toggle="modal" data-target="#orders-orders-get-response-200Modal" class="btn btn--example-view-more text-center">View more</a>
Expand Down Expand Up @@ -83780,6 +83833,7 @@ <h6 class="heading text-gray border-bottom pb-2">Types</h6>
<code class="json">{
&quot;OrderList&quot;: {
&quot;_media-type&quot;: &quot;application/vnd.ibexa.api.OrderList+json&quot;,
&quot;count&quot;: 10,
&quot;Order&quot;: [
{
&quot;_media-type&quot;: &quot;application/vnd.ibexa.api.Order+json&quot;,
Expand Down
Loading