IBX-1430: Complete 4.4 REST API reference

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

@@ -0,0 +1,10 @@
+{
+    "CartViewInput": {
+        "identifier": "loadUserCarts",
+        "CartQuery": {
+            "offset": 0,
+            "limit": 10,
+            "ownerId": 123
+        }
+    }
+}

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-cart.raml

@@ -0,0 +1,132 @@
+displayName: Managing Commerce carts
+post:
+    displayName: Create Cart
+    description: Creates Cart from payload.
+    headers:
+        Content-Type:
+            description: The CartCreateStruct schema encoded in XML or JSON format.
+            example: |
+                application/vnd.ibexa.api.CartCreateStruct+xml
+                application/vnd.ibexa.api.CartCreateStruct+json
+    #body:
+    #    application/vnd.ibexa.api.CartCreateStruct+xml:
+    #        type: CartCreateStruct
+    #        example: !include examples/cart/POST/CartCreateStruct.json.example
+    #responses:
+    #    200:
+    #        body:
+    #            application/vnd.ibexa.api.Cart+json:
+    #                type: Cart
+    #                example: !include examples/cart/POST/Cart.json.example
+    #    400:
+    #        description: Error - The input does not match the input schema definition.
+/view:
+    post:
+        displayName: Filter carts
+        description: Executes a query and returns a View including the results.
+        headers:
+            Accept:
+                description: The CartView schema is returned in XML or JSON format.
+                example: |
+                    application/vnd.ibexa.api.CartView+xml
+                    application/vnd.ibexa.api.CartView+json
+            Content-Type:
+                description: The CartViewInput schema is posted in XML or JSON format.
+                example: |
+                    application/vnd.ibexa.api.CartViewInput+xml
+                    application/vnd.ibexa.api.CartViewInput+json
+        body:
+            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:
+/{identifier}:
+    get:
+        displayName: Get Cart
+        description: Gets Cart by its identifier.
+        responses:
+            200:
+                description: OK - return the cart
+                #body:
+                #    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:
+                description: Error - The identifier do not match any Cart.
+    delete:
+        displayName: Delete Cart
+        description: Deletes Cart by its identifier.
+    patch:
+        displayName: Update Cart's metadata
+        description: Updates identified Cart's metadata from payload.
+        headers:
+            Content-Type:
+                description: The CartMetadataUpdateStruct schema encoded in XML or JSON format.
+                example: |
+                    application/vnd.ibexa.api.CartMetadataUpdateStruct+xml        
+                    application/vnd.ibexa.api.CartMetadataUpdateStruct+json
+    /entry:
+        post:
+            displayName: Add Entry to Cart
+            description: Adds an the posted entry to the cart passed by identifier
+            headers:
+                Content-Type:
+                    description: The EntryAddStruct schema encoded in XML or JSON format.
+                    example: |
+                        application/vnd.ibexa.api.EntryAddStruct+xml
+                        application/vnd.ibexa.api.EntryAddStruct+json
+            #body:
+            #    application/vnd.ibexa.api.EntryAddStruct+xml:
+            #        type: EntryAddStruct
+            #        example: !include examples/cart/entry/POST/EntryAddStruct.json.example
+        /{entryId}:
+            delete:
+                displayName: Remove Entry from Cart
+                description: Removes the given entry from the given Cart.
+            patch:
+                displayName: Update Entry from Cart
+                description: Updates the given entry from the given Cart.
+                headers:
+                    Content-Type:
+                        description: The EntryUpdateStruct schema encoded in XML or JSON format.
+                        example: |
+                            application/vnd.ibexa.api.EntryUpdateStruct+xml
+                            application/vnd.ibexa.api.EntryUpdateStruct+json
+    /empty:
+        post:
+            displayName: Empty Cart
+            description: Empties the given Cart.
+            responses:
+                204:
+                    description: No Content - Cart emptied.
+                401:
+                    description: Error - The user is not authorized to empty this Cart.
+                404:
+                    description: Error - Cart not found.
+    /summary:
+        get:
+            displayName: Cart Summary
+            description: Gets a summary of the given Cart.
+            headers:
+                Accept:
+                    description: If set, the Cart Summary is returned in XML or JSON format.
+                    example: |
+                        application/vnd.ibexa.api.CartSummary+xml
+                        application/vnd.ibexa.api.CartSummary+json
+            responses:
+                200:
+                    body:
+                        application/vnd.ibexa.api.CountriesLis+json:
+                            type: CartSummary
+                            example: !include examples/cart/summary/CartSummary.json.example
+                401:
+                    description: Error - The user is not authorized to read this Cart.
+                404:
+                    description: Error - Cart not found.