IBX-1430: Complete 4.3 REST API reference

docs/api/rest_api/rest_api_reference/input/examples/taxonomy/GET/EntryAssignmentCollection.json.example

@@ -0,0 +1,118 @@
+{
+  "EntryAssignmentCollection": {
+    "_media-type": "application/vnd.ibexa.api.EntryAssignmentCollection+json",
+    "content": {
+      "_media-type": "application/vnd.ibexa.api.Content+json",
+      "Content": {
+        "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
+        "_href": "/api/ibexa/v2/content/objects/1",
+        "_remoteId": "9459d3c29e15006e45197295722c7ade",
+        "_id": 1,
+        "ContentType": {
+          "_media-type": "application/vnd.ibexa.api.ContentType+json",
+          "_href": "/api/ibexa/v2/content/types/1"
+        },
+        "Name": "Ibexa Platform",
+        "TranslatedName": "Ibexa Platform",
+        "Versions": {
+          "_media-type": "application/vnd.ibexa.api.VersionList+json",
+          "_href": "/api/ibexa/v2/content/objects/1/versions"
+        },
+        "CurrentVersion": {
+          "_media-type": "application/vnd.ibexa.api.Version+json",
+          "_href": "/api/ibexa/v2/content/objects/1/currentversion"
+        },
+        "Section": {
+          "_media-type": "application/vnd.ibexa.api.Section+json",
+          "_href": "/api/ibexa/v2/content/sections/1"
+        },
+        "Locations": {
+          "_media-type": "application/vnd.ibexa.api.LocationList+json",
+          "_href": "/api/ibexa/v2/content/objects/1/locations"
+        },
+        "Owner": {
+          "_media-type": "application/vnd.ibexa.api.User+json",
+          "_href": "/api/ibexa/v2/user/users/14"
+        },
+        "lastModificationDate": "2023-01-01T00:00:00+00:00",
+        "publishedDate": "2015-11-30T13:10:46+00:00",
+        "mainLanguageCode": "eng-GB",
+        "currentVersionNo": 10,
+        "alwaysAvailable": true,
+        "isHidden": false,
+        "status": "PUBLISHED",
+        "ObjectStates": {
+          "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json",
+          "_href": "/api/ibexa/v2/content/objects/1/objectstates"
+        }
+      }
+    },
+    "assignments": [
+      {
+        "_media-type": "application/vnd.ibexa.api.TaxonomyEntryAssignment+json",
+        "id": 1,
+        "content": {
+          "_media-type": "application/vnd.ibexa.api.Content+json",
+          "Content": {
+            "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
+            "_href": "/api/ibexa/v2/content/objects/1",
+            "_remoteId": "9459d3c29e15006e45197295722c7ade",
+            "_id": 1,
+            "ContentType": {
+              "_media-type": "application/vnd.ibexa.api.ContentType+json",
+              "_href": "/api/ibexa/v2/content/types/1"
+            },
+            "Name": "Ibexa Platform",
+            "TranslatedName": "Ibexa Platform",
+            "Versions": {
+              "_media-type": "application/vnd.ibexa.api.VersionList+json",
+              "_href": "/api/ibexa/v2/content/objects/1/versions"
+            },
+            "CurrentVersion": {
+              "_media-type": "application/vnd.ibexa.api.Version+json",
+              "_href": "/api/ibexa/v2/content/objects/1/currentversion"
+            },
+            "Section": {
+              "_media-type": "application/vnd.ibexa.api.Section+json",
+              "_href": "/api/ibexa/v2/content/sections/1"
+            },
+            "Locations": {
+              "_media-type": "application/vnd.ibexa.api.LocationList+json",
+              "_href": "/api/ibexa/v2/content/objects/1/locations"
+            },
+            "Owner": {
+              "_media-type": "application/vnd.ibexa.api.User+json",
+              "_href": "/api/ibexa/v2/user/users/14"
+            },
+            "lastModificationDate": "2023-01-01T00:00:00+00:00",
+            "publishedDate": "2015-11-30T13:10:46+00:00",
+            "mainLanguageCode": "eng-GB",
+            "currentVersionNo": 10,
+            "alwaysAvailable": true,
+            "isHidden": false,
+            "status": "PUBLISHED",
+            "ObjectStates": {
+              "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json",
+              "_href": "/api/ibexa/v2/content/objects/1/objectstates"
+            }
+          }
+        },
+        "entry": {
+          "_media-type": "application/vnd.ibexa.api.TaxonomyEntry+json",
+          "TaxonomyEntry": {
+            "_media-type": "application/vnd.ibexa.api.TaxonomyEntry+json",
+            "id": 3,
+            "identifier": "example",
+            "name": "Example",
+            "contentId": 65,
+            "content": {
+              "_media-type": "application/vnd.ibexa.api.Content+json",
+              "_href": "/api/ibexa/v2/content/objects/65"
+            },
+            "taxonomy": "tags"
+          }
+        }
+      }
+    ]
+  }
+}

