From 9750d1158fd363047e967e571d9b9e4889ccd122 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Fri, 14 Mar 2025 14:49:10 +0100 Subject: [PATCH 01/18] REST API: Continue user/users/{userId}/segments --- .../rest_api_reference/input/ibexa-types.raml | 24 ++++++++++++++++++- .../input/ibexa-user-users.raml | 10 +++++++- 2 files changed, 32 insertions(+), 2 deletions(-) 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 20ae546d32..10632ac400 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 @@ -2305,6 +2305,29 @@ SegmentUpdateWrapper: properties: SegmentCreate: SegmentUpdate +UserSegmentList: + type: object + properties: + UserSegment: + type: UserSegment[] + +UserSegmentListWrapper: + description: 'JSON object with only a UserSegmentList property' + type: object + properties: + UserSegmentList: UserSegmentList + +UserSegment: + type: object + properties: + id: integer + identifier: string + name: string + SegmentGroup: + type: Ref + User: + type: Ref + SortClause: description: 'This class is the base for SortClause classes, used to set sorting of content queries.' type: object @@ -6274,4 +6297,3 @@ ActionConfiguration: updatedAt: type: datetime description: 'Timestamp indicating when the action configuration was last updated.' - diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-user-users.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-user-users.raml index 674b939dd3..9b3b5f300a 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-user-users.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-user-users.raml @@ -330,13 +330,21 @@ head: /segments: get: displayName: View user segments - description: TODO + description: Return user's segment list. headers: Accept: description: If set, the user's segment list is returned in XML or JSON format. example: | application/vnd.ibexa.api.UserSegmentList+xml application/vnd.ibexa.api.UserSegmentList+json + responses: + 200: + body: + application/vnd.ibexa.api.UserSegmentList+xml: + type: UserSegmentList + application/vnd.ibexa.api.UserSegmentList+json: + type: UserSegmentListWrapper + #TODO: 404, 401, …? post: displayName: Assign Segments to User description: Assigns Segments from payload to User given by ID. From fef7031a1c7160596ffa6bcc1ced810128e4d7e3 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Fri, 14 Mar 2025 15:57:32 +0100 Subject: [PATCH 02/18] ibexa-user-users.raml: Fix typo --- .../api/rest_api/rest_api_reference/input/ibexa-user-users.raml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-user-users.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-user-users.raml index 9b3b5f300a..b1be0355e1 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-user-users.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-user-users.raml @@ -33,7 +33,7 @@ get: application/vnd.ibexa.api.UserRefList+json: type: UserRefListWrapper 404: - description: If there are no visibile Users matching the filter. + description: If there are no visible Users matching the filter. head: displayName: Verify Users description: Verifies if there are Users matching given filter. From 9634e500f121d4f6f813b4c537c5f802d7d429cf Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Fri, 14 Mar 2025 15:59:54 +0100 Subject: [PATCH 03/18] ibexa-user-users.raml: Fix typo --- .../api/rest_api/rest_api_reference/input/ibexa-user-users.raml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-user-users.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-user-users.raml index b1be0355e1..aa447063c9 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-user-users.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-user-users.raml @@ -50,7 +50,7 @@ head: 200: description: OK - verifies if there are Users matching the given filter. 404: - description: Error - there are no visibile Users matching the filter. + description: Error - there are no visible Users matching the filter. /current: get: displayName: Load current User From 6f9daa78998bd6e377434bcb67033b29c10f6a7f Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Fri, 14 Mar 2025 16:04:23 +0100 Subject: [PATCH 04/18] REST API: Continue user/users/{userId}/segments responses --- .../rest_api/rest_api_reference/input/ibexa-user-users.raml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-user-users.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-user-users.raml index aa447063c9..6e93bb3ada 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-user-users.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-user-users.raml @@ -344,7 +344,8 @@ head: type: UserSegmentList application/vnd.ibexa.api.UserSegmentList+json: type: UserSegmentListWrapper - #TODO: 404, 401, …? + 404: + description: Error - the user doesn't exist. post: displayName: Assign Segments to User description: Assigns Segments from payload to User given by ID. From f7fb81d7604b5fe49704125f84ad3a3c5cc25ae9 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Mon, 17 Mar 2025 14:57:30 +0100 Subject: [PATCH 05/18] REST API: Continue user/users/{userId}/segments responses --- .../UserSegmentAssignInput.json.example | 5 ++++ .../UserSegmentAssignInput.xml.example | 3 +++ .../segments/UserSegmentList.json.example | 22 ++++++++++++++++++ .../segments/UserSegmentList.xml.example | 10 ++++++++ .../rest_api_reference/input/ibexa-types.raml | 16 +++++++++++++ .../input/ibexa-user-users.raml | 23 +++++++++++++++++++ 6 files changed, 79 insertions(+) create mode 100644 docs/api/rest_api/rest_api_reference/input/examples/user/users/user_id/segments/UserSegmentAssignInput.json.example create mode 100644 docs/api/rest_api/rest_api_reference/input/examples/user/users/user_id/segments/UserSegmentAssignInput.xml.example create mode 100644 docs/api/rest_api/rest_api_reference/input/examples/user/users/user_id/segments/UserSegmentList.json.example create mode 100644 docs/api/rest_api/rest_api_reference/input/examples/user/users/user_id/segments/UserSegmentList.xml.example diff --git a/docs/api/rest_api/rest_api_reference/input/examples/user/users/user_id/segments/UserSegmentAssignInput.json.example b/docs/api/rest_api/rest_api_reference/input/examples/user/users/user_id/segments/UserSegmentAssignInput.json.example new file mode 100644 index 0000000000..43e685fdf4 --- /dev/null +++ b/docs/api/rest_api/rest_api_reference/input/examples/user/users/user_id/segments/UserSegmentAssignInput.json.example @@ -0,0 +1,5 @@ +{ + "UserSegmentAssignInput": { + "segments": ["corporate_account"] + } +} diff --git a/docs/api/rest_api/rest_api_reference/input/examples/user/users/user_id/segments/UserSegmentAssignInput.xml.example b/docs/api/rest_api/rest_api_reference/input/examples/user/users/user_id/segments/UserSegmentAssignInput.xml.example new file mode 100644 index 0000000000..bc3f970a01 --- /dev/null +++ b/docs/api/rest_api/rest_api_reference/input/examples/user/users/user_id/segments/UserSegmentAssignInput.xml.example @@ -0,0 +1,3 @@ + + corporate_account + diff --git a/docs/api/rest_api/rest_api_reference/input/examples/user/users/user_id/segments/UserSegmentList.json.example b/docs/api/rest_api/rest_api_reference/input/examples/user/users/user_id/segments/UserSegmentList.json.example new file mode 100644 index 0000000000..3808d88ce9 --- /dev/null +++ b/docs/api/rest_api/rest_api_reference/input/examples/user/users/user_id/segments/UserSegmentList.json.example @@ -0,0 +1,22 @@ +{ + "UserSegmentList": { + "_media-type": "application\/vnd.ibexa.api.UserSegmentList+json", + "_href": "\/api\/ibexa\/v2\/user\/users\/14\/segments", + "UserSegment": [ + { + "_media-type": "application\/vnd.ibexa.api.UserSegment+json", + "id": 1, + "identifier": "corporate_account", + "name": "Corporate Account", + "SegmentGroup": { + "_media-type": "application\/vnd.ibexa.api.SegmentGroup+json", + "_href": "\/api\/ibexa\/v2\/segment_groups\/corporate_accounts" + }, + "User": { + "_media-type": "application\/vnd.ibexa.api.User+json", + "_href": "\/api\/ibexa\/v2\/user\/users\/14" + } + } + ] + } +} \ No newline at end of file diff --git a/docs/api/rest_api/rest_api_reference/input/examples/user/users/user_id/segments/UserSegmentList.xml.example b/docs/api/rest_api/rest_api_reference/input/examples/user/users/user_id/segments/UserSegmentList.xml.example new file mode 100644 index 0000000000..91a660eab4 --- /dev/null +++ b/docs/api/rest_api/rest_api_reference/input/examples/user/users/user_id/segments/UserSegmentList.xml.example @@ -0,0 +1,10 @@ + + + + 1 + corporate_account + Corporate Account + + + + 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 10632ac400..23e5290515 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 @@ -2306,6 +2306,7 @@ SegmentUpdateWrapper: SegmentCreate: SegmentUpdate UserSegmentList: + description: 'This class lists segment assignements.' type: object properties: UserSegment: @@ -2318,6 +2319,7 @@ UserSegmentListWrapper: UserSegmentList: UserSegmentList UserSegment: + description: 'This class reprensents a segment assigned to a user' type: object properties: id: integer @@ -2328,6 +2330,20 @@ UserSegment: User: type: Ref +UserSegmentAssignInput: + description: 'This class represents a segment assignment input.' + type: object + properties: + segments: + type: array + items: string + +UserSegmentAssignInputWrapper: + description: 'JSON object with only a UserSegmentAssignInput property.' + type: object + properties: + UserSegmentAssignInput: UserSegmentAssignInput + SortClause: description: 'This class is the base for SortClause classes, used to set sorting of content queries.' type: object diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-user-users.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-user-users.raml index 6e93bb3ada..38e2adf19c 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-user-users.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-user-users.raml @@ -342,8 +342,10 @@ head: body: application/vnd.ibexa.api.UserSegmentList+xml: type: UserSegmentList + example: !include examples/user/users/user_id/segments/UserSegmentList.xml.example application/vnd.ibexa.api.UserSegmentList+json: type: UserSegmentListWrapper + example: !include examples/user/users/user_id/segments/UserSegmentList.json.example 404: description: Error - the user doesn't exist. post: @@ -355,10 +357,31 @@ head: example: | application/vnd.ibexa.api.UserSegmentAssignInput+xml application/vnd.ibexa.api.UserSegmentAssignInput+json + body: + application/vnd.ibexa.api.UserSegmentAssignInput+xml: + type: UserSegmentAssignInput + example: !include examples/user/users/user_id/segments/UserSegmentAssignInput.xml.example + application/vnd.ibexa.api.UserSegmentAssignInput+json: + type: UserSegmentAssignInputWrapper + example: !include examples/user/users/user_id/segments/UserSegmentAssignInput.json.example + responses: + 204: + description: No Content - segments assigned to user. + 401: + description: Error - the requesting user is not authorized to assign this segment to the given user. + 404: + description: Error - the user doesn't exist. /{segmentIdentifier}: delete: displayName: Unassign Segment from User description: The Segment designated by its identifier is unassigned from the User given by ID. + responses: + 204: + description: No Content - segments unassigned from user. + 401: + description: Error - the requesting user is not authorized to unassign this segment from the given user. + 404: + description: Error - the segment or the user doesn't exist. /drafts: get: displayName: Load user drafts From 430b68382775204ca7db7f3ad55dd7b9fafa77bc Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Mon, 17 Mar 2025 14:58:39 +0100 Subject: [PATCH 06/18] Regenerate REST API Reference's HTML --- .../rest_api_reference.html | 865 +++++++++++++++++- 1 file changed, 852 insertions(+), 13 deletions(-) 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 0bf890f12a..479fdaf1cc 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 @@ -51942,7 +51942,7 @@
Possible responses
404 -

