ibexa · adriendupuis · Jun 6, 2024 · Apr 23, 2024 · Apr 23, 2024 · Apr 23, 2024
diff --git a/...lendar/event/GET/ContentInfo.json.example → ...calendar/event/GET/EventList.json.example b/...lendar/event/GET/ContentInfo.json.example → ...calendar/event/GET/EventList.json.example
diff --git a/...alendar/event/GET/ContentInfo.xml.example → .../calendar/event/GET/EventList.xml.example b/...alendar/event/GET/ContentInfo.xml.example → .../calendar/event/GET/EventList.xml.example
diff --git a/...e/POST/UnscheduleActionInput.json.example → ...publication.UnscheduleAction.json.example b/...e/POST/UnscheduleActionInput.json.example → ...publication.UnscheduleAction.json.example
diff --git a/...ouped-by-day/GET/ContentInfo.json.example → ...ed-by-day/GET/EventGroupList.json.example b/...ouped-by-day/GET/ContentInfo.json.example → ...ed-by-day/GET/EventGroupList.json.example
diff --git a/...rouped-by-day/GET/ContentInfo.xml.example → ...ped-by-day/GET/EventGroupList.xml.example b/...rouped-by-day/GET/ContentInfo.xml.example → ...ped-by-day/GET/EventGroupList.xml.example
diff --git a/...ference/input/examples/content/objectstategroups/POST/ObjectStateGroupCreate.json.example b/...ference/input/examples/content/objectstategroups/POST/ObjectStateGroupCreate.json.example
@@ -1,5 +1,5 @@
 {
-    "ObjectStateGroup": {
+    "ObjectStateGroupCreate": {
         "identifier": "custom-states",
         "defaultLanguageCode": "eng-GB",
         "names": {

diff --git a/...eference/input/examples/content/objectstategroups/POST/ObjectStateGroupCreate.xml.example b/...eference/input/examples/content/objectstategroups/POST/ObjectStateGroupCreate.xml.example
@@ -8,4 +8,4 @@
     <descriptions>
         <value languageCode="eng-GB">Custom Object state</value>
     </descriptions>
-</ObjectStateGroup>
+</ObjectStateGroupCreate>
diff --git a/...s/id/DELETE/ContentTypeGroup.json.example → ...LETE/ContentTypeGroupRefList.json.example b/...s/id/DELETE/ContentTypeGroup.json.example → ...LETE/ContentTypeGroupRefList.json.example
diff --git a/...ps/id/DELETE/ContentTypeGroup.xml.example → ...ELETE/ContentTypeGroupRefList.xml.example b/...ps/id/DELETE/ContentTypeGroup.xml.example → ...ELETE/ContentTypeGroupRefList.xml.example
diff --git a/...nce/input/examples/product/catalog/attribute_groups/id/GET/AttributeGroupGet.json.example b/...nce/input/examples/product/catalog/attribute_groups/id/GET/AttributeGroupGet.json.example
@@ -1,4 +1,3 @@
-//optional
 {
     "AttributeGroupGet": {
         "languages": ["eng-GB"]

diff --git a/...est_api_reference/input/examples/product/catalog/product/code/GET/ProductGet.json.example b/...est_api_reference/input/examples/product/catalog/product/code/GET/ProductGet.json.example
@@ -1,4 +1,3 @@
-//optional
 {
     "ProductGet": {
         "languages": [

diff --git a/...st_api/rest_api_reference/input/examples/segment_groups/GET/SegmentGroupList.json.example b/...st_api/rest_api_reference/input/examples/segment_groups/GET/SegmentGroupList.json.example
@@ -0,0 +1,15 @@
+{
+    "SegmentGroupList": {
+        "_media-type": "application\/vnd.ibexa.api.SegmentGroupList+json",
+        "_href": "\/api\/ibexa\/v2\/segment_groups",
+        "SegmentGroup": [
+            {
+                "_media-type": "application\/vnd.ibexa.api.SegmentGroup+json",
+                "_href": "\/api\/ibexa\/v2\/segment_groups\/corporate_accounts",
+                "id": 1,
+                "identifier": "corporate_accounts",
+                "name": "Corporate Accounts"
+            }
+        ]
+    }
+}
diff --git a/...est_api/rest_api_reference/input/examples/segment_groups/GET/SegmentGroupList.xml.example b/...est_api/rest_api_reference/input/examples/segment_groups/GET/SegmentGroupList.xml.example
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<SegmentGroupList media-type="application/vnd.ibexa.api.SegmentGroupList+xml" href="/api/ibexa/v2/segment_groups">
+ <SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts">
+  <id>1</id>
+  <identifier>corporate_accounts</identifier>
+  <name>Corporate Accounts</name>
+ </SegmentGroup>
+</SegmentGroupList>
diff --git a/...rest_api_reference/input/examples/segment_groups/identifier/GET/SegmentGroup.json.example b/...rest_api_reference/input/examples/segment_groups/identifier/GET/SegmentGroup.json.example
@@ -0,0 +1,9 @@
+{
+    "SegmentGroup": {
+        "_media-type": "application\/vnd.ibexa.api.SegmentGroup+json",
+        "_href": "\/api\/ibexa\/v2\/segment_groups\/corporate_accounts",
+        "id": 1,
+        "identifier": "corporate_accounts",
+        "name": "Corporate Accounts"
+    }
+}
diff --git a/.../rest_api_reference/input/examples/segment_groups/identifier/GET/SegmentGroup.xml.example b/.../rest_api_reference/input/examples/segment_groups/identifier/GET/SegmentGroup.xml.example
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts">
+ <id>1</id>
+ <identifier>corporate_accounts</identifier>
+ <name>Corporate Accounts</name>
+</SegmentGroup>
diff --git a/..._reference/input/examples/segment_groups/identifier/segments/GET/SegmentList.json.example b/..._reference/input/examples/segment_groups/identifier/segments/GET/SegmentList.json.example
@@ -0,0 +1,7 @@
+{
+    "SegmentList": {
+        "_media-type": "application\/vnd.ibexa.api.SegmentList+json",
+        "_href": "\/api\/ibexa\/v2\/segment_groups\/corporate_accounts\/segments",
+        "Segment": []
+    }
+}
diff --git a/...i_reference/input/examples/segment_groups/identifier/segments/GET/SegmentList.xml.example b/...i_reference/input/examples/segment_groups/identifier/segments/GET/SegmentList.xml.example
@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<SegmentList media-type="application/vnd.ibexa.api.SegmentList+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts/segments"/>
diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-calendar.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-calendar.raml
@@ -26,17 +26,17 @@ displayName: Calendar
             Accept:
                 description: If set, the calendar event list is returned in XML or JSON format.
                 example:  |
-                    application/vnd.ibexa.api.ContentInfo+xml
-                    application/vnd.ibexa.api.ContentInfo+json
+                    application/vnd.ibexa.api.EventList+xml
+                    application/vnd.ibexa.api.EventList+json
         responses:
             200:
                 body:
-                    application/vnd.ibexa.api.ContentInfo+xml:
-                        type: ContentInfo
-                        example: !include examples/calendar/event/GET/ContentInfo.xml.example
-                    application/vnd.ibexa.api.ContentInfo+json:
-                        type: ContentInfo
-                        example: !include examples/calendar/event/GET/ContentInfo.json.example
+                    application/vnd.ibexa.api.EventList+xml:
+                        type: EventList
+                        example: !include examples/calendar/event/GET/EventList.xml.example
+                    application/vnd.ibexa.api.EventList+json:
+                        type: EventList
+                        example: !include examples/calendar/event/GET/EventList.json.example
     /grouped-by-day:
         get:
             displayName: Calendar list grouped by day
@@ -64,17 +64,17 @@ displayName: Calendar
                 Accept:
                     description: If set, the calendar event list grouped by day is returned in XML or JSON format.
                     example:  |
-                        application/vnd.ibexa.api.ScheduledVersion+xml
-                        application/vnd.ibexa.api.ScheduledVersion+json
+                        application/vnd.ibexa.api.EventGroupList+xml
+                        application/vnd.ibexa.api.EventGroupList+json
             responses:
                 200:
                     body:
-                        application/vnd.ibexa.api.ContentInfo+xml:
-                            type: ContentInfo
-                            example: !include examples/calendar/event/grouped-by-day/GET/ContentInfo.xml.example
-                        application/vnd.ibexa.api.ContentInfo+json:
-                            type: ContentInfo
-                            example: !include examples/calendar/event/grouped-by-day/GET/ContentInfo.json.example
+                        application/vnd.ibexa.api.EventGroupList+xml:
+                            type: EventGroupList
+                            example: !include examples/calendar/event/grouped-by-day/GET/EventGroupList.xml.example
+                        application/vnd.ibexa.api.EventGroupList+json:
+                            type: EventGroupList
+                            example: !include examples/calendar/event/grouped-by-day/GET/EventGroupList.json.example
     /{eventType}:
         post:
             displayName: Calendar action
@@ -83,10 +83,13 @@ displayName: Calendar
                 Content-Type:
                     example:  |
                         application/vnd.ibexa.api.calendar.future_publication.UnscheduleAction+json
+                        application/vnd.ibexa.api.calendar.future_hide.UnscheduleAction+json
             body:
-                application/vnd.ibexa.api.UnscheduleActionInput+json:
-                    type: RoleAssignInput
-                    example: !include examples/calendar/event/eventType/POST/UnscheduleActionInput.json.example
+                application/vnd.ibexa.api.calendar.future_publication.UnscheduleAction+json:
+                    type: UnscheduleAction
+                    example: !include examples/calendar/event/eventType/POST/future_publication.UnscheduleAction.json.example
+                application/vnd.ibexa.api.calendar.future_hide.UnscheduleAction+json:
+                    type: UnscheduleAction
             responses:
                 204:
                     description: No Content - the action has been unscheduled.
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
@@ -8,13 +8,22 @@ post:
             example: |
                 application/vnd.ibexa.api.CartCreate+xml
                 application/vnd.ibexa.api.CartCreate+json
+        Accept:
+            description: If set, the created 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.CartCreate+xml:
+            type: CartCreate
         application/vnd.ibexa.api.CartCreate+json:
             type: CartCreate
             example: !include examples/cart/POST/CartCreate.json.example
     responses:
         200:
             body:
+                application/vnd.ibexa.api.Cart+xml:
+                    type: Cart
                 application/vnd.ibexa.api.Cart+json:
                     type: Cart
                     example: !include examples/cart/POST/Cart.json.example
@@ -36,26 +45,38 @@ post:
                     application/vnd.ibexa.api.CartViewInput+xml
                     application/vnd.ibexa.api.CartViewInput+json
         body:
+            application/vnd.ibexa.api.CartViewInput+xml:
+                type: CartViewInput
             application/vnd.ibexa.api.CartViewInput+json:
                 type: CartViewInput
                 example: !include examples/cart/view/CartViewInput.json.example
         responses:
             200:
                 description: OK - returns a view and its results
-                #body:
-                #    application/vnd.ibexa.api.CartView+xml:
-                #    application/vnd.ibexa.api.CartView+json:
+                body:
+                    application/vnd.ibexa.api.CartView+xml:
+                        type: CartView
+                    application/vnd.ibexa.api.CartView+json:
+                        type: CartView
 /{identifier}:
     get:
         displayName: Get Cart
         description: Gets Cart by its identifier.
+        headers:
+            Accept:
+                description: The Cart is returned in XML or JSON format.
+                example: |
+                    application/vnd.ibexa.api.Cart+xml
+                    application/vnd.ibexa.api.Cart+json
         responses:
             200:
                 description: OK - return the cart
-                #body:
-                #    application/vnd.ibexa.api.Cart+json:
-                #        type: Cart
-                #        example: !include examples/cart/POST/Cart.json.example
+                body:
+                    application/vnd.ibexa.api.Cart+xml:
+                        type: Cart
+                    application/vnd.ibexa.api.Cart+json:
+                        type: Cart
+                        example: !include examples/cart/POST/Cart.json.example
             401:
                 description: Error - the user is not authorized to get this cart.
             404:
@@ -68,10 +89,15 @@ post:
         description: Updates identified Cart's metadata from payload.
         headers:
             Content-Type:
-                description: The CartMetadataUpdateStruct schema encoded in XML or JSON format.
+                description: The CartMetadataUpdate schema encoded in XML or JSON format.
                 example: |
-                    application/vnd.ibexa.api.CartMetadataUpdateStruct+xml
-                    application/vnd.ibexa.api.CartMetadataUpdateStruct+json
+                    application/vnd.ibexa.api.CartMetadataUpdate+xml
+                    application/vnd.ibexa.api.CartMetadataUpdate+json
+        body:
+            application/vnd.ibexa.api.CartMetadataUpdate+xml:
+                type: CartMetadataUpdate
+            application/vnd.ibexa.api.CartMetadataUpdate+json:
+                type: CartMetadataUpdate
     /entry:
         post:
             displayName: Add Entry to Cart
@@ -85,6 +111,8 @@ post:
             body:
                 application/vnd.ibexa.api.CartEntryAdd+xml:
                     type: CartEntryAdd
+                application/vnd.ibexa.api.CartEntryAdd+json:
+                    type: CartEntryAdd
                     example: !include examples/cart/entry/POST/CartEntryAdd.json.example
         /{entryId}:
             delete:
@@ -95,10 +123,15 @@ post:
                 description: Updates the given entry from the given Cart.
                 headers:
                     Content-Type:
-                        description: The EntryUpdateStruct schema encoded in XML or JSON format.
+                        description: The CartEntryUpdate schema encoded in XML or JSON format.
                         example: |
-                            application/vnd.ibexa.api.EntryUpdateStruct+xml
-                            application/vnd.ibexa.api.EntryUpdateStruct+json
+                            application/vnd.ibexa.api.CartEntryUpdate+xml
+                            application/vnd.ibexa.api.CartEntryUpdate+json
+                body:
+                    application/vnd.ibexa.api.CartEntryUpdate+xml:
+                        type: CartEntryUpdate
+                    application/vnd.ibexa.api.CartEntryUpdate+json:
+                        type: CartEntryUpdate
     /empty:
         post:
             displayName: Empty Cart
@@ -123,7 +156,9 @@ post:
             responses:
                 200:
                     body:
-                        application/vnd.ibexa.api.CountriesLis+json:
+                        application/vnd.ibexa.api.CartSummary+xml:
+                            type: CartSummary
+                        application/vnd.ibexa.api.CartSummary+json:
                             type: CartSummary
                             example: !include examples/cart/summary/CartSummary.json.example
                 401:

diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-content-binary.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-content-binary.raml
@@ -7,14 +7,16 @@ displayName: content/binary/name
             Accept:
                 description: If set, the image is returned in XML or JSON format.
                 example:  |
-                    application/vnd.ibexa.api.ImageVariation+xml
-                    application/vnd.ibexa.api.ImageVariation+json
+                    application/vnd.ibexa.api.ContentImageVariation+xml
+                    application/vnd.ibexa.api.ContentImageVariation+json
         responses:
             200:
                 body:
-                    application/vnd.ibexa.api.ImageVariation+xml:
+                    application/vnd.ibexa.api.ContentImageVariation+xml:
                         type: ContentImageVariation
                         example: !include examples/content/binary/images/image_id/variations/variation_identifier/GET/ImageVariation.xml.example
+                    application/vnd.ibexa.api.ContentImageVariation+json:
+                        type: ContentImageVariation
             401:
                 description: Error - the user is not authorized to read this content item.
             404:

diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-content-locations.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-content-locations.raml
@@ -8,6 +8,11 @@ get:
             description: The remote ID of the Location. If present, the Location with the given remote ID is returned.
         urlAlias:
             description: One of the URL aliases of the Location. If present, the Location with given URL Alias is returned.
+    headers:
+        Accept:
+            example: |
+                application/vnd.ibexa.api.LocationList+xml
+                application/vnd.ibexa.api.LocationList+json
     responses:
         307:
             description: Temporary redirect to the main resource URL.
@@ -156,6 +161,8 @@ get:
                         application/vnd.ibexa.api.LocationList+xml:
                             type: LocationList
                             example: !include examples/content/locations/path/children/GET/LocationList.xml.example
+                        application/vnd.ibexa.api.LocationList+json:
+                            type: LocationList
                 401:
                     description: Error - the user is not authorized to read this content item.
                 404:
@@ -180,7 +187,9 @@ get:
                     body:
                         application/vnd.ibexa.api.UrlAliasRefList+xml:
                             type: UrlAliasRefList
-                            exammple: examples/content/locations/path/urlaliases/GET/UrlAliasRefList.xml.example
+                            example: examples/content/locations/path/urlaliases/GET/UrlAliasRefList.xml.example
+                        application/vnd.ibexa.api.UrlAliasRefList+json:
+                            type: UrlAliasRefList
                 400:
                     description: Error - The user has no permission to read URL aliases.
                 401:

diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-content-objects.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-content-objects.raml
@@ -78,10 +78,11 @@ get:
                     application/vnd.ibexa.api.Content+json:
                         type: Content
                         example: !include examples/content/objects/content_id/GET/Content.json.example
-
                     application/vnd.ibexa.api.ContentInfo+xml:
                         type: ContentInfo
                         example: !include examples/content/objects/content_id/GET/ContentInfo.xml.example
+                    application/vnd.ibexa.api.ContentInfo+json:
+                        type: ContentInfo
             401:
                 description: Error - the user is not authorized to read this object. This could also happen if there is no published version yet and another user owns a draft of this content item.
             404:
@@ -107,12 +108,16 @@ get:
             application/vnd.ibexa.api.ContentUpdate+xml:
                 type: ContentInfo
                 example: !include examples/content/objects/content_id/PATCH/ContentUpdate.xml.example
+            application/vnd.ibexa.api.ContentUpdate+json:
+                type: ContentInfo
         responses:
             200:
                 body:
                     application/vnd.ibexa.api.ContentInfo+xml:
                         type: ContentInfo
                         example: !include examples/content/objects/content_id/PATCH/ContentInfo.xml.example
+                    application/vnd.ibexa.api.ContentInfo+json:
+                        type: ContentInfo
             400:
                 description: Error - the input does not match the input schema definition.
             401:
@@ -286,12 +291,16 @@ get:
                     application/vnd.ibexa.api.VersionUpdate+xml:
                         type: VersionUpdate
                         example: !include examples/content/objects/content_id/versions/version_no/PATCH/VersionUpdate.xml.example
+                    application/vnd.ibexa.api.VersionUpdate+json:
+                        type: VersionUpdate
                 responses:
                     200:
                         body:
                             application/vnd.ibexa.api.Version+xml:
                                 type: Version
                                 example: !include examples/content/objects/content_id/versions/version_no/PATCH/Version.xml.example
+                            application/vnd.ibexa.api.Version+json:
+                                type: Version
                     400:
                         description: Error - the input does not match the input schema definition.
                     401:
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		<?xml version="1.0" encoding="UTF-8"?>
		<SegmentList media-type="application/vnd.ibexa.api.SegmentList+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts/segments"/>