docs/api/rest_api/rest_api_reference/input/examples/taxonomy/GET/EntryAssignmentCollection.xml.example

@@ -0,0 +1,56 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<EntryAssignmentCollection media-type="application/vnd.ibexa.api.EntryAssignmentCollection+xml">
+    <content media-type="application/vnd.ibexa.api.Content+xml">
+        <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/1" remoteId="9459d3c29e15006e45197295722c7ade" id="1">
+            <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1"/>
+            <Name>Ibexa Platform</Name>
+            <TranslatedName>Ibexa Platform</TranslatedName>
+            <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/1/versions"/>
+            <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/1/currentversion"/>
+            <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/1"/>
+            <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/1/locations"/>
+            <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
+            <lastModificationDate>2023-01-01T00:00:00+00:00</lastModificationDate>
+            <publishedDate>2015-11-30T13:10:46+00:00</publishedDate>
+            <mainLanguageCode>eng-GB</mainLanguageCode>
+            <currentVersionNo>10</currentVersionNo>
+            <alwaysAvailable>true</alwaysAvailable>
+            <isHidden>false</isHidden>
+            <status>PUBLISHED</status>
+            <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" href="/api/ibexa/v2/content/objects/1/objectstates"/>
+        </Content>
+    </content>
+    <TaxonomyEntryAssignment media-type="application/vnd.ibexa.api.TaxonomyEntryAssignment+xml">
+        <id>1</id>
+        <content media-type="application/vnd.ibexa.api.Content+xml">
+            <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/1" remoteId="9459d3c29e15006e45197295722c7ade" id="1">
+                <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1"/>
+                <Name>Ibexa Platform</Name>
+                <TranslatedName>Ibexa Platform</TranslatedName>
+                <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/1/versions"/>
+                <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/1/currentversion"/>
+                <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/1"/>
+                <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/1/locations"/>
+                <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
+                <lastModificationDate>2023-01-01T00:00:00+00:00</lastModificationDate>
+                <publishedDate>2015-11-30T13:10:46+00:00</publishedDate>
+                <mainLanguageCode>eng-GB</mainLanguageCode>
+                <currentVersionNo>10</currentVersionNo>
+                <alwaysAvailable>true</alwaysAvailable>
+                <isHidden>false</isHidden>
+                <status>PUBLISHED</status>
+                <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" href="/api/ibexa/v2/content/objects/1/objectstates"/>
+            </Content>
+        </content>
+        <entry media-type="application/vnd.ibexa.api.TaxonomyEntry+xml">
+            <TaxonomyEntry media-type="application/vnd.ibexa.api.TaxonomyEntry+xml">
+                <id>3</id>
+                <identifier>example</identifier>
+                <name>Example</name>
+                <contentId>65</contentId>
+                <content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/65"/>
+                <taxonomy>tags</taxonomy>
+            </TaxonomyEntry>
+        </entry>
+    </TaxonomyEntryAssignment>
+</EntryAssignmentCollection>