If there are no visibile Users matching the filter.

+

If there are no visible Users matching the filter.

@@ -52488,7 +52488,7 @@
Possible responses
404 -

Error - there are no visibile Users matching the filter.

+

Error - there are no visible Users matching the filter.

@@ -57129,7 +57129,7 @@

/user/users/{us GET /user/users/{userId}/segments

-

TODO

+

Return user's segment list.

Header parameters
@@ -57172,14 +57172,306 @@
Header parameters
- - +
+
Possible responses
+
+ + + + + + + + + + + + + + + + + +
CodeDescription
+ + 200 + + +

+
+ 404 + +

Error - the user doesn't exist.

+
+
+
+ +
+
Types
+
+ + + + + + + + + + + + + + + + + +
TypeDescription
+ + UserSegmentList + + This class lists segment assignements.
+ + UserSegmentListWrapper + + JSON object with only a UserSegmentList property
+
+
+
-
+
+
+
+ +
+ Code: 200 +
+
+
+
+
+
+

+ file_copy + +

+ 
+                                <?xml version="1.0" encoding="UTF-8"?>
+<UserSegmentList media-type="application/vnd.ibexa.api.UserSegmentList+xml" href="/api/ibexa/v2/user/users/14/segments">
+ <UserSegment media-type="application/vnd.ibexa.api.UserSegment+xml">
+  <id>1</id>
+  <identifier>corporate_account</identifier>
+  <name>Corporate Account</name>
+  <SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts"/>
+  <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
+ </UserSegment>
+</UserSegmentList>
+
+
+
+ View more +
+
+
+

+ file_copy + +

+ 
+                                {
+    "UserSegmentList": {
+        "_media-type": "application\/vnd.ibexa.api.UserSegmentList+json",
+        "_href": "\/api\/ibexa\/v2\/user\/users\/14\/segments",
+        "UserSegment": [
+            {
+                "_media-type": "application\/vnd.ibexa.api.UserSegment+json",
+                "id": 1,
+                "identifier": "corporate_account",
+                "name": "Corporate Account",
+                "SegmentGroup": {
+                    "_media-type": "application\/vnd.ibexa.api.SegmentGroup+json",
+                    "_href": "\/api\/ibexa\/v2\/segment_groups\/corporate_accounts"
+                },
+                "User": {
+                    "_media-type": "application\/vnd.ibexa.api.User+json",
+                    "_href": "\/api\/ibexa\/v2\/user\/users\/14"
+                }
+            }
+        ]
+    }
+}
+
+
+ View more +
+
+
+ +
+
+
@@ -57241,14 +57533,259 @@
Header parameters
- - +
+
Possible responses
+
+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
+ 204 + +

No Content - segments assigned to user.

+
+ 401 + +

Error - the requesting user is not authorized to assign this segment to the given user.

+
+ 404 + +

Error - the user doesn't exist.

+
+
+
+ +
+
Types
+
+ + + + + + + + + + + + + + + + + +
TypeDescription
+ + UserSegmentAssignInput + + This class represents a segment assignment input.
+ + UserSegmentAssignInputWrapper + + JSON object with only a UserSegmentAssignInput property.
+
+
+
+
+
+ +
+
+
+
+
+

+ file_copy + +

+ 
+                                <UserSegmentAssignInput>
+    <segments>corporate_account</segments>
+</UserSegmentAssignInput>
+
+
+
+ View more +
+
+
+

+ file_copy + +

+ 
+                                {
+    "UserSegmentAssignInput": {
+        "segments": ["corporate_account"]
+    }
+}
+
+
+
+ View more +
+
+
+ +
+
+
+
+
+
@@ -57285,12 +57822,53 @@

+

Possible responses
+
+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
+ 204 + +

No Content - segments unassigned from user.

+
+ 401 + +

Error - the requesting user is not authorized to unassign this segment from the given user.

+
+ 404 + +

Error - the segment or the user doesn't exist.

+
+
+
+
-
+
+
+
@@ -133260,8 +133838,11 @@
Query parameters
  • type: action, parameter: value (the action)
  • type: logged_at, parameters: value and operator
      -
    • logged_at value value can be anything accepted by DateTimeImmutable
      • -
    • logged_at operator value can be one of the following:
      • +
    • +logged_at value value can be anything accepted by DateTimeImmutable +
      • +
    • +logged_at operator value can be one of the following:
    • @@ -149386,6 +149967,264 @@
    Types
    +
    +
      +
    +
    + + +
    + + + + + + + + + - +
    +
    +
    + +
    +
    +
    +
    @@ -75143,6 +75255,42 @@
    Header parameters
    application/vnd.ibexa.api.CartEntryAdd+xml application/vnd.ibexa.api.CartEntryAdd+json + + + + + +
    + +
    +

    Accept

    +

    The updated Cart is returned in XML or JSON format.

    +
    + + + + + + + + + + + + + + + @@ -75153,7 +75301,57 @@
    Header parameters
    - +
    +
    Possible responses
    +
    +
    PropertyValue
    Type + + + string + + + + +
    Examples + application/vnd.ibexa.api.Cart+xml +application/vnd.ibexa.api.Cart+json
    + + + + + + + + + + + + + + + + + + + + + + + + +
    CodeDescription
    + + 200 + + +

    OK - return the updated cart

    +
    + 400 + +

    Error - the input doesn't match the input schema definition.

    +
    + 401 + +

    Error - the user is not authorized to add an entry to this cart.

    +
    + 404 + +

    Error - the identifier doesn't match any cart.

    +
    +
    +
    +
    Types
    @@ -75180,6 +75378,22 @@
    Types
    JSON object with only a CartEntryAdd property. + + + + + Cart + + + This class represents a Cart + + + + + CartWrapper + + + JSON object with only a Cart property. @@ -75313,7 +75527,15 @@
    Types
    - +
    +
    +
    +
      +
    +
    +
    +
    +
    @@ -75414,6 +75636,42 @@
    Header parameters
    application/vnd.ibexa.api.CartEntryUpdate+xml application/vnd.ibexa.api.CartEntryUpdate+json + + + + + +
    + +
    +

    Accept

    +

    The updated Cart is returned in XML or JSON format.

    +
    + + + + + + + + + + + + + + + @@ -75424,7 +75682,49 @@
    Header parameters
    - +
    +
    Possible responses
    +
    +
    PropertyValue
    Type + + + string + + + + +
    Examples + application/vnd.ibexa.api.Cart+xml +application/vnd.ibexa.api.Cart+json
    + + + + + + + + + + + + + + + + + + + + +
    CodeDescription
    + + 200 + + +

    OK - return the updated cart

    +
    + 401 + +

    Error - the user is not authorized to remove an entry from this cart.

    +
    + 404 + +

    Error - the identifier doesn't match any cart.

    +
    +
    +
    +
    Types
    @@ -75451,6 +75751,22 @@
    Types
    JSON object with only a CartEntryUpdate property. + + + + + Cart + + + This class represents a Cart + + + + + CartWrapper + + + JSON object with only a Cart property. @@ -75468,7 +75784,15 @@
    Types
    - +
    +
    +
    +
      +
    +
    +
    +
    +
    From a48a3657d0e7f747af565a86909bb379c985efbb Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Mon, 17 Mar 2025 17:56:12 +0100 Subject: [PATCH 12/18] REST API Ref: Add responses to DELETE /cart/{identifier}/entry/{entryId} --- .../rest_api_reference/input/ibexa-cart.raml | 27 ++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-cart.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-cart.raml index cc54c61a15..713d2ee6d9 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-cart.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-cart.raml @@ -161,6 +161,29 @@ post: delete: displayName: Remove Entry from Cart description: Removes the given entry from the given Cart. + headers: + Accept: + description: The updated Cart is returned in XML or JSON format. + example: | + application/vnd.ibexa.api.Cart+xml + application/vnd.ibexa.api.Cart+json + body: + application/vnd.ibexa.api.CartEntryUpdate+xml: + type: CartEntryUpdate + application/vnd.ibexa.api.CartEntryUpdate+json: + type: CartEntryUpdateWrapper + responses: + 200: + description: OK - return the updated cart + body: + application/vnd.ibexa.api.Cart+xml: + type: Cart + application/vnd.ibexa.api.Cart+json: + type: CartWrapper + 401: + description: Error - the user is not authorized to remove an entry from this cart. + 404: + description: Error - the identifiers don't match any cart or entry. patch: displayName: Update Entry from Cart description: Updates the given entry from the given Cart. @@ -188,10 +211,12 @@ post: type: Cart application/vnd.ibexa.api.Cart+json: type: CartWrapper + 400: + description: Error - the input doesn't match the input schema definition. 401: description: Error - the user is not authorized to remove an entry from this cart. 404: - description: Error - the identifier doesn't match any cart. + description: Error - the identifiers don't match any cart or entry. /empty: post: displayName: Empty Cart From b1f4c829105c5efa036d3c1dd33ade673b5bf063 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Mon, 17 Mar 2025 18:00:35 +0100 Subject: [PATCH 13/18] REST API Ref: Add responses to PATCH /cart/{identifier}/entry/{entryId} --- docs/api/rest_api/rest_api_reference/input/ibexa-cart.raml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-cart.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-cart.raml index 713d2ee6d9..8d725325db 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-cart.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-cart.raml @@ -214,7 +214,7 @@ post: 400: description: Error - the input doesn't match the input schema definition. 401: - description: Error - the user is not authorized to remove an entry from this cart. + description: Error - the user is not authorized to update an entry of this cart. 404: description: Error - the identifiers don't match any cart or entry. /empty: From c2f3f282cbb6b3db03ec46d7782e1182ce367de6 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Mon, 17 Mar 2025 18:01:16 +0100 Subject: [PATCH 14/18] Regenerate REST API Reference's HTML --- .../rest_api_reference.html | 162 +++++++++++++++++- 1 file changed, 157 insertions(+), 5 deletions(-) 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 6ba0ee8898..235bd89196 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 @@ -75577,14 +75577,158 @@

    /cart/{ide

    Removes the given entry from the given Cart.

    +
    +
    Header parameters
    +
    +

    Accept

    +

    The updated Cart is returned in XML or JSON format.

    +
    + + + + + + + + + + + + + + + + + +
    PropertyValue
    Type + + + string + + +
    Examples + application/vnd.ibexa.api.Cart+xml +application/vnd.ibexa.api.Cart+json + +
    +
    +
    +
    + - +
    +
    Possible responses
    +
    + + + + + + + + + + + + + + + + + + + + + +
    CodeDescription
    + + 200 + + +

    OK - return the updated cart

    +
    + 401 + +

    Error - the user is not authorized to remove an entry from this cart.

    +
    + 404 + +

    Error - the identifiers don't match any cart or entry.

    +
    +
    +
    + +
    +
    Types
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeDescription
    + + CartEntryUpdate + +
    + + CartEntryUpdateWrapper + + JSON object with only a CartEntryUpdate property.
    + + Cart + + This class represents a Cart
    + + CartWrapper + + JSON object with only a Cart property.
    +
    +
    +

    -
    +
    +
    +
    +
      +
    +
    +
    +
    +
    +
    +
    +
      +
    +
    +
    +
    +
    @@ -75703,13 +75847,21 @@
    Possible responses

    OK - return the updated cart

    + + + + 400 + + +

    Error - the input doesn't match the input schema definition.

    + 401 -

    Error - the user is not authorized to remove an entry from this cart.

    +

    Error - the user is not authorized to update an entry of this cart.

    @@ -75717,7 +75869,7 @@
    Possible responses
    404 -

    Error - the identifier doesn't match any cart.

    +

    Error - the identifiers don't match any cart or entry.

    @@ -75791,7 +75943,7 @@
    Types
    - + From 1fd7b960ff6aee322a09c8d928f664ad95ef8ae6 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Tue, 18 Mar 2025 09:41:24 +0100 Subject: [PATCH 15/18] ibexa-types.raml: Fix LocationQuery --- docs/api/rest_api/rest_api_reference/input/ibexa-types.raml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 23e5290515..8a03f70a40 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 @@ -1388,7 +1388,7 @@ LocationList: LocationQuery: description: 'This class is used to perform a Location query.' - type: object + type: Query LocationUpdateWrapper: description: 'JSON object with only a LocationUpdate property.' From b152461af6074a5417b22dbb6c5059b19efdf7ca Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Tue, 18 Mar 2025 09:41:49 +0100 Subject: [PATCH 16/18] Regenerate REST API Reference's HTML --- .../api/rest_api/rest_api_reference/rest_api_reference.html | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) 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 235bd89196..644e19ce16 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 @@ -145657,7 +145657,7 @@

    Types
    * -(object) +(Query) - This class is used to perform a Location query. @@ -154763,10 +154763,6 @@
    Types
    -
    - -
  • Result From 27a2fa5cad2382249fd5f914d2fca00341b7d10e Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Thu, 15 May 2025 11:54:04 +0200 Subject: [PATCH 17/18] Fix /corporate/companies/{companyId}/members 400 description --- docs/api/rest_api/rest_api_reference/input/ibexa-corporate.raml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-corporate.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-corporate.raml index 571472c53e..ea018ed151 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-corporate.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-corporate.raml @@ -235,10 +235,10 @@ get: type: MemberListWrapper example: !include examples/corporate/companies/company_id/members/GET/MemberList.json.example 400: + description: Returned when invalid Criterion or Sort clause is used. body: application/vnd.ibexa.api.ErrorMessage: type: ErrorMessage - description: Returned when invalid Criterion or Sort clause is used. post: displayName: Create a company member description: Creates a company member. From 2214d687006f612c626cbfeec83dd0f3e1e51703 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Thu, 15 May 2025 11:54:33 +0200 Subject: [PATCH 18/18] rebuild rest_api_reference.html --- .../rest_api_reference/rest_api_reference.html | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) 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 7ac6e6eac7..1f473e28c1 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 @@ -76066,7 +76066,7 @@

    /cart/{identifier}

    Header parameters

    Accept

    -

    Use CartSummary only if you need additional product info (Product type, Content). If set, the Cart Summary is returned in XML or JSON format.

    +

    Use CartSummary only if you require additional product information (such as Product type or Content). Depending on the suffix set, the Cart Summary is returned in XML or JSON format.

    @@ -106823,7 +106823,7 @@
    Possible responses
    @@ -140357,11 +140357,8 @@
    Query parameters
  • type: action, parameter: value (the action)
  • type: logged_at, parameters: value and operator
      -
    • -logged_at value value can be anything accepted by DateTimeImmutable -
      • -
    • -logged_at operator value can be one of the following:
      • +
    • logged_at value value can be anything accepted by DateTimeImmutable
      • +
    • logged_at operator value can be one of the following:
    • -

    +

    Returned when invalid Criterion or Sort clause is used.