Skip to content

Commit ba14bf6

Browse files
adriendupuismnocon
adriendupuis
and
mnocon
committed
IBX-8947: Add 2 cart REST routes; update Cart examples (#2501)
/api/ibexa/v2/cart/{identifier}/validate /api/ibexa/v2/cart/authorize --------- Co-authored-by: Marek Nocoń <[email protected]> (cherry picked from commit 50b28fb)
1 parent 5019e74 commit ba14bf6

14 files changed

+1751
-259
lines changed

‎docs/api/rest_api/rest_api_reference/input/examples/cart/POST/Cart.json.example‎

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,25 @@
11
{
22
"Cart": {
3-
"_media-type": "application/vnd.ibexa.api.Cart+json",
4-
"id": 12,
5-
"identifier": "fafccc4b-cce1-40d7-8d23-29ad41638581",
3+
"_media-type": "application\/vnd.ibexa.api.Cart+json",
4+
"id": 1,
5+
"identifier": "e79b5dba-c701-4c64-8032-73719a513e50",
66
"name": "Default",
7-
"createdAt": "2023-10-12T10:02:51+00:00",
8-
"updatedAt": "2023-10-12T10:02:51+00:00",
7+
"createdAt": "2024-09-26T09:16:56+00:00",
8+
"updatedAt": "2024-09-26T09:16:56+00:00",
99
"owner": {
10-
"_media-type": "application/vnd.ibexa.api.User+json",
11-
"_href": "/api/ibexa/v2/user/users/14"
10+
"_media-type": "application\/vnd.ibexa.api.User+json",
11+
"_href": "\/api\/ibexa\/v2\/user\/users\/10"
1212
},
1313
"Currency": {
14-
"_media-type": "application/vnd.ibexa.api.Currency+json",
14+
"_media-type": "application\/vnd.ibexa.api.Currency+json",
1515
"id": 2,
1616
"code": "EUR",
1717
"subunits": 2,
1818
"enabled": true
1919
},
20-
"entries": []
20+
"entries": [],
21+
"context": {
22+
"foo": "bar"
23+
}
2124
}
2225
}

‎docs/api/rest_api/rest_api_reference/input/examples/cart/POST/Cart.xml.example‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<Cart media-type="application/vnd.ibexa.api.Cart+xml">
3+
<id>1</id>
4+
<identifier>e67d8f4c-95b5-423f-89d8-b2b81c37609b</identifier>
5+
<name>Default</name>
6+
<createdAt>2024-09-26T09:16:56+00:00</createdAt>
7+
<updatedAt>2024-09-26T09:16:56+00:00</updatedAt>
8+
<owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/10"/>
9+
<Currency media-type="application/vnd.ibexa.api.Currency+xml">
10+
<id>2</id>
11+
<code>EUR</code>
12+
<subunits>2</subunits>
13+
<enabled>1</enabled>
14+
</Currency>
15+
</Cart>

‎docs/api/rest_api/rest_api_reference/input/examples/cart/POST/CartCreate.xml.example‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<CartCreate>
2+
<name>Default</name>
3+
<currencyCode>EUR</currencyCode>
4+
</CartCreate>

‎docs/api/rest_api/rest_api_reference/input/examples/cart/authorize/Token.json.example‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"Token": {
3+
"_media-type": "application\/vnd.ibexa.api.Token+json",
4+
"value": "7b19308.RiDPaorwmJRyQoGajJiLMp843r30WaW-PH1CeH4oQyU.dkOXWOuFrvBfDPXY1t27YMx0hvyFH8fPUwoDNRl_D0sWDb4O3bb-20Q32A"
5+
}
6+
}

‎docs/api/rest_api/rest_api_reference/input/examples/cart/authorize/Token.xml.example‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<Token media-type="application/vnd.ibexa.api.Token+xml">
3+
<value>eff5.w9r2Ws_zpjcopNJ8FRNVaplGlx19y4Mp2QP-eQWZDKc.-pe4Pam133xKzKQZLCdiIMkj2EgQ5rMdtlGTEEPPaOyHv6Y1iKTsZ2_OtQ</value>
4+
</Token>

‎docs/api/rest_api/rest_api_reference/input/examples/cart/identifier/validate/CartConstraintViolationList.json.example‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"CartConstraintViolationList": {
3+
"_media-type": "application\/vnd.ibexa.api.CartConstraintViolationList+json",
4+
"violations": []
5+
}
6+
}

‎docs/api/rest_api/rest_api_reference/input/examples/cart/identifier/validate/CartConstraintViolationList.xml.example‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<CartConstraintViolationList media-type="application/vnd.ibexa.api.CartConstraintViolationList+xml"/>

‎docs/api/rest_api/rest_api_reference/input/examples/cart/view/CartView.json.example‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
{
2+
"CartView": {
3+
"_media-type": "application\/vnd.ibexa.api.CartView+json",
4+
"identifier": "loadUserCarts",
5+
"Result": {
6+
"_media-type": "application\/vnd.ibexa.api.ViewResult+json",
7+
"count": 1,
8+
"CartList": {
9+
"_media-type": "application\/vnd.ibexa.api.CartList+json",
10+
"Cart": [
11+
{
12+
"_media-type": "application\/vnd.ibexa.api.Cart+json",
13+
"id": 1,
14+
"identifier": "e79b5dba-c701-4c64-8032-73719a513e50",
15+
"name": "Default",
16+
"createdAt": "2024-09-26T09:16:56+00:00",
17+
"updatedAt": "2024-09-26T09:16:56+00:00",
18+
"owner": {
19+
"_media-type": "application\/vnd.ibexa.api.User+json",
20+
"_href": "\/api\/ibexa\/v2\/user\/users\/10"
21+
},
22+
"Currency": {
23+
"_media-type": "application\/vnd.ibexa.api.Currency+json",
24+
"id": 2,
25+
"code": "EUR",
26+
"subunits": 2,
27+
"enabled": true
28+
},
29+
"entries": [],
30+
"context": {
31+
"foo": "bar"
32+
}
33+
}
34+
]
35+
}
36+
}
37+
}
38+
}

‎docs/api/rest_api/rest_api_reference/input/examples/cart/view/CartView.xml.example‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<CartView media-type="application/vnd.ibexa.api.CartView+xml">
3+
<identifier>loadUserCarts</identifier>
4+
<Result media-type="application/vnd.ibexa.api.ViewResult+xml">
5+
<count>1</count>
6+
<CartList media-type="application/vnd.ibexa.api.CartList+xml">
7+
<Cart media-type="application/vnd.ibexa.api.Cart+xml">
8+
<id>1</id>
9+
<identifier>e67d8f4c-95b5-423f-89d8-b2b81c37609b</identifier>
10+
<name>Default</name>
11+
<createdAt>2024-09-26T09:16:56+00:00</createdAt>
12+
<updatedAt>2024-09-26T09:16:56+00:00</updatedAt>
13+
<owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/10"/>
14+
<Currency media-type="application/vnd.ibexa.api.Currency+xml">
15+
<id>2</id>
16+
<code>EUR</code>
17+
<subunits>2</subunits>
18+
<enabled>1</enabled>
19+
</Currency>
20+
</Cart>
21+
</CartList>
22+
</Result>
23+
</CartView>

‎docs/api/rest_api/rest_api_reference/input/examples/cart/view/CartViewInput.json.example‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"CartQuery": {
55
"offset": 0,
66
"limit": 10,
7-
"ownerId": 123
7+
"ownerId": 10
88
}
99
}
1010
}

0 commit comments

Comments
 (0)