docs/api/rest_api/rest_api_reference/input/examples/taxonomy/entries/DELETE/TaxonomyEntryBulkRemove.json.example

@@ -0,0 +1,5 @@
+{
+    "TaxonomyEntryBulkRemove": {
+        "entries": [ 2, 3 ]
+    }
+}

docs/api/rest_api/rest_api_reference/input/examples/taxonomy/entries/move/POST/TaxonomyEntryBulkMove.json.example

@@ -0,0 +1,16 @@
+{
+    "TaxonomyEntryBulkMove": {
+        "entries": [
+            [
+                entry: 2,
+                sibling: 1,
+                position: 'next'
+            ],
+            [
+                entry: 3,
+                sibling: 1,
+                position: 'prev'
+            ],
+        ]
+    }
+}

docs/api/rest_api/rest_api_reference/input/ez-commerce.raml

@@ -166,6 +166,16 @@ displayName: eCommerce API
                         application/vnd.ibexa.api.Basket+json:
                             type: Basket
                             example: !include examples/commerce/basket/_id_/GET/Basket.json.example
+        delete:
+            displayName: Delete Basket by ID (removed)
+            description: Deletes basket by ID. Removed as of Ibexa DXP 4.4, use DELETE /cart/{identifier} instead.
+            responses:
+                200:
+                    description: OK - The basket has been deleted
+                400:
+                    description: Error - The basket does not exist
+                403:
+                    description: Error - Access denied
 
         /name:
             patch:
@@ -297,14 +307,15 @@ displayName: eCommerce API
                         example: !include examples/commerce/customerprice/POST/PriceResponse.json.example
 
 
-/common/check_sku_file:/{mode}:
+/common/check_sku_file/{mode}:
     post:
         displayName: Add to basket from CSV or Excel
         description: Adds to basket a line from a CSV or Excel file.
 
 /country:
     get:
-        displayName: Gets list of countries.
+        displayName: Get list of countries (deprecated)
+        description: Deprecated, use GET /services/countries instead.
         responses:
             200:
                 body:

docs/api/rest_api/rest_api_reference/input/ez-content-object.raml → docs/api/rest_api/rest_api_reference/input/ez-content-objects.raml

@@ -592,3 +592,25 @@ get:
                     description: Error - The input contains multiple Object states of the same Object state group.
                 412:
                     description: Error - The current ETag does not match the one provided in the If-Match header.
+    /hide:
+        post:
+            displayName: Hide Content item
+            description: Makes or keep the Content item invisible
+            responses:
+                204:
+                    description: OK - Object item is hidden.
+                401:
+                    description: Error - The user has no permission to change Object item visibility.
+                404:
+                    description: Error - The Content item was not found.
+    /reveal:
+        post:
+            displayName: Reveal Content item
+            description: Makes or keep the Content item visible
+            responses:
+                204:
+                    description: OK - Object item is revealed.
+                401:
+                    description: Error - The user has no permission to change Object item visibility.
+                404:
+                    description: Error - The Content item was not found.

docs/api/rest_api/rest_api_reference/input/ez-content-trash.raml

@@ -32,7 +32,7 @@ delete:
             description: No Content - Trash emptied.
         401:
             description: Error - The user is not authorized to empty all items from Trash.
-/{trashItemid}:
+/{trashItemId}:
     get:
         displayName: Get Trash item
         description: Returns the item in Trash with the provided ID.

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

@@ -119,6 +119,14 @@ get:
             404:
                 description: Error - The Content Type does not exist.
     /fieldDefinitions:
+        get:
+            displayName: Get Field definition list
+            description: Returns all Field definitions of the provided Content Type.
+            responses:
+                200:
+                    description: OK - return a list of Field definitions.
+                404:
+                    description: Error - The Content Type does not exist.
         /{fieldDefinitionId}:
             get:
                 displayName: Get Field definition
@@ -144,6 +152,27 @@ get:
                     404:
                         description: Error - The Content Type does not exist.
     /draft:
