Skip to content

Commit 42ec3ec

Browse files
adriendupuisadriendupuis
authored
Fix CartCreate & CartEntryAdd RAML (#2289)
1 parent 72cb1f7 commit 42ec3ec

File tree

2 files changed

+288
-11
lines changed

2 files changed

+288
-11
lines changed

‎docs/api/rest_api/rest_api_reference/input/ez-types.raml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2436,8 +2436,8 @@ CartCreate:
24362436
type: string
24372437
required: true
24382438
context:
2439-
description: array of scalars describing additional, contextual data attached to the cart
2440-
type: array
2439+
description: associative array of scalars describing additional, contextual data attached to the cart
2440+
type: object
24412441
required: false
24422442

24432443
CartEntryAdd:
@@ -2453,8 +2453,8 @@ CartEntryAdd:
24532453
type: CartProduct
24542454
required: true
24552455
context:
2456-
description: array of scalars describing additional, contextual data attached to the cart entry
2457-
type: array
2456+
description: associative array of scalars describing additional, contextual data attached to the cart entry
2457+
type: object
24582458
required: false
24592459

24602460
CartProduct:

‎docs/api/rest_api/rest_api_reference/rest_api_reference.html‎

Lines changed: 284 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -66361,7 +66361,10 @@ <h6 class="heading text-gray border-bottom pb-2">Types</h6>
6636166361
<code class="json">{
6636266362
&quot;CartCreate&quot;: {
6636366363
&quot;name&quot;: &quot;Default&quot;,
66364-
&quot;currencyCode&quot;: &quot;EUR&quot;
66364+
&quot;currencyCode&quot;: &quot;EUR&quot;,
66365+
&quot;context&quot;: {
66366+
&quot;foo&quot;: &quot;bar&quot;
66367+
}
6636566368
}
6636666369
}
6636766370
</code>
@@ -66424,7 +66427,10 @@ <h6 class="heading text-gray border-bottom pb-2">Types</h6>
6642466427
<code class="json">{
6642566428
&quot;CartCreate&quot;: {
6642666429
&quot;name&quot;: &quot;Default&quot;,
66427-
&quot;currencyCode&quot;: &quot;EUR&quot;
66430+
&quot;currencyCode&quot;: &quot;EUR&quot;,
66431+
&quot;context&quot;: {
66432+
&quot;foo&quot;: &quot;bar&quot;
66433+
}
6642866434
}
6642966435
}
6643066436
</code>
@@ -67111,13 +67117,13 @@ <h4 id="/cart/{identifier}/entry" class="heading text-gray">/cart/{identifier}/e
6711167117
<span data-field="method" class="badge badge--sm badge--post">POST</span>
6711267118
<span data-field="url">/cart/{identifier}/entry</span>
6711367119
</p>
67114-
<p data-field="body"><p>Adds an the posted entry to the cart passed by identifier</p>
67120+
<p data-field="body"><p>Adds an entry to the cart referenced by its identifier</p>
6711567121
</p>
6711667122
<div class="py-3">
6711767123
<h6 class="heading text-gray border-bottom pb-2">Header parameters</h6>
6711867124
<div class="mb-2">
6711967125
<p class="mt-3 mb-0 font-weight-medium">Content-Type</p>
67120-
<p>The EntryAddStruct schema encoded in XML or JSON format.</p>
67126+
<p>The CartEntryAdd schema encoded in XML or JSON format.</p>
6712167127
<div class="table-responsive mb-2">
6712267128
<table class="table">
6712367129
<thead>
@@ -67142,8 +67148,8 @@ <h6 class="heading text-gray border-bottom pb-2">Header parameters</h6>
6714267148
<tr>
6714367149
<td>Examples</td>
6714467150
<td>
67145-
<code>application/vnd.ibexa.api.EntryAddStruct+xml
67146-
application/vnd.ibexa.api.EntryAddStruct+json
67151+
<code>application/vnd.ibexa.api.CartEntryAdd+xml
67152+
application/vnd.ibexa.api.CartEntryAdd+json
6714767153
</code>
6714867154
</td>
6714967155
</tr>
@@ -67155,11 +67161,156 @@ <h6 class="heading text-gray border-bottom pb-2">Header parameters</h6>
6715567161

6715667162

6715767163

67158-
67164+
<div class="py-3">
67165+
<h6 class="heading text-gray border-bottom pb-2">Types</h6>
67166+
<div class="table-responsive">
67167+
<table class="table">
67168+
<thead>
67169+
<tr>
67170+
<th scope="col">Type</th>
67171+
<th scope="col">Description</th>
67172+
</tr>
67173+
</thead>
67174+
<tbody>
67175+
<tr>
67176+
<td>
67177+
<a href="#" class="text-ocean-blue" data-toggle="modal" data-target="#CartEntryAdd">
67178+
CartEntryAdd
67179+
</a>
67180+
</td>
67181+
<td>This class represents a cart entry</td>
67182+
</tr>
67183+
</tbody>
67184+
</table>
67185+
</div>
67186+
</div>
67187+
6715967188
</div>
6716067189
<div class="col-lg-6 px-3 examples">
6716167190

6716267191
<div class="request">
67192+
<div class="pb-3" id="cart-identifier-entry-post-request">
67193+
<div class="d-flex justify-content-between align-items-baseline">
67194+
<ul class="nav nav-tabs border-bottom-0" id="cart-identifier-entry-post-requestTab" role="tablist">
67195+
<li class="nav-item">
67196+
<a href="#" class="nav-link disabled">Request</a>
67197+
</li>
67198+
<li class="nav-item">
67199+
<a class="nav-link active text-gray" id="cart-identifier-entry-post-request-xml-tab"
67200+
data-toggle="tab"
67201+
href="#cart-identifier-entry-post-request-xml"
67202+
role="tab"
67203+
aria-controls="cart-identifier-entry-post-request-xml"
67204+
aria-selected="true">
67205+
xml
67206+
</a>
67207+
</li>
67208+
</ul>
67209+
</div>
67210+
<div class="example position-relative border p-3 mb-3">
67211+
<div class="tab-content" id="cart-identifier-entry-post-requestContent">
67212+
<div class="tab-pane fade show active" id="cart-identifier-entry-post-request-xml" role="tabpanel"
67213+
aria-labelledby="cart-identifier-entry-post-request-xml-tab">
67214+
<div class="position-relative ">
67215+
<p class="mb-0 icon icon--copy-clipboard">
67216+
<i class="material-icons-outlined clipboard"
67217+
data-toggle="tooltip"
67218+
data-placement="top"
67219+
data-clipboard-target="#fd45d516269e07f78589c840ce08207a046081d7a6670f77439f0876387e380e"
67220+
title="Copy to clipboard">file_copy
67221+
</i>
67222+
</p>
67223+
<pre id="fd45d516269e07f78589c840ce08207a046081d7a6670f77439f0876387e380e" class="example__code-wrapper">
67224+
<code class="xml">{
67225+
&quot;CartEntryAdd&quot;: {
67226+
&quot;quantity&quot;: 1,
67227+
&quot;Product&quot;: {
67228+
&quot;code&quot;: &quot;test&quot;
67229+
},
67230+
&quot;context&quot;: {
67231+
&quot;foo&quot;: &quot;bar&quot;
67232+
}
67233+
}
67234+
}
67235+
</code>
67236+
</pre>
67237+
</div>
67238+
<a href="" data-toggle="modal" data-target="#cart-identifier-entry-post-requestModal" class="btn btn--example-view-more text-center">View more</a>
67239+
</div>
67240+
</div>
67241+
</div>
67242+
<div class="modal fade" id="cart-identifier-entry-post-requestModal" tabindex="-1" role="dialog" aria-labelledby="cart-identifier-entry-post-requestTitle" aria-hidden="true">
67243+
<div class="modal-dialog modal-xl" role="document">
67244+
<div class="modal-content">
67245+
<div class="modal-header">
67246+
<p class="modal-title" id="cart-identifier-entry-post-requestTitle">
67247+
<span data-field="method" class="badge badge--sm badge--post">POST</span>
67248+
Add Entry to Cart
67249+
</p>
67250+
<button type="button" class="close" data-dismiss="modal" aria-label="Close">
67251+
<span aria-hidden="true">&times;</span>
67252+
</button>
67253+
</div>
67254+
<div class="modal-body">
67255+
<div class="d-flex justify-content-between align-items-baseline">
67256+
<ul class="nav nav-tabs border-bottom-0" id="cart-identifier-entry-post-requestModalTab" role="tablist">
67257+
<li class="nav-item">
67258+
<a href="#" class="nav-link disabled">
67259+
Request
67260+
</a>
67261+
</li>
67262+
<li class="nav-item">
67263+
<a class="nav-link active text-gray" id="cart-identifier-entry-post-request-xml-modal-tab"
67264+
data-toggle="tab"
67265+
href="#cart-identifier-entry-post-request-xml-modal"
67266+
role="tab"
67267+
aria-controls="cart-identifier-entry-post-request-xml-modal"
67268+
aria-selected="true">
67269+
xml
67270+
</a>
67271+
</li>
67272+
<li>
67273+
67274+
</li>
67275+
</ul>
67276+
</div>
67277+
<div class="example position-relative border p-3 mb-3">
67278+
<div class="tab-content" id="cart-identifier-entry-post-requestModalContent">
67279+
<div class="tab-pane fade show active"
67280+
id="cart-identifier-entry-post-request-xml-modal" role="tabpanel"
67281+
aria-labelledby="cart-identifier-entry-post-request-xml-modal-tab">
67282+
<div class="position-relative ">
67283+
<p class="mb-0 icon icon--copy-clipboard">
67284+
<i class="material-icons-outlined clipboard"
67285+
data-toggle="tooltip"
67286+
data-placement="top"
67287+
data-clipboard-target="#68d5655fde498e259ce9365f882ccd639c0e88d295aad297c28ce397ce6f584a"
67288+
title="Copy to clipboard">file_copy
67289+
</i>
67290+
</p>
67291+
<pre id="68d5655fde498e259ce9365f882ccd639c0e88d295aad297c28ce397ce6f584a">
67292+
<code class="xml">{
67293+
&quot;CartEntryAdd&quot;: {
67294+
&quot;quantity&quot;: 1,
67295+
&quot;Product&quot;: {
67296+
&quot;code&quot;: &quot;test&quot;
67297+
},
67298+
&quot;context&quot;: {
67299+
&quot;foo&quot;: &quot;bar&quot;
67300+
}
67301+
}
67302+
}
67303+
</code>
67304+
</pre>
67305+
</div>
67306+
</div>
67307+
</div>
67308+
</div>
67309+
</div>
67310+
</div>
67311+
</div>
67312+
</div>
67313+
</div>
6716367314
</div>
6716467315
</div>
6716567316
</div>
@@ -131216,6 +131367,132 @@ <h6 class="heading text-gray border-bottom pb-2">Types</h6>
131216131367
the currency code such as `EUR`</span>
131217131368

131218131369

131370+
</li>
131371+
<li>
131372+
<span class="font-weight-medium">context</span>
131373+
131374+
131375+
(<span class="font-italic">object</span>)
131376+
-
131377+
<span>
131378+
associative array of scalars describing additional, contextual data attached to the cart</span>
131379+
131380+
131381+
<div class="items">
131382+
<ul class="browser-default">
131383+
</ul>
131384+
</div>
131385+
</li>
131386+
</ul>
131387+
</div>
131388+
</div>
131389+
</div>
131390+
</div>
131391+
</div>
131392+
<div class="modal fade" id="CartEntryAdd" tabindex="-1" role="dialog" aria-labelledby="CartEntryAddTitle" aria-hidden="true">
131393+
<div class="modal-dialog" role="document">
131394+
<div class="modal-content">
131395+
<div class="modal-header">
131396+
<p class="modal-title" id="CartEntryAddTitle">CartEntryAdd</p>
131397+
<button type="button" class="close" data-dismiss="modal" aria-label="Close">
131398+
<span aria-hidden="true">&times;</span>
131399+
</button>
131400+
</div>
131401+
<div class="modal-body">
131402+
<span class="font-weight-medium">CartEntryAdd</span>
131403+
131404+
<span class="red-text">*</span>
131405+
131406+
(<span class="font-italic">object</span>)
131407+
-
131408+
<span>
131409+
This class represents a cart entry</span>
131410+
131411+
131412+
<div class="items">
131413+
<ul class="browser-default">
131414+
<li>
131415+
<span class="font-weight-medium">quantity</span>
131416+
131417+
<span class="red-text">*</span>
131418+
131419+
(<span class="font-italic">integer</span>)
131420+
-
131421+
<span>
131422+
the quantity of entry items</span>
131423+
131424+
131425+
</li>
131426+
<li>
131427+
<span class="font-weight-medium">Product</span>
131428+
131429+
<span class="red-text">*</span>
131430+
131431+
(<span class="font-italic">CartProduct</span>)
131432+
-
131433+
<span>
131434+
product data</span>
131435+
131436+
131437+
<div class="items">
131438+
<ul class="browser-default">
131439+
</ul>
131440+
</div>
131441+
</li>
131442+
<li>
131443+
<span class="font-weight-medium">context</span>
131444+
131445+
131446+
(<span class="font-italic">object</span>)
131447+
-
131448+
<span>
131449+
associative array of scalars describing additional, contextual data attached to the cart entry</span>
131450+
131451+
131452+
<div class="items">
131453+
<ul class="browser-default">
131454+
</ul>
131455+
</div>
131456+
</li>
131457+
</ul>
131458+
</div>
131459+
</div>
131460+
</div>
131461+
</div>
131462+
</div>
131463+
<div class="modal fade" id="CartProduct" tabindex="-1" role="dialog" aria-labelledby="CartProductTitle" aria-hidden="true">
131464+
<div class="modal-dialog" role="document">
131465+
<div class="modal-content">
131466+
<div class="modal-header">
131467+
<p class="modal-title" id="CartProductTitle">CartProduct</p>
131468+
<button type="button" class="close" data-dismiss="modal" aria-label="Close">
131469+
<span aria-hidden="true">&times;</span>
131470+
</button>
131471+
</div>
131472+
<div class="modal-body">
131473+
<span class="font-weight-medium">CartProduct</span>
131474+
131475+
<span class="red-text">*</span>
131476+
131477+
(<span class="font-italic">object</span>)
131478+
-
131479+
<span>
131480+
This class represents a cart entry product</span>
131481+
131482+
131483+
<div class="items">
131484+
<ul class="browser-default">
131485+
<li>
131486+
<span class="font-weight-medium">code</span>
131487+
131488+
<span class="red-text">*</span>
131489+
131490+
(<span class="font-italic">string</span>)
131491+
-
131492+
<span>
131493+
product&#039;s code</span>
131494+
131495+
131219131496
</li>
131220131497
</ul>
131221131498
</div>

0 commit comments

Comments
 (0)