+        get:
+            displayName: Get Content Type draft
+            description: Returns the draft of the Content Type with the provided ID.
+            headers:
+                Accept:
+                    description: If set, the Content Type is returned in XML or JSON format.
+                    example: |
+                        application/vnd.ibexa.api.ContentType+xml
+                        application/vnd.ibexa.api.ContentType+json
+            responses:
+                200:
+                    body:
+                        application/vnd.ibexa.api.ContentType+xml:
+                            type: ContentType
+                        application/vnd.ibexa.api.ContentType+json:
+                            type: ContentType
+                    description: OK - returns the Content Type.
+                401:
+                    description: Error - The user is not authorized to read this Content Type.
+                404:
+                    description: Error - The Content Type does not exist or does not have a draft.
         patch:
             displayName: Update Content Type draft
             description: Updates metadata of a draft. This method does not handle Field definitions. PATCH or POST with header X-HTTP-Method-Override PATCH.
@@ -211,6 +240,14 @@ get:
                 404:
                     description: Error - The Content Type draft does not exist.
         /fieldDefinitions:
+            get:
+                displayName: Get Draft Field definition list
+                description: Returns all Field definitions of the provided Content Type Draft.
+                responses:
+                    200:
+                        description: OK - return a list of Field definitions.
+                    404:
+                        description: Error - The Content Type draft does not exist.
             post:
                 displayName: Add Content Type Draft Field definition
                 description: Creates a new Field definition for the given Content Type.

docs/api/rest_api/rest_api_reference/input/ez-content-views.raml

@@ -1,6 +1,6 @@
 post:
-    displayName: Create View
-    description: Executes a query and returns View including the results. The View input reflects the criteria model of the public API. Will respond with a 301, as the resource has been moved to /views (Platform 1.0) - DEPRECATED.
+    displayName: Create View (deprecated)
+    description: Executes a query and returns View including the results. The View input reflects the criteria model of the public API. Deprecated as of eZ Platform 1.0 and will respond 301, use POST /views instead.
     headers:
         Accept:
             description: The View in XML or JSON format.

docs/api/rest_api/rest_api_reference/input/ez-product-attributegroups.raml

@@ -1,6 +1,6 @@
 get:
-    displayName: Load attribute groups (deprecated as of Ibexa DXP 4.3, use /view instead)
-    description: Returns a list of attribute groups.
+    displayName: Load attribute groups (deprecated)
+    description: Returns a list of attribute groups. Deprecated as of Ibexa DXP 4.3, use POST /product/catalog/attribute_groups/view instead.
     body:
         application/vnd.ibexa.api.AttributeGroupList+json:
             type: AttributeGroup
@@ -145,7 +145,7 @@ post:
         responses:
             200:
                 body:
-                    application/vnd.ibexa.api.AttributeGroupView+json;
+                    application/vnd.ibexa.api.AttributeGroupView+json:
                         type: AttributeGroupView
                         example: !include examples/product/catalog/attribute_groups/POST/AttributeGroupView.json.example
             400:

docs/api/rest_api/rest_api_reference/input/ez-product-attributes.raml

@@ -100,8 +100,8 @@ post:
             401:
                 description: Error - the user is not authorized to delete this translation.
 get:
-    displayName: Load attributes (deprecated as of Ibexa DXP 4.3, use /view instead)
-    description: Loads list of all attributes.
+    displayName: Load attributes (deprecated)
+    description: Loads list of all attributes. Deprecated as of Ibexa DXP 4.3, use POST /product/catalog/attributes/view instead.
     headers:
         Accept:
             description: AttributeList - If set, the attributes list is returned in XML or JSON format.
@@ -145,7 +145,7 @@ get:
         responses:
             200:
                 body:
-                    application/vnd.ibexa.api.AttributeView+json;
+                    application/vnd.ibexa.api.AttributeView+json:
                         type: AttributeView
                         example: !include examples/product/catalog/attributes/POST/AttributeView.json.example
             400: