From 17629f5e196581c939ec973f214e014b68ac8c73 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis Date: Thu, 2 Mar 2023 15:51:57 +0100 Subject: [PATCH 01/21] Rename few *.raml to correspond w/ their routes MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit /content/objects: ez-content-object.raml → ez-content-objects.raml /content/locations: ez-content-location.raml → ez-content-location.raml /content/sections: ez-content-section.raml → ez-content-sections.raml --- ...ez-content-location.raml => ez-content-locations.raml} | 0 .../{ez-content-object.raml => ez-content-objects.raml} | 0 .../{ez-content-section.raml => ez-content-sections.raml} | 0 docs/api/rest_api/rest_api_reference/input/ez.raml | 8 +++----- 4 files changed, 3 insertions(+), 5 deletions(-) rename docs/api/rest_api/rest_api_reference/input/{ez-content-location.raml => ez-content-locations.raml} (100%) rename docs/api/rest_api/rest_api_reference/input/{ez-content-object.raml => ez-content-objects.raml} (100%) rename docs/api/rest_api/rest_api_reference/input/{ez-content-section.raml => ez-content-sections.raml} (100%) diff --git a/docs/api/rest_api/rest_api_reference/input/ez-content-location.raml b/docs/api/rest_api/rest_api_reference/input/ez-content-locations.raml similarity index 100% rename from docs/api/rest_api/rest_api_reference/input/ez-content-location.raml rename to docs/api/rest_api/rest_api_reference/input/ez-content-locations.raml diff --git a/docs/api/rest_api/rest_api_reference/input/ez-content-object.raml b/docs/api/rest_api/rest_api_reference/input/ez-content-objects.raml similarity index 100% rename from docs/api/rest_api/rest_api_reference/input/ez-content-object.raml rename to docs/api/rest_api/rest_api_reference/input/ez-content-objects.raml diff --git a/docs/api/rest_api/rest_api_reference/input/ez-content-section.raml b/docs/api/rest_api/rest_api_reference/input/ez-content-sections.raml similarity index 100% rename from docs/api/rest_api/rest_api_reference/input/ez-content-section.raml rename to docs/api/rest_api/rest_api_reference/input/ez-content-sections.raml diff --git a/docs/api/rest_api/rest_api_reference/input/ez.raml b/docs/api/rest_api/rest_api_reference/input/ez.raml index 0926edb81f..b2ff803496 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez.raml @@ -10,11 +10,11 @@ version: v3.3.2 /content: displayName: Managing content - /objects: !include ez-content-object.raml + /objects: !include ez-content-objects.raml /objectstategroups: !include ez-objectstategroups.raml - /locations: !include ez-content-location.raml + /locations: !include ez-content-locations.raml /views: !include ez-content-views.raml - /sections: !include ez-content-section.raml + /sections: !include ez-content-sections.raml /trash: !include ez-content-trash.raml /urlaliases: !include ez-content-urlaliases.raml /urlwildcards: !include ez-content-urlwildcards.raml @@ -58,5 +58,3 @@ version: v3.3.2 /taxonomy: !include ez-taxonomy.raml types: !include ez-types.raml - - From 76f386d7324e537ba9a94b73bbb683d0e4f0cf67 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis Date: Thu, 2 Mar 2023 16:06:00 +0100 Subject: [PATCH 02/21] ez-commerce.raml: Add DELETE /commerce/basket/{basketId} --- .../rest_api/rest_api_reference/input/ez-commerce.raml | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/api/rest_api/rest_api_reference/input/ez-commerce.raml b/docs/api/rest_api/rest_api_reference/input/ez-commerce.raml index 7e5e05c283..be67e266c5 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-commerce.raml +++ b/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: From 4bee527b9a07f9f3b08f24a8c50d85c31525311b Mon Sep 17 00:00:00 2001 From: Adrien Dupuis Date: Thu, 2 Mar 2023 16:14:03 +0100 Subject: [PATCH 03/21] ez-content-types.raml: Add 3 GET /content/types/{contentTypeId}/* Add GET /content/types/{contentTypeId}/fieldDefinitions Add GET /content/types/{contentTypeId}/draft Add GET /content/types/{contentTypeId}/draft/fieldDefinitions --- .../input/ez-content-types.raml | 37 +++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/docs/api/rest_api/rest_api_reference/input/ez-content-types.raml b/docs/api/rest_api/rest_api_reference/input/ez-content-types.raml index d9c222fc64..5e4db23fdc 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-content-types.raml +++ b/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. From f62cf6c0057be60e59aca3b97b2ac49209be4529 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis Date: Thu, 2 Mar 2023 16:17:49 +0100 Subject: [PATCH 04/21] *.raml: Fix semi-colon instead of colon syntax errors --- .../input/ez-product-attributegroups.raml | 2 +- .../input/ez-product-attributes.raml | 2 +- .../input/ez-product-catalogs.raml | 4 +-- .../input/ez-product-currency.raml | 2 +- .../input/ez-product-customergroups.raml | 2 +- .../input/ez-product-products.raml | 2 +- .../input/ez-product-producttypes.raml | 2 +- .../input/ez-product-productvariants.raml | 2 +- .../input/ez-product-regions.raml | 2 +- .../rest_api_reference/input/ez-types.raml | 29 +++++++++++++++++++ 10 files changed, 39 insertions(+), 10 deletions(-) diff --git a/docs/api/rest_api/rest_api_reference/input/ez-product-attributegroups.raml b/docs/api/rest_api/rest_api_reference/input/ez-product-attributegroups.raml index fd37319087..1297028061 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-product-attributegroups.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-product-attributegroups.raml @@ -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: diff --git a/docs/api/rest_api/rest_api_reference/input/ez-product-attributes.raml b/docs/api/rest_api/rest_api_reference/input/ez-product-attributes.raml index f2421cdf42..9a51257c0e 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-product-attributes.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-product-attributes.raml @@ -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: diff --git a/docs/api/rest_api/rest_api_reference/input/ez-product-catalogs.raml b/docs/api/rest_api/rest_api_reference/input/ez-product-catalogs.raml index 46a154ab1e..c64668e346 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-product-catalogs.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-product-catalogs.raml @@ -142,7 +142,7 @@ post: responses: 200: body: - application/vnd.ibexa.api.CatalogView+json; + application/vnd.ibexa.api.CatalogView+json: type: ProductView example: !include examples/product/catalog/catalog/POST/CatalogView.json.example 400: @@ -170,7 +170,7 @@ post: responses: 200: body: - application/vnd.ibexa.api.ProductView+json; + application/vnd.ibexa.api.ProductView+json: type: ProductView example: !include examples/product/catalog/catalog/POST/CatalogProductsView.json.example 400: diff --git a/docs/api/rest_api/rest_api_reference/input/ez-product-currency.raml b/docs/api/rest_api/rest_api_reference/input/ez-product-currency.raml index 3b962227a2..266f1d5a3c 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-product-currency.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-product-currency.raml @@ -128,7 +128,7 @@ get: responses: 200: body: - application/vnd.ibexa.api.CurrencyView+json; + application/vnd.ibexa.api.CurrencyView+json: type: CurrencyView example: !include examples/product/catalog/currency/POST/CurrencyView.json.example 400: diff --git a/docs/api/rest_api/rest_api_reference/input/ez-product-customergroups.raml b/docs/api/rest_api/rest_api_reference/input/ez-product-customergroups.raml index ef504aa74c..cb6f157610 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-product-customergroups.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-product-customergroups.raml @@ -125,7 +125,7 @@ post: responses: 200: body: - application/vnd.ibexa.api.CustomerGroupView+json; + application/vnd.ibexa.api.CustomerGroupView+json: type: CustomerGroupView example: !include examples/product/catalog/customer_groups/POST/CustomerGroupView.json.example 400: diff --git a/docs/api/rest_api/rest_api_reference/input/ez-product-products.raml b/docs/api/rest_api/rest_api_reference/input/ez-product-products.raml index b735fdc28b..a2806f1a01 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-product-products.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-product-products.raml @@ -141,7 +141,7 @@ get: responses: 200: body: - application/vnd.ibexa.api.ProductView+json; + application/vnd.ibexa.api.ProductView+json: type: ProductView example: !include examples/product/catalog/product/POST/ProductView.json.example 400: diff --git a/docs/api/rest_api/rest_api_reference/input/ez-product-producttypes.raml b/docs/api/rest_api/rest_api_reference/input/ez-product-producttypes.raml index 491ce8d8ec..a579a48961 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-product-producttypes.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-product-producttypes.raml @@ -143,7 +143,7 @@ get: responses: 200: body: - application/vnd.ibexa.api.ProductTypeView+json; + application/vnd.ibexa.api.ProductTypeView+json: type: ProductTypeView example: !include examples/product/catalog/product_types/POST/ProductTypeView.json.example 400: diff --git a/docs/api/rest_api/rest_api_reference/input/ez-product-productvariants.raml b/docs/api/rest_api/rest_api_reference/input/ez-product-productvariants.raml index b503c98617..1588ee4450 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-product-productvariants.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-product-productvariants.raml @@ -115,7 +115,7 @@ responses: 200: body: - application/vnd.ibexa.api.ProductVariantView+json; + application/vnd.ibexa.api.ProductVariantView+json: type: ProductVariantView example: !include examples/product/catalog/product_variants/POST/ProductVariantView.json.example 400: diff --git a/docs/api/rest_api/rest_api_reference/input/ez-product-regions.raml b/docs/api/rest_api/rest_api_reference/input/ez-product-regions.raml index c013130829..a2ef25b468 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-product-regions.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-product-regions.raml @@ -40,7 +40,7 @@ get: responses: 200: body: - application/vnd.ibexa.api.RegionView+json; + application/vnd.ibexa.api.RegionView+json: type: RegionView example: !include examples/product/catalog/regions/POST/RegionView.json.example 400: diff --git a/docs/api/rest_api/rest_api_reference/input/ez-types.raml b/docs/api/rest_api/rest_api_reference/input/ez-types.raml index 85e45bfa17..f26d2a7d1e 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-types.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-types.raml @@ -2306,6 +2306,9 @@ CurrencyCreate: CurrencyUpdate: type: object +CurrencyView: + type: object + Region: type: object description: '' @@ -2334,6 +2337,10 @@ AttributeGroupViewInput: type: object description: '' +AttributeGroupView: + type: object + description: '' + Attribute: type: object description: '' @@ -2354,6 +2361,10 @@ AttributeViewInput: type: object description: '' +AttributeView: + type: object + description: '' + CustomerGroup: type: object description: '' @@ -2374,6 +2385,9 @@ CustomerGroupViewInput: type: object description: '' +CustomerGroupView: + type: object + CurrencyViewInput: type: object description: '' @@ -2398,6 +2412,10 @@ ProductTypeViewInput: type: object description: '' +ProductTypeView: + type: object + description: '' + Product: type: object description: '' @@ -2426,6 +2444,10 @@ ProductViewInput: type: object description: '' +ProductView: + type: object + description: '' + ProductVariant: type: object description: '' @@ -2446,10 +2468,16 @@ ProductVariantViewInput: type: object description: '' +ProductVariantView: + type: object + RegionViewInput: type: object description: '' +RegionView: + type: object + ProductTypeList: type: object description: @@ -2465,6 +2493,7 @@ TaxonomyEntryUnassignFromContent: VatCategoryList: type: object description: '' + VatCategory: type: object description: '' From 9d6b6310721f6d565e32a1ef8f2a2aa9de552357 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis Date: Thu, 2 Mar 2023 16:29:32 +0100 Subject: [PATCH 05/21] ez-commerce.raml: Fix POST /common/check_sku_file/{mode} route --- docs/api/rest_api/rest_api_reference/input/ez-commerce.raml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/rest_api/rest_api_reference/input/ez-commerce.raml b/docs/api/rest_api/rest_api_reference/input/ez-commerce.raml index be67e266c5..7158420356 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-commerce.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-commerce.raml @@ -307,7 +307,7 @@ 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. From 4d3fa949502b24bafd278d73bbc27b04f5b05c12 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis Date: Thu, 2 Mar 2023 16:32:02 +0100 Subject: [PATCH 06/21] Fix POST /product/catalog/product_variants/view/{baseProductCode} --- .../rest_api_reference/input/ez-product-productvariants.raml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/api/rest_api/rest_api_reference/input/ez-product-productvariants.raml b/docs/api/rest_api/rest_api_reference/input/ez-product-productvariants.raml index 1588ee4450..8be923f0d7 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-product-productvariants.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-product-productvariants.raml @@ -93,7 +93,7 @@ description: Error - a product variant with the same code already exists. 404: description: Error - no product variant with the given code exists. -/view: +/view/{baseProductCode}: post: displayName: Filter product variants description: Executes a query and returns a View including the results. The View input reflects the criteria model of the public API. @@ -120,3 +120,5 @@ example: !include examples/product/catalog/product_variants/POST/ProductVariantView.json.example 400: description: Error - the input does not match the input schema definition. + 404: + description: Error - the base product does not exist. From e7a87c5b545de741be3a3775c8e9d5cd29a4568d Mon Sep 17 00:00:00 2001 From: Adrien Dupuis Date: Thu, 2 Mar 2023 16:34:07 +0100 Subject: [PATCH 07/21] ez-content-objects.raml: Add POST /content/objects/{contentId}/hide and reveal --- .../input/ez-content-objects.raml | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/api/rest_api/rest_api_reference/input/ez-content-objects.raml b/docs/api/rest_api/rest_api_reference/input/ez-content-objects.raml index c0002996f4..972b7e4687 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-content-objects.raml +++ b/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. From 68e2b36598971694951f34158039a9c5879191bc Mon Sep 17 00:00:00 2001 From: Adrien Dupuis Date: Thu, 2 Mar 2023 16:38:36 +0100 Subject: [PATCH 08/21] Add GET /product/catalog/attribute_types(/{identifier}) Add GET /product/catalog/attribute_types Add GET /product/catalog/attribute_types/{identifier} --- .../input/ez-product-attributetypes.raml | 33 +++++++++++++++++++ .../rest_api_reference/input/ez-types.raml | 8 +++++ .../rest_api/rest_api_reference/input/ez.raml | 1 + 3 files changed, 42 insertions(+) create mode 100644 docs/api/rest_api/rest_api_reference/input/ez-product-attributetypes.raml diff --git a/docs/api/rest_api/rest_api_reference/input/ez-product-attributetypes.raml b/docs/api/rest_api/rest_api_reference/input/ez-product-attributetypes.raml new file mode 100644 index 0000000000..edfd5a1a7e --- /dev/null +++ b/docs/api/rest_api/rest_api_reference/input/ez-product-attributetypes.raml @@ -0,0 +1,33 @@ +get: + displayName: List Attribute Types + description: Lists all Attribute Types. + headers: + Accept: + description: If set, the list is returned in XML or JSON format. + example: application/vnd.ibexa.api.AttributeTypeList+json + responses: + 200: + description: OK - returns a list of Attribute Types + body: + application/vnd.ibexa.api.AttributeTypeList+xml: + type: AttributeTypeList + application/vnd.ibexa.api.AttributeTypeList+json: + type: AttributeTypeList +/{identifier}: + get: + displayName: Get Attribute Type + description: Gets an Attribute Type by its identifier. + headers: + Accept: + description: If set, the Attribute Type is returned in XML or JSON format. + example: application/vnd.ibexa.api.AttributeType+json + responses: + 200: + description: OK - returns the Attribute Type + body: + application/vnd.ibexa.api.AttributeType+xml: + type: AttributeType + application/vnd.ibexa.api.AttributeType+json: + type: AttributeType + 404: + description: Error - The Attribute Type does not exist. diff --git a/docs/api/rest_api/rest_api_reference/input/ez-types.raml b/docs/api/rest_api/rest_api_reference/input/ez-types.raml index f26d2a7d1e..53fe584346 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-types.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-types.raml @@ -2365,6 +2365,14 @@ AttributeView: type: object description: '' +AttributeType: + type: object + description: '' + +AttributeTypeList: + type: object + description: '' + CustomerGroup: type: object description: '' diff --git a/docs/api/rest_api/rest_api_reference/input/ez.raml b/docs/api/rest_api/rest_api_reference/input/ez.raml index b2ff803496..6cc9623100 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez.raml @@ -46,6 +46,7 @@ version: v3.3.2 /catalogs: !include ez-product-catalogs.raml /currencies: !include ez-product-currency.raml /regions: !include ez-product-regions.raml + /attribute_types: !include ez-product-attributetypes.raml /attribute_groups: !include ez-product-attributegroups.raml /attributes: !include ez-product-attributes.raml /customer_groups: !include ez-product-customergroups.raml From 37235de12cddbde9e428241b46d3331b9c7a3c7d Mon Sep 17 00:00:00 2001 From: Adrien Dupuis Date: Thu, 2 Mar 2023 16:42:23 +0100 Subject: [PATCH 09/21] ez-product-regions.raml: Add GET /product/catalog/regions/{identifier} --- .../rest_api_reference/input/ez-product-regions.raml | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/api/rest_api/rest_api_reference/input/ez-product-regions.raml b/docs/api/rest_api/rest_api_reference/input/ez-product-regions.raml index a2ef25b468..a1441a26e0 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-product-regions.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-product-regions.raml @@ -15,8 +15,16 @@ get: example: !include examples/product/catalog/regions/GET/RegionList.json.example 401: description: Error - the user has no permission to read regions. - 404: - description: Error - the region does not exist. + +/{identifier}: + get: + displayName: Load region + description: Loads a region by its identifier + responses: + 200: + description: OK - loads region. + 404: + description: Error - the region does not exist. /view: post: From 2eeb256bb921fe6990433624606dd0f81e95af82 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis Date: Thu, 2 Mar 2023 16:49:56 +0100 Subject: [PATCH 10/21] ez-taxonomy.raml: Add several /taxonomy/{taxonomyName}/entry and /entries Add GET /taxonomy/{taxonomyName}/entry/{id} Add GET /taxonomy/{taxonomyName}/entry/identifier/{identifier} Add GET /taxonomy/{taxonomyName}/entry/content-id/{contentId} Add DELETE /taxonomy/{taxonomyName}/entries Add POST /taxonomy/{taxonomyName}/entries/move Add GET /taxonomy/{taxonomyName}/entry-assignment/{id} Add GET /taxonomy/{taxonomyName}/entry-assignments/content-id/{contentId} --- .../EntryAssignmentCollection.json.example | 118 +++++++++ .../GET/EntryAssignmentCollection.xml.example | 56 ++++ .../TaxonomyEntryBulkRemove.json.example | 5 + .../POST/TaxonomyEntryBulkMove.json.example | 16 ++ .../rest_api_reference/input/ez-taxonomy.raml | 245 ++++++++++++++---- .../rest_api_reference/input/ez-types.raml | 15 ++ 6 files changed, 411 insertions(+), 44 deletions(-) create mode 100644 docs/api/rest_api/rest_api_reference/input/examples/taxonomy/GET/EntryAssignmentCollection.json.example create mode 100644 docs/api/rest_api/rest_api_reference/input/examples/taxonomy/GET/EntryAssignmentCollection.xml.example create mode 100644 docs/api/rest_api/rest_api_reference/input/examples/taxonomy/entries/DELETE/TaxonomyEntryBulkRemove.json.example create mode 100644 docs/api/rest_api/rest_api_reference/input/examples/taxonomy/entries/move/POST/TaxonomyEntryBulkMove.json.example diff --git a/docs/api/rest_api/rest_api_reference/input/examples/taxonomy/GET/EntryAssignmentCollection.json.example b/docs/api/rest_api/rest_api_reference/input/examples/taxonomy/GET/EntryAssignmentCollection.json.example new file mode 100644 index 0000000000..1f4da980d3 --- /dev/null +++ b/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" + } + } + } + ] + } +} diff --git a/docs/api/rest_api/rest_api_reference/input/examples/taxonomy/GET/EntryAssignmentCollection.xml.example b/docs/api/rest_api/rest_api_reference/input/examples/taxonomy/GET/EntryAssignmentCollection.xml.example new file mode 100644 index 0000000000..08ed4e57a0 --- /dev/null +++ b/docs/api/rest_api/rest_api_reference/input/examples/taxonomy/GET/EntryAssignmentCollection.xml.example @@ -0,0 +1,56 @@ + + + + + + Ibexa Platform + Ibexa Platform + + +
+ + + 2023-01-01T00:00:00+00:00 + 2015-11-30T13:10:46+00:00 + eng-GB + 10 + true + false + PUBLISHED + + + + + 1 + + + + Ibexa Platform + Ibexa Platform + + +
+ + + 2023-01-01T00:00:00+00:00 + 2015-11-30T13:10:46+00:00 + eng-GB + 10 + true + false + PUBLISHED + + + + + + 3 + example + Example + 65 + + tags + + + + \ No newline at end of file diff --git a/docs/api/rest_api/rest_api_reference/input/examples/taxonomy/entries/DELETE/TaxonomyEntryBulkRemove.json.example b/docs/api/rest_api/rest_api_reference/input/examples/taxonomy/entries/DELETE/TaxonomyEntryBulkRemove.json.example new file mode 100644 index 0000000000..d2cb465ee3 --- /dev/null +++ b/docs/api/rest_api/rest_api_reference/input/examples/taxonomy/entries/DELETE/TaxonomyEntryBulkRemove.json.example @@ -0,0 +1,5 @@ +{ + "TaxonomyEntryBulkRemove": { + "entries": [ 2, 3 ] + } +} diff --git a/docs/api/rest_api/rest_api_reference/input/examples/taxonomy/entries/move/POST/TaxonomyEntryBulkMove.json.example b/docs/api/rest_api/rest_api_reference/input/examples/taxonomy/entries/move/POST/TaxonomyEntryBulkMove.json.example new file mode 100644 index 0000000000..a602a973d7 --- /dev/null +++ b/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' + ], + ] + } +} diff --git a/docs/api/rest_api/rest_api_reference/input/ez-taxonomy.raml b/docs/api/rest_api/rest_api_reference/input/ez-taxonomy.raml index 70521e9f43..954a22a3fa 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-taxonomy.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-taxonomy.raml @@ -1,45 +1,202 @@ displayName: Taxonomy -/{taxonomyName}/entry-assignments/assign-to-content: - post: - displayName: Assign entry - description: Assigns taxonomy entry to a Content item. - headers: - Accept: - example: | - application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json - Content-Type: - example: | - application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json - body: - application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json: - type: TaxonomyEntryAssignToContent - example: !include examples/taxonomy/POST/TaxonomyEntryAssignToContent.json.example - responses: - 201: - description: No Content. - 400: - description: Error - the input does not match the input schema definition. - 401: - description: Error - the user is not authorized to assign this Entry. -/{taxonomyName}/entry-assignments/unassign-from-content: - post: - displayName: Unassign entry - description: Unassigns taxonomy entry from a Content item. - headers: - Accept: - example: | - aapplication/vnd.ibexa.api.TaxonomyEntryUnassignFromContent+json - Content-Type: - example: | - application/vnd.ibexa.api.TaxonomyEntryUnassignFromContent+json - body: - application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json: - type: TaxonomyEntryUnassignFromContent - example: !include examples/taxonomy/POST/TaxonomyEntryUnassignFromContent.json.example - responses: - 201: - description: No Content. - 400: - description: Error - the input does not match the input schema definition. - 401: - description: Error - the user is not authorized to unassign this entry. \ No newline at end of file +/{taxonomyName}: + /entry: + /{id}: + get: + displayName: Get Entry by ID + description: Loads taxonomy Entry by its Entry ID. + headers: + Accept: + description: If set, the Taxonomy Entry is returned in XML or JSON format. + example: | + application/vnd.ibexa.api.TaxonomyEntry+json + responses: + 200: + description: OK - returns the taxonomy Entry. + body: + application/vnd.ibexa.api.TaxonomyEntry+xml: + type: TaxonomyEntry + application/vnd.ibexa.api.TaxonomyEntry+json: + type: TaxonomyEntry + 401: + description: Error - the user is not authorized to read this Entry. + 404: + description: Error - the Entry does not exists. + /identifier/{identifier}: + get: + displayName: Get Entry by identifier + description: Loads taxonomy Entry by its Entry identifier. + headers: + Accept: + description: If set, the Taxonomy Entry is returned in XML or JSON format. + example: | + application/vnd.ibexa.api.TaxonomyEntry+json + responses: + 200: + description: OK - returns the taxonomy Entry. + body: + application/vnd.ibexa.api.TaxonomyEntry+xml: + type: TaxonomyEntry + application/vnd.ibexa.api.TaxonomyEntry+json: + type: TaxonomyEntry + 401: + description: Error - the user is not authorized to read this Entry. + 404: + description: Error - the Entry does not exists. + /content-id/{contentId}: + get: + displayName: Get Entry by Content ID + description: Loads taxonomy Entry by its Content ID. + headers: + Accept: + description: If set, the Taxonomy Entry is returned in XML or JSON format. + example: | + application/vnd.ibexa.api.TaxonomyEntry+json + responses: + 200: + description: OK - returns the taxonomy Entry. + body: + application/vnd.ibexa.api.TaxonomyEntry+xml: + type: TaxonomyEntry + application/vnd.ibexa.api.TaxonomyEntry+json: + type: TaxonomyEntry + 401: + description: Error - the user is not authorized to read this Entry. + 404: + description: Error - the Entry does not exists. + /entries: + delete: + displayName: Delete Entries + description: Bulk removes several taxonomy entries. + headers: + Content-Type: + description: Target Entries schema encoded in XML or JSON format. + example: | + application/vnd.ibexa.api.TaxonomyEntryBulkRemove+xml + application/vnd.ibexa.api.TaxonomyEntryBulkRemove+json + body: + application/vnd.ibexa.api.TaxonomyEntryBulkRemove+xml: + type: TaxonomyEntryBulkRemove + application/vnd.ibexa.api.TaxonomyEntryBulkRemove+json: + type: TaxonomyEntryBulkRemove + example: !include examples/taxonomy/entries/DELETE/TaxonomyEntryBulkRemove.json.example + responses: + 204: + description: No Content - The entries have been deleted. + 400: + description: Error - The input does not match the input schema definition. + 401: + description: Error - The user is not authorized to delete some of the entries. + /move: + post: + displayName: Move Entries + description: Bulk move several taxonomy entries relative to sibling. + headers: + Content-Type: + description: The Entry moves schema encoded in XML or JSON format. + example: | + application/vnd.ibexa.api.TaxonomyEntryBulkMove+xml + application/vnd.ibexa.api.TaxonomyEntryBulkMove+json + body: + application/vnd.ibexa.api.TaxonomyEntryBulkMove+xml: + type: TaxonomyEntryBulkMove + application/vnd.ibexa.api.TaxonomyEntryBulkMove+json: + type: TaxonomyEntryBulkMove + example: !include examples/taxonomy/entries/move/POST/TaxonomyEntryBulkMove.json.example + responses: + 204: + description: No Content - The entries have been moved. + 400: + description: Error - The input does not match the input schema definition. + 401: + description: Error - The user is not authorized to move some of the entries. + 404: + description: Error - Some to-be-moved or sibling entries do not exist. + /entry-assignment/{id}: + get: + displayName: Get Assignment by ID + description: Gets taxonomy entry Assignment by its ID. + headers: + Accept: + description: If set, the Assignment is returned in XML or JSON format. + example: | + application/vnd.ibexa.api.TaxonomyEntryAssignment+json + responses: + 200: + description: OK - returns the taxonomy entry Assignment. + body: + application/vnd.ibexa.api.TaxonomyEntryAssignment+xml: + type: TaxonomyEntryAssignment + application/vnd.ibexa.api.TaxonomyEntryAssignment+json: + type: TaxonomyEntryAssignment + 404: + description: Error - the assignment does not exist. + /entry-assignments: + /assign-to-content: + post: + displayName: Assign entry + description: Assigns taxonomy entry to a Content item. + headers: + Accept: + example: | + application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json + Content-Type: + example: | + application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json + body: + application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json: + type: TaxonomyEntryAssignToContent + example: !include examples/taxonomy/POST/TaxonomyEntryAssignToContent.json.example + responses: + 201: + description: No Content. + 400: + description: Error - the input does not match the input schema definition. + 401: + description: Error - the user is not authorized to assign this Entry. + /unassign-from-content: + post: + displayName: Unassign entry + description: Unassigns taxonomy entry from a Content item. + headers: + Accept: + example: | + aapplication/vnd.ibexa.api.TaxonomyEntryUnassignFromContent+json + Content-Type: + example: | + application/vnd.ibexa.api.TaxonomyEntryUnassignFromContent+json + body: + application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json: + type: TaxonomyEntryUnassignFromContent + example: !include examples/taxonomy/POST/TaxonomyEntryUnassignFromContent.json.example + responses: + 201: + description: No Content. + 400: + description: Error - the input does not match the input schema definition. + 401: + description: Error - the user is not authorized to unassign this entry. + /content-id/{contentId}: + get: + displayName: Get Assignments to a Content + description: Gets taxonomy entries assigned to a Content item by its ID. + headers: + Accept: + description: If set, the assignments are returned in XML or JSON format. + example: | + application/vnd.ibexa.api.EntryAssignmentCollection+xml + application/vnd.ibexa.api.EntryAssignmentCollection+json + responses: + 200: + description: OK - returns the assigment collection. + body: + application/vnd.ibexa.api.EntryAssignmentCollection+xml: + description: Contains metadata about the content itself and a list of taxonomy entry assignments to this content, in XML format. + type: EntryAssignmentCollection + example: !include examples/taxonomy/GET/EntryAssignmentCollection.xml.example + application/vnd.ibexa.api.EntryAssignmentCollection+json: + description: Contains metadata about the content itself and a list of taxonomy entry assignments to this content, in JSON format. + type: EntryAssignmentCollection + example: !include examples/taxonomy/GET/EntryAssignmentCollection.json.example + 404: + description: Error - the Content does not exists. diff --git a/docs/api/rest_api/rest_api_reference/input/ez-types.raml b/docs/api/rest_api/rest_api_reference/input/ez-types.raml index 53fe584346..ea2b19bc4f 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-types.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-types.raml @@ -2490,6 +2490,21 @@ ProductTypeList: type: object description: +TaxonomyEntry: + type: object + +TaxonomyEntryAssignment: + type: object + +EntryAssignmentCollection: + type: object + +TaxonomyEntryBulkRemove: + type: object + +TaxonomyEntryBulkMove: + type: object + TaxonomyEntryAssignToContent: type: object description: '' From 24ad415d6e0c0bffb7b8aef911b3edae247e5e02 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis Date: Thu, 2 Mar 2023 16:55:08 +0100 Subject: [PATCH 11/21] Add GET /user/current --- .../input/ez-user-current.raml | 21 +++++++++++++++++++ .../rest_api/rest_api_reference/input/ez.raml | 1 + 2 files changed, 22 insertions(+) create mode 100644 docs/api/rest_api/rest_api_reference/input/ez-user-current.raml diff --git a/docs/api/rest_api/rest_api_reference/input/ez-user-current.raml b/docs/api/rest_api/rest_api_reference/input/ez-user-current.raml new file mode 100644 index 0000000000..b4da5d615f --- /dev/null +++ b/docs/api/rest_api/rest_api_reference/input/ez-user-current.raml @@ -0,0 +1,21 @@ +get: + displayName: Load current User + description: Loads the current user. + headers: + Accept: + description: If set, the User is returned in XML or JSON format. + example: | + application/vnd.ibexa.api.User+xml + application/vnd.ibexa.api.User+json + responses: + 200: + description: OK - the User with the given ID. + body: + application/vnd.ibexa.api.User+xml: + type: UserList + example: !include examples/user/users/user_id/GET/User.xml.example + application/vnd.ibexa.api.User+json: + type: UserList + example: !include examples/user/users/user_id/GET/User.json.example + 401: + description: Error - the user has no permission to read Users. For example, Anonymous user can't load oneself. diff --git a/docs/api/rest_api/rest_api_reference/input/ez.raml b/docs/api/rest_api/rest_api_reference/input/ez.raml index 6cc9623100..15b8af5cd9 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez.raml @@ -28,6 +28,7 @@ version: v3.3.2 /user: displayName: Managing users + /current: !include ez-user-current.raml /groups: !include ez-user-groups.raml /users: !include ez-user-users.raml /roles: !include ez-user-roles.raml From 4a7e928cb356145761216c6d1fccf00e0f13cbfd Mon Sep 17 00:00:00 2001 From: Adrien Dupuis Date: Thu, 2 Mar 2023 17:00:20 +0100 Subject: [PATCH 12/21] Add POST /user/groups/subgroups --- .../input/ez-user-groups.raml | 36 +++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/docs/api/rest_api/rest_api_reference/input/ez-user-groups.raml b/docs/api/rest_api/rest_api_reference/input/ez-user-groups.raml index fa8bed22a0..7ce15737c7 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-user-groups.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-user-groups.raml @@ -35,6 +35,42 @@ get: responses: 301: description: Moved permanently. +/subgroups: + post: + displayName: Create a top level User Group + description: Creates a top level User Group under the root. To create a child group under a parent group use '/user/groups/{path}/subgroups'. + headers: + Accept: + description: If set, the new User Group is returned in XML or JSON format. + example: | + application/vnd.ibexa.api.UserGroup+xml + application/vnd.ibexa.api.UserGroup+json + Content-Type: + description: The UserGroupCreate schema encoded in XML or JSON format. + example: | + application/vnd.ibexa.api.UserGroupCreate+json + application/vnd.ibexa.api.UserGroupCreate+xml + body: + application/vnd.ibexa.api.UserGroupCreate+xml: + type: UserGroupCreate + example: !include examples/user/groups/path/subgroups/POST/UserGroupCreate.xml.example + application/vnd.ibexa.api.UserGroupCreate+json: + type: UserGroupCreate + example: !include examples/user/groups/path/subgroups/POST/UserGroupCreate.json.example + responses: + 201: + description: Created - the User Group has been created + body: + application/vnd.ibexa.api.UserGroup+xml: + type: UserGroup + example: !include examples/user/groups/path/subgroups/POST/UserGroup.xml.example + application/vnd.ibexa.api.UserGroup+json: + type: UserGroup + example: !include examples/user/groups/path/subgroups/POST/UserGroup.json.example + 400: + description: Error - the input does not match the input schema definition. + 401: + description: Error - the user is not authorized to create this User Group./{path}: /{path}: get: displayName: Load User Group From 2b99c3a75736413d7259a72215a110625162e743 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis Date: Thu, 2 Mar 2023 17:01:03 +0100 Subject: [PATCH 13/21] Add some /user/users/{userId}/* routes - Add GET /user/users/{userId}/drafts - Add GET /user/users/{userId}/segments - Add POST /user/users/{userId}/segments --- .../input/ez-user-users.raml | 43 +++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/docs/api/rest_api/rest_api_reference/input/ez-user-users.raml b/docs/api/rest_api/rest_api_reference/input/ez-user-users.raml index bb24deaf5b..ad84cd9ad1 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-user-users.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-user-users.raml @@ -321,3 +321,46 @@ head: example: !include examples/user/users/user_id/roles/role_id/DELETE/RoleAssignmentList.json.example 401: description: Error - the user is not authorized to delete this Content Type. + /segments: + get: + displayName: View user segments + description: TODO + 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 + post: + displayName: Assign Segments to User + description: Assigns Segments from payload to User given by ID. + headers: + Content-Type: + description: The UserSegmentAssignInput schema encoded in XML or JSON format. + example: | + application/vnd.ibexa.api.UserSegmentAssignInput+xml + application/vnd.ibexa.api.UserSegmentAssignInput+json + /{segmentIdentifier}: + delete: + displayName: Unassign Segment from User + description: The Segment designated by its identifier is unassigned from the User given by ID. + /drafts: + get: + displayName: Load user drafts + description: Loads user's drafts + headers: + Accept: + description: If set, the version list is returned in XML or JSON format. + example: | + application/vnd.ibexa.api.VersionList+xml + application/vnd.ibexa.api.VersionList+json + responses: + 200: + description: OK - List the draft versions + body: + application/vnd.ibexa.api.VersionList+xml: + type: VersionList + application/vnd.ibexa.api.VersionList+json: + type: VersionList + 401: + description: Error - the current user is not authorized to list the drafts of the given user. From c52ae773650dee585c510779049b1f8cfc1062db Mon Sep 17 00:00:00 2001 From: Adrien Dupuis Date: Thu, 2 Mar 2023 17:07:04 +0100 Subject: [PATCH 14/21] shorten displayName and unify "deprecated" flags. --- .../rest_api/rest_api_reference/input/ez-content-views.raml | 4 ++-- .../rest_api_reference/input/ez-product-attributegroups.raml | 4 ++-- .../rest_api_reference/input/ez-product-attributes.raml | 4 ++-- .../rest_api_reference/input/ez-product-products.raml | 4 ++-- .../rest_api_reference/input/ez-product-producttypes.raml | 4 ++-- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/api/rest_api/rest_api_reference/input/ez-content-views.raml b/docs/api/rest_api/rest_api_reference/input/ez-content-views.raml index 40c8963d7c..cea800be55 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-content-views.raml +++ b/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. diff --git a/docs/api/rest_api/rest_api_reference/input/ez-product-attributegroups.raml b/docs/api/rest_api/rest_api_reference/input/ez-product-attributegroups.raml index 1297028061..fc0714733f 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-product-attributegroups.raml +++ b/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 diff --git a/docs/api/rest_api/rest_api_reference/input/ez-product-attributes.raml b/docs/api/rest_api/rest_api_reference/input/ez-product-attributes.raml index 9a51257c0e..427ad47044 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-product-attributes.raml +++ b/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. diff --git a/docs/api/rest_api/rest_api_reference/input/ez-product-products.raml b/docs/api/rest_api/rest_api_reference/input/ez-product-products.raml index a2806f1a01..f33e6d013e 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-product-products.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-product-products.raml @@ -96,8 +96,8 @@ 404: description: Error - no product with the given code exists. get: - displayName: Load products list (deprecated as of Ibexa DXP 4.3, use /view instead) - description: Returns a list of products. + displayName: Load products list (deprecated) + description: Returns a list of products. Deprecated as of Ibexa DXP 4.3, use POST /product/catalog/products/view instead. headers: Accept: description: If set, the products are returned in XML or JSON format. diff --git a/docs/api/rest_api/rest_api_reference/input/ez-product-producttypes.raml b/docs/api/rest_api/rest_api_reference/input/ez-product-producttypes.raml index a579a48961..a1f43433ad 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-product-producttypes.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-product-producttypes.raml @@ -29,8 +29,8 @@ post: 404: description: Error - the product type with the given ID does not exist. get: - displayName: Load product types (deprecated as of Ibexa DXP 4.3, use /view instead) - description: Returns a list of product types. + displayName: Load product types (deprecated) + description: Returns a list of product types. Deprecated as of Ibexa DXP 4.3, use POST /product/catalog/product_types/view instead. headers: Accept: description: ProductTypeListGet - If set, the product type list is returned in XML or JSON format. From 0b6d634282f7f6308397c49b4961e4d64827a96d Mon Sep 17 00:00:00 2001 From: Adrien Dupuis Date: Thu, 2 Mar 2023 17:08:53 +0100 Subject: [PATCH 15/21] Regenerate rest_api_reference.html --- .../rest_api_reference.html | 36792 +++++++++------- 1 file changed, 22038 insertions(+), 14754 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 c0fa334186..0e7faac259 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 @@ -14160,6 +14160,172 @@
Types
+ +
+
+

/content/objects/{contentId}/hide

+ +
+
+
+
+
+
+ Hide Content item + +
+
+
+

+ POST + /content/objects/{contentId}/hide +

+

Makes or keep the Content item invisible

+

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

OK - Object item is hidden.

+
+ 401 + +

Error - The user has no permission to change Object item visibility.

+
+ 404 + +

Error - The Content item was not found.

+
+
+
+ + +
+
+ +
+
+
+
+
+
+
+

/content/objects/{contentId}/reveal

+ +
+
+
+
+
+
+ Reveal Content item + +
+
+
+

+ POST + /content/objects/{contentId}/reveal +

+

Makes or keep the Content item visible

+

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

OK - Object item is revealed.

+
+ 401 + +

Error - The user has no permission to change Object item visibility.

+
+ 404 + +

Error - The Content item was not found.

+
+
+
+ + +
+
+ +
+
+
+

/content/objectstategroups

@@ -21317,7 +21483,7 @@

/content/views

/content/views

-
+
-
- Create View - + data-search="create-view-deprecated"> + Create View (deprecated) +
@@ -21342,7 +21508,7 @@

/content/views

POST /content/views

-

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.

+

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.

Header parameters
@@ -38754,7 +38920,82 @@
Possible responses
-
+
+
+

/content/types/{contentTypeId}/fieldDefinitions

+ +
+
+
+
+
+
+ Get Field definition list + +
+
+
+

+ GET + /content/types/{contentTypeId}/fieldDefinitions +

+

Returns all Field definitions of the provided Content Type.

+

+ + +
+
Possible responses
+
+ + + + + + + + + + + + + + + + + +
CodeDescription
+ 200 + +

OK - return a list of Field definitions.

+
+ 404 + +

Error - The Content Type does not exist.

+
+
+
+ + +
+
+ +
+
+
+
+
+

/content/types/{contentTypeId}/fieldDefinitions/{fieldDefinitionId}

-
+
-
- Update Content Type draft - + data-search="get-content-type-draft"> + Get Content Type draft +

- PATCH + GET /content/types/{contentTypeId}/draft

-

Updates metadata of a draft. This method does not handle Field definitions. PATCH or POST with header X-HTTP-Method-Override PATCH.

+

Returns the draft of the Content Type with the provided ID.

Header parameters

Accept

-

If set, the new Content Type draft is returned in XML or JSON format.

+

If set, the Content Type is returned in XML or JSON format.

@@ -39265,8 +39513,8 @@
Header parameters
@@ -39274,9 +39522,151 @@
Header parameters
Examples - application/vnd.ibexa.api.ContentTypeInfo+xml -application/vnd.ibexa.api.ContentTypeInfo+json + application/vnd.ibexa.api.ContentType+xml +application/vnd.ibexa.api.ContentType+json
+
+ + +
+
Possible responses
+
+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
+ + 200 + + +

OK - returns the Content Type.

+
+ 401 + +

Error - The user is not authorized to read this Content Type.

+
+ 404 + +

Error - The Content Type does not exist or does not have a draft.

+
+
+
+ +
+
Types
+
+ + + + + + + + + + + + + +
TypeDescription
+ + ContentType + +
+
+
+ +
+
+ +
+
+
+
+
+
    +
+
+
+
+
+
+
+
+
+
+
+ Update Content Type draft + +
+
+
+

+ PATCH + /content/types/{contentTypeId}/draft +

+

Updates metadata of a draft. This method does not handle Field definitions. PATCH or POST with header X-HTTP-Method-Override PATCH.

+

+
+
Header parameters
-

Content-Type

-

The Content Type update schema encoded in XML or JSON format.

+

Accept

+

If set, the new Content Type draft is returned in XML or JSON format.

+
+ + + + + + + + + + + + + + + + + +
PropertyValue
Type + + + string + + + + +
Examples + application/vnd.ibexa.api.ContentTypeInfo+xml +application/vnd.ibexa.api.ContentTypeInfo+json + +
+
+
+
+

Content-Type

+

The Content Type update schema encoded in XML or JSON format.

@@ -40254,6 +40644,13 @@
Possible responses

/content/types/{contentTypeId}/draft/fieldDefinitions

- - - - - - - - - - - - - - - - -
PropertyValue
Type - - - string - - -
Examples - application/vnd.ibexa.api.FieldDefinition+xml -application/vnd.ibexa.api.FieldDefinition+json - -
-
-
-
-

Content-Type

-

The Field Definition Create schema encoded in XML or JSON format.

-
- - - - - - - - - - - - - - - - - -
PropertyValue
Type - - - string - - - - -
Examples - application/vnd.ibexa.api.FieldDefinitionCreate+xml -application/vnd.ibexa.api.FieldDefinitionCreate+json - -
-
-
-
- -
Possible responses
@@ -40371,411 +40693,547 @@
Possible responses
- - 201 - - - -

Field definition created.

- - - - - 400 - - -

Error - The input does not match the input schema definition or validation on the Field definition fails.

- - - - - 401 + 200 -

Error - The user is not authorized to add a Field definition.

+

OK - return a list of Field definitions.

- 403 + 404 -

Error - A Field definition with the same identifier already exists in the given Content Type. The Field definition is of singular type, already existing in the given Content Type. The Field definition you want to add is of a type that can't be added to a Content Type that already has content instances.

- - - - -
-
- -
-
Types
-
- - - - - - - - - - - - - - -
TypeDescription
- - FieldDefinitionCreate - -
- - FieldDefinition - +

Error - The Content Type draft does not exist.

This class represents a Field definition.
+
-
-
-
- -
-
-
-
-
-

- file_copy - -

- 
-                                <?xml version="1.0" encoding="UTF-8"?>
-<FieldDefinitionCreate>
-    <identifier>name</identifier>
-    <fieldType>ezstring</fieldType>
-    <isRequired>true</isRequired>
-    <validatorConfiguration>
-    <value key="StringLengthValidator">
-        <value key="maxStringLength">32</value>
-        <value key="minStringLength">8</value>
-    </value>
-</validatorConfiguration>
-</FieldDefinitionCreate>
-
-
-
- View more -
-
-
- -
-
-
-
-
- -
- Code: 201 +
-
-
-
-
-
-

- file_copy - -

- 
-                                <?xml version="1.0" encoding="UTF-8"?>
-<FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/14/draft/fieldDefinitions/221">
-    <id>221</id>
-    <identifier>name2</identifier>
-    <fieldType>ezstring</fieldType>
-    <fieldGroup></fieldGroup>
-    <position>0</position>
-    <isTranslatable>true</isTranslatable>
-    <isRequired>true</isRequired>
-    <isInfoCollector>false</isInfoCollector>
-    <defaultValue/>
-    <isSearchable>true</isSearchable>
-    <names/>
-    <descriptions/>
-    <fieldSettings/>
-    <validatorConfiguration>
-        <value key="StringLengthValidator">
-            <value key="maxStringLength">32</value>
-            <value key="minStringLength">8</value>
-        </value>
-    </validatorConfiguration>
-</FieldDefinition>
-
-
-
- View more -
-
-
- -
-
-
-
-

/content/types/{contentTypeId}/draft/fieldDefinitions/{fieldDefinitionId}

- -
-
-
+
-
- Get Content Type Draft Field definition - + data-search="add-content-type-draft-field-definition"> + Add Content Type Draft Field definition +

- GET - /content/types/{contentTypeId}/draft/fieldDefinitions/{fieldDefinitionId} + POST + /content/types/{contentTypeId}/draft/fieldDefinitions

-

Returns the Field definition by the given ID.

+

Creates a new Field definition for the given Content Type.

Header parameters

Accept

-

If set, the Field definition is returned in XML or JSON format.

+

If set, the new Field definition is returned in XML or JSON format.

+
+ + + + + + + + + + + + + + + + + +
PropertyValue
Type + + + string + + + + +
Examples + application/vnd.ibexa.api.FieldDefinition+xml +application/vnd.ibexa.api.FieldDefinition+json + +
+
+
+
+

Content-Type

+

The Field Definition Create schema encoded in XML or JSON format.

+
+ + + + + + + + + + + + + + + + + +
PropertyValue
Type + + + string + + + + +
Examples + application/vnd.ibexa.api.FieldDefinitionCreate+xml +application/vnd.ibexa.api.FieldDefinitionCreate+json + +
+
+
+
+ + +
+
Possible responses
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
CodeDescription
+ + 201 + + +

Field definition created.

+
+ 400 + +

Error - The input does not match the input schema definition or validation on the Field definition fails.

+
+ 401 + +

Error - The user is not authorized to add a Field definition.

+
+ 403 + +

Error - A Field definition with the same identifier already exists in the given Content Type. The Field definition is of singular type, already existing in the given Content Type. The Field definition you want to add is of a type that can't be added to a Content Type that already has content instances.

+
+
+
+ +
+
Types
+
+ + + + + + + + + + + + + + + + + +
TypeDescription
+ + FieldDefinitionCreate + +
+ + FieldDefinition + + This class represents a Field definition.
+
+
+ +
+
+ +
+
+
+ +
+
+
+
+
+

+ file_copy + +

+ 
+                                <?xml version="1.0" encoding="UTF-8"?>
+<FieldDefinitionCreate>
+    <identifier>name</identifier>
+    <fieldType>ezstring</fieldType>
+    <isRequired>true</isRequired>
+    <validatorConfiguration>
+    <value key="StringLengthValidator">
+        <value key="maxStringLength">32</value>
+        <value key="minStringLength">8</value>
+    </value>
+</validatorConfiguration>
+</FieldDefinitionCreate>
+
+
+
+ View more +
+
+
+ +
+
+
+
+
+ +
+ Code: 201 +
+
+
+
+
+
+

+ file_copy + +

+ 
+                                <?xml version="1.0" encoding="UTF-8"?>
+<FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/14/draft/fieldDefinitions/221">
+    <id>221</id>
+    <identifier>name2</identifier>
+    <fieldType>ezstring</fieldType>
+    <fieldGroup></fieldGroup>
+    <position>0</position>
+    <isTranslatable>true</isTranslatable>
+    <isRequired>true</isRequired>
+    <isInfoCollector>false</isInfoCollector>
+    <defaultValue/>
+    <isSearchable>true</isSearchable>
+    <names/>
+    <descriptions/>
+    <fieldSettings/>
+    <validatorConfiguration>
+        <value key="StringLengthValidator">
+            <value key="maxStringLength">32</value>
+            <value key="minStringLength">8</value>
+        </value>
+    </validatorConfiguration>
+</FieldDefinition>
+
+
+
+ View more +
+
+
+ +
+
+
+
+
+
+
+

/content/types/{contentTypeId}/draft/fieldDefinitions/{fieldDefinitionId}

+ +
+
+
+
+
+
+ Get Content Type Draft Field definition + +
+
+
+

+ GET + /content/types/{contentTypeId}/draft/fieldDefinitions/{fieldDefinitionId} +

+

Returns the Field definition by the given ID.

+

+
+
Header parameters
+
+

Accept

+

If set, the Field definition is returned in XML or JSON format.

@@ -45186,14 +45644,14 @@

-

/user/groups

+

/user/current

-

/user/groups

+

/user/current

-
+
-
- Load User Groups - + data-search="load-current-user"> + Load current User +

GET - /user/groups + /user/current

-

Loads User Groups for either an an ID or a remote ID or a Role.

+

Loads the current user.

Header parameters

Accept

-

UserGroupList - If set, the User Group List is returned in XML or JSON format. UserGroupRefList - If set, the link list of User Group is returned in XML or JSON format.

+

If set, the User is returned in XML or JSON format.

@@ -45249,10 +45707,8 @@
Header parameters
@@ -45262,74 +45718,7 @@
Header parameters
-
-
Query parameters
-
-
Examples - application/vnd.ibexa.api.UserGroupList+xml -application/vnd.ibexa.api.UserGroupList+json -application/vnd.ibexa.api.UserGroupRefList+xml -application/vnd.ibexa.api.UserGroupRefList+json + application/vnd.ibexa.api.User+xml +application/vnd.ibexa.api.User+json
- - - - - - - - - - - - - - - - - - - - - - - - -
PropertyTypeValue
- roleId - - - - string - - - - - - Lists User Groups assigned to the given Role (e.g. GET /user/groups?roleId=1). -
- id - - - - string - - - - - - Retrieves the User Groups for the given ID. -
- remoteID - - - - string - - - - - - Retrieves the User Groups for the given remote ID. -
-
-
- +
Possible responses
@@ -45343,13 +45732,13 @@
Possible responses
- 200 -

+

OK - the User with the given ID.

@@ -45357,7 +45746,7 @@
Possible responses
401 -

Error - the user has no permission to read User Groups.

+

Error - the user has no permission to read Users. For example, Anonymous user can't load oneself.

@@ -45378,11 +45767,11 @@
Types
- - UserGroupList + + UserList - + This class represents a list of users. @@ -45395,28 +45784,28 @@
Types
-
+
-
-
-
+
+

file_copy

- 
+                            
                                 <?xml version="1.0" encoding="UTF-8"?>
-<UserGroupList media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/groups">
-    <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/13/15" id="14" remoteId="1bb4fe25487f05527efa8bfd394cecc7">
+<UserList media-type="application/vnd.ibexa.api.UserList+xml" href="/api/ibexa/v2/user/users">
+    <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/79" id="79" remoteId="bcf0764b417f05af21852a1f03fb1f13">
         <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/4"/>
-        <name>Administrator User</name>
-        <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/14/versions"/>
+        <name>Jose Vargas</name>
+        <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/79/versions"/>
         <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/>
-        <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/13/15"/>
-        <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/14/locations"/>
-        <Owner media-type="application/vnd.ibexa.a
+        <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/12/79"/>
+        <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/79/locations"/>
+        <Groups media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api
- View more + View more
-
+

file_copy

- 
+                            
                                 {
-    "UserGroupList": {
-        "_media-type": "application/vnd.ibexa.api.UserGroupList+json",
-        "_href": "/api/ibexa/v2/user/groups",
-        "UserGroup": [
+    "UserList": {
+        "_media-type": "application/vnd.ibexa.api.UserList+json",
+        "_href": "/api/ibexa/v2/user/users",
+        "User": [
             {
-                "_media-type": "application/vnd.ibexa.api.UserGroup+json",
-                "_href": "/api/ibexa/v2/user/groups/1/5/13/15",
-                "_id": 14,
-                "_remoteId": "1bb4fe25487f05527efa8bfd394cecc7",
+                "_media-type": "application/vnd.ibexa.api.User+json",
+                "_href": "/api/ibexa/v2/user/users/79",
+                "_id": 79,
+                "_remoteId": "bcf0764b417f05af21852a1f03fb1f13",
                 "ContentType": {
                     "_media-type": "application/vnd.ibexa.api.ContentType+json",
                     "_href": "/api/ibexa/v2/content/types/4"
                 },
-                "name": "Administrator User",
+                "name": "Jose Vargas",
                 "Versions": {
                     "_media-type": "application/vnd.ibexa.api.VersionList+json",
-                    "_href": "/api/ibexa/v2/content/objects/14/versions"
+                    "_href": "/api/ibexa/v2/content/objects/79/versions"
                 },
                 "Section": {
                     "_media-type": "application/vnd.ibexa.api.Section+json",
-                    "_href": "/api/ibexa/
+                    "_href": "/api/ibexa/v2/content/sections/2"
+
- View more + View more
-
+
+

+ Product catalog + +

+
+

/product/catalog/catalogs

+
-

/commerce/checkout/shippingmethods

+

/product/catalog/catalogs

-
+
-
- Get list of shipping methods - + data-search="create-catalog"> + Create catalog +

- GET - /commerce/checkout/shippingmethods + POST + /product/catalog/catalogs

-

+

Creates a new catalog.

+

+
+
Header parameters
+
+

Accept

+

If set, the new catalog is returned in XML or JSON format.

+
+ + + + + + + + + + + + + + + + + +
PropertyValue
Type + + + string + + + + +
Examples + application/vnd.ibexa.api.CatalogCreate+json + +
+
+
+
+

Content-Type

+

The catalog schema encoded in XML or JSON format.

+
+ + + + + + + + + + + + + + + + + +
PropertyValue
Type + + + string + + + +
Examples + application/vnd.ibexa.api.CatalogCreate+json + +
+
+
+
+
Possible responses
@@ -75801,14 +79350,46 @@
Possible responses
- - 200 + 201

+ + + + 400 + + +

Error - the input does not match the input schema definition.

+ + + + + 401 + + +

Error - the user is not authorized to update this catalog.

+ + + + + 403 + + +

Error - a catalog with the same name already exists.

+ + + + + 404 + + +

Error - no catalog with the given code exists.

+ @@ -75828,8 +79409,16 @@
Types
- - ShippingMethodDataResponse + + CatalogCreate + + + + + + + + Catalog @@ -75842,67 +79431,245 @@
Types
-
-
+
+
+
+ +
+
+
+
+
+

+ file_copy + +

+ 
+                                {
+    "CatalogCreate": {
+        "identifier": "test_catalog",
+        "criteria": {
+            "ProductCodeCriterion": ["ski", "snowboard"],
+            "ProductAvailabilityCriterion": true,
+            "ColorAttributeCriterion": {
+                "identifier": "color",
+                "value": ["#000000", "#FFFFFF"]
+            },
+            "CreatedAtCriterion": {
+                "operator": ">=",
+                "created_at": "12-09-2022"
+            },
+            "FloatAttributeCriterion": {
+                "identifier": "width",
+                "value": 16.6
+            },
+            "IntegerAttributeRangeCriterion": {
+                "identifier": "length",
+                "min": 180,
+                "max": 230
+            }
+        },
+        "names": {
+            "eng-GB": "Snow Equipment"
+        },
+        "status": "draft"
+    }
+}
+
+
+
+ View more +
+
+
+ +
+
+
+
-
-
-
+
+

file_copy

- 
+                            
                                 {
-  "ShippingMethodDataResponse": {
-    "_media-type": "application\/vnd.ibexa.api.ShippingMethodDataResponse+json",
-    "shippingMethods": {
-      "standard": "standard",
-      "expressDel": "express_delivery"
-    },
-    "defaultMethod": "standard",
-    "shippingMethodsSorted": []
-  }
-}
-
+    "Catalog": {
+        "_media-type": "application/vnd.ibexa.api.Catalog+json",
+        "identifier": "test_catalog",
+        "name": "Snow Equipment",
+        "description": "",
+        "User": {
+            "_media-type": "application/vnd.ibexa.api.User+json",
+            "_href": "/api/ibexa/v2/user/users/14"
+        },
+        "created": 1666090438,
+        "modified": 1666090438,
+        "status": "draft",
+        "Criteria": [
+            {
+                "_media-type": "application/vnd.ibexa.api.ProductCode+json",
+                "ProductCodeCriterion": {
+                    "_media-type": "application/vnd.ibexa.api.ProductCodeCriterion+json",
+                    "codes": [
+                        "ski",
+                        "snowboard"
+                    ]
+                }
+            },
+            {
+                "_media-type": "application/vnd.ibexa.api.ProductAvailability+json",
+                "ProductAvailabilityCriterion": {
+                    "_media-type":
- View more + View more
-
-
-

- Product catalog - -

-
-

/product/catalog/catalogs

-
-

/product/catalog/catalogs

+

/product/catalog/catalogs/copy/{identifier}

-
+
-
- Create catalog - + data-search="copy-catalog"> + Copy catalog +

POST - /product/catalog/catalogs + /product/catalog/catalogs/copy/{identifier}

-

Creates a new catalog.

+

Copies a catalog.

Header parameters

Accept

-

If set, the new catalog is returned in XML or JSON format.

+

If set, the copied catalog is returned in XML or JSON format.

@@ -77017,7 +80835,7 @@
Header parameters
@@ -77027,7 +80845,7 @@
Header parameters

Content-Type

-

The catalog schema encoded in XML or JSON format.

+

If set, the copied catalog is returned in XML or JSON format.

Examples - application/vnd.ibexa.api.CatalogCreate+json + application/vnd.ibexa.api.CatalogCopy+json
@@ -77052,7 +80870,7 @@
Header parameters
@@ -77076,7 +80894,7 @@
Possible responses
@@ -77106,7 +80924,7 @@
Possible responses
403 @@ -77114,7 +80932,7 @@
Possible responses
404 @@ -77135,16 +80953,8 @@
Types
- - - - @@ -77158,18 +80968,18 @@
Types
-
+
-
-
-
+
+

file_copy

- 
+                            
                                 {
-    "CatalogCreate": {
-        "identifier": "test_catalog",
-        "criteria": {
-            "ProductCodeCriterion": ["ski", "snowboard"],
-            "ProductAvailabilityCriterion": true,
-            "ColorAttributeCriterion": {
-                "identifier": "color",
-                "value": ["#000000", "#FFFFFF"]
-            },
-            "CreatedAtCriterion": {
-                "operator": ">=",
-                "created_at": "12-09-2022"
-            },
-            "FloatAttributeCriterion": {
-                "identifier": "width",
-                "value": 16.6
-            },
-            "IntegerAttributeRangeCriterion": {
-                "identifier": "length",
-                "min": 180,
-                "max": 230
-            }
-        },
-        "names": {
-            "eng-GB": "Snow Equipment"
-        },
-        "status": "draft"
+    "CatalogCopy": {
+        "identifier": "test_catalog_copied",
+        "creator_id": 14 //optional
     }
 }
- View more + View more
-
Examples - application/vnd.ibexa.api.CatalogCreate+json + application/vnd.ibexa.api.CatalogCopy+json
- 201 @@ -77098,7 +80916,7 @@
Possible responses
401 		-

Error - the user is not authorized to update this catalog.

+

Error - the user is not authorized to copy this catalog.
-

Error - a catalog with the same name already exists.

+

Error - a catalog with the same identifier already exists.
-

Error - no catalog with the given code exists.

+

Error - no catalog with the given identifier exists.
- - CatalogCreate - -
- - Catalog + + CatalogCopy
- - - - - - - - - - - - - - - - -
CodeDescription
- 204 - -

No content - the given catalog is deleted.

-
- 401 - -

Error - the user is not authorized to delete this catalog.

-
-
-
- - -
-
- -
-
-
-
-
-
+
-
- Load catalog - + data-search="filter-catalogs"> + Filter catalogs +

- GET - /product/catalog/catalogs/{identifier} + POST + /product/catalog/catalogs/view

-

Loads the given catalog.

+

Executes a query and returns a View including the results. The View input reflects the criteria model of the public API.

Header parameters

Accept

-

If set, the catalog is returned in XML or JSON format.

+

The view in XML or JSON format.

@@ -77667,7 +81324,8 @@
Header parameters
@@ -77677,7 +81335,7 @@
Header parameters

Content-Type

-

The catalog schema encoded in XML or JSON format.

+

The view input in XML or JSON format.

Examples - application/vnd.ibexa.api.CatalogGet+json + application/vnd.ibexa.api.CatalogView+xml +application/vnd.ibexa.api.CatalogView+json
@@ -77702,7 +81360,8 @@
Header parameters
@@ -77726,7 +81385,7 @@
Possible responses
- - - - @@ -77769,8 +81420,16 @@
Types
+ + + + @@ -77784,20 +81443,142 @@
Types
+
+
+ +
+
+
+
+
+

+ file_copy + +

+ 
+                                {
+    "ViewInput": {
+        "identifier": "TitleView",
+        "CatalogQuery": {
+            "Query": {
+                "CatalogIdentifierCriterion": "test",
+                "CatalogNameCriterion": "test"
+            }
+        }
+    }
+}
+
+
+
+ View more +
+
+
+ +
-
+
-
-
-
+
+

file_copy

- 
+                            
                                 {
-    "Catalog": {
-        "_media-type": "application/vnd.ibexa.api.Catalog+json",
-        "identifier": "test_catalog",
-        "name": "Snow Equipment",
-        "description": "",
-        "User": {
-            "_media-type": "application/vnd.ibexa.api.User+json",
-            "_href": "/api/ibexa/v2/user/users/14"
+    "CatalogView": {
+        "_media-type": "application/vnd.ibexa.api.CatalogView+json",
+        "identifier": "TitleView",
+        "CatalogQuery": {
+            "_media-type": "application/vnd.ibexa.api.CatalogQuery+json"
         },
-        "created": 1666090438,
-        "modified": 1666090438,
-        "status": "draft",
-        "Criteria": [
-            {
-                "_media-type": "application/vnd.ibexa.api.ProductCode+json",
-                "ProductCodeCriterion": {
-                    "_media-type": "application/vnd.ibexa.api.ProductCodeCriterion+json",
-                    "codes": [
-                        "ski",
-                        "snowboard"
-                    ]
-                }
-            },
-            {
-                "_media-type": "application/vnd.ibexa.api.ProductAvailability+json",
-                "ProductAvailabilityCriterion": {
-                    "_media-type":
+        "Result": {
+            "_media-type": "application/vnd.ibexa.api.ViewResult+json",
+            "count": 1,
+            "CatalogList": {
+                "_media-type": "application/vnd.ibexa.api.CatalogList+json",
+                "Catalog": [
+                    {
+                        "_media-type": "application/vnd.ibexa.api.Catalog+json",
+                        "identifier": "test",
+                        "name": "test",
+                        "description": "",
+                        "User": {
+                            "_media-type": "application/vnd.ibexa.api.User+json",
+                            "_href": "/api/ibexa/v2/user/users/14"
+                        },
+                        "created": 1665479475,
+
- View more + View more
-
Examples - application/vnd.ibexa.api.CatalogGet+json + application/vnd.ibexa.api.CatalogViewInput+xml +application/vnd.ibexa.api.CatalogViewInput+json
- 200 @@ -77737,18 +81396,10 @@
Possible responses
- 401 - -

Error - the user is not authorized to view this catalog.

-
- 404 + 400 -

Error - no catalog with the given identifier exists.

+

Error - the input does not match the input schema definition.
- - Catalog + + CatalogViewInput + +
+ + ProductView
@@ -78044,7 +81803,8 @@
Header parameters
@@ -78054,7 +81814,7 @@
Header parameters

Content-Type

-

If set, the updated catalog is returned in XML or JSON format.

+

The view input in XML or JSON format.

Examples - application/vnd.ibexa.api.CatalogUpdate+json + application/vnd.ibexa.api.ProductView+xml +application/vnd.ibexa.api.ProductView+json
@@ -78079,7 +81839,8 @@
Header parameters
@@ -78103,9 +81864,9 @@
Possible responses
- - - - - - - - - - - -
Examples - application/vnd.ibexa.api.CatalogUpdate+json + application/vnd.ibexa.api.ProductViewInput+xml +application/vnd.ibexa.api.ProductViewInput+json
- - 201 + 200 @@ -78119,30 +81880,6 @@
Possible responses

Error - the input does not match the input schema definition.

- 401 - -

Error - the user is not authorized to update this catalog.

-
- 403 - -

Error - a catalog with the same identifier already exists.

-
- 404 - -

Error - no catalog with the given identifier exists.

-
@@ -78162,8 +81899,16 @@
Types
- - CatalogUpdate + + ProductViewInput + + + + + + + + ProductView @@ -78177,18 +81922,18 @@
Types
-
+
-
-
-
+
+

file_copy

- 
+                            
                                 {
-    "CatalogUpdate": {
-        "identifier": "test_catalog_updated",
-        "criteria": {
-            "ProductCodeCriterion": ["ski"],
-            "ProductAvailabilityCriterion": false,
-            "CreatedAtCriterion": {
-                "operator": ">=",
-                "created_at": "12-12-2022"
+    "ViewInput": {
+        "identifier": "TitleView",
+        "ProductQuery": {
+            "Query": {
+                "ProductCodeCriterion": "test",
+                "ProductAvailabilityCriterion": true
             }
-        },
-        "names": {
-            "eng-GB": "Snow Equipment updated"
-        },
-        "descriptions": {
-            "eng-GB": "Snow Equipment catalog for 2022"
-        },
-        "transition": "publish"
+        }
     }
 }
- View more + View more
-
+
+

+ Taxonomy + +

+
-

/product/catalog/product_variants/view

+

/taxonomy/{taxonomyName}/entry/{id}

-
+
-
- Filter product variants - + data-search="get-entry-by-id"> + Get Entry by ID +

- POST - /product/catalog/product_variants/view + GET + /taxonomy/{taxonomyName}/entry/{id}

-

Executes a query and returns a View including the results. The View input reflects the criteria model of the public API.

+

Loads taxonomy Entry by its Entry ID.

Header parameters

Accept

-

The view in XML or JSON format.

-
- - - - - - - - - - - - - - - - - -
PropertyValue
Type - - - string - - - - -
Examples - application/vnd.ibexa.api.ProductVariantView+xml -application/vnd.ibexa.api.ProductVariantView+json - -
-
-
-
-

Content-Type

-

The view input in XML or JSON format.

+

If set, the Taxonomy Entry is returned in XML or JSON format.

@@ -95758,8 +102343,7 @@
Header parameters
@@ -95783,18 +102367,29 @@
Possible responses
+ + + + @@ -95815,8 +102410,8 @@
Types
@@ -95827,142 +102422,27 @@
Types
-
- -
-
-
- -
-
-
-
-
-

- file_copy - -

- 
-                                {
-    "ViewInput": {
-        "identifier": "TitleView",
-        "ProductVariantQuery": {
-            "offset": "0",
-            "limit": "10"
-        }
-    }
-}
-
-
-
- View more -
-
-
- -
+
+ +
-
+
+
+
    +
+
+
+
-
-

/product/catalog/product_variant

-
-
+
-

/product/catalog/product_variant/{code}

+

/taxonomy/{taxonomyName}/entry/identifier/{identifier}

-
+
-
- Load product variant - + data-search="get-entry-by-identifier"> + Get Entry by identifier +

GET - /product/catalog/product_variant/{code} + /taxonomy/{taxonomyName}/entry/identifier/{identifier}

-

Loads the given product variant.

+

Loads taxonomy Entry by its Entry identifier.

Header parameters

Accept

-

If set, the product variant is returned in XML or JSON format.

+

If set, the Taxonomy Entry is returned in XML or JSON format.

Examples - application/vnd.ibexa.api.ProductVariantViewInput+xml -application/vnd.ibexa.api.ProductVariantViewInput+json + application/vnd.ibexa.api.TaxonomyEntry+json
- 200 + + 200 + -

+

OK - returns the taxonomy Entry.
- 400 + 401 -

Error - the input does not match the input schema definition.

+

Error - the user is not authorized to read this Entry.

+
+ 404 + +

Error - the Entry does not exists.
- - ProductVariantViewInput + + TaxonomyEntry
@@ -96018,7 +102498,7 @@
Header parameters
@@ -96026,9 +102506,129 @@
Header parameters
Examples - application/vnd.ibexa.api.ProductVariantGet+json + application/vnd.ibexa.api.TaxonomyEntry+json
+
+ + +
+
Possible responses
+
+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
+ + 200 + + +

OK - returns the taxonomy Entry.

+
+ 401 + +

Error - the user is not authorized to read this Entry.

+
+ 404 + +

Error - the Entry does not exists.

+
+
+
+ +
+
Types
+
+ + + + + + + + + + + + + +
TypeDescription
+ + TaxonomyEntry + +
+
+
+ +
+
+ +
+
+
+
+
+
    +
+
+
+
+
+
+
+
+
+

/taxonomy/{taxonomyName}/entry/content-id/{contentId}

+ +
+
+
+
+
+
+ Get Entry by Content ID + +
+
+
+

+ GET + /taxonomy/{taxonomyName}/entry/content-id/{contentId} +

+

Loads taxonomy Entry by its Content ID.

+

+
+
Header parameters
-

Content-Type

-

The product variant schema encoded in XML or JSON format.

+

Accept

+

If set, the Taxonomy Entry is returned in XML or JSON format.

@@ -96053,7 +102653,7 @@
Header parameters
@@ -96077,13 +102677,13 @@
Possible responses
@@ -96091,7 +102691,7 @@
Possible responses
401 @@ -96099,7 +102699,7 @@
Possible responses
404 @@ -96120,8 +102720,8 @@
Types
@@ -96137,347 +102737,254 @@
Types
-
+
- -
- Code: 200 -
+
    +
-
-
-
-
-

- file_copy - -

- 
-                                {
-    "ProductVariant": {
-        "_media-type": "application/vnd.ibexa.api.ProductVariant+json",
-        "code": "macbook",
-        "name": "Macbook Air 32/232",
-        "Product": {
-            "_media-type": "application/vnd.ibexa.api.Product+json",
-            "code": "mac_air",
-            "name": "Macbook Air",
-            "ProductType": {
-                "_media-type": "application/vnd.ibexa.api.ProductType+json",
-                "identifier": "laptop",
-                "name": "Laptop",
-                "AttributeAssignmentList": [
-                    {
-                        "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json",
-                        "is_required": false,
-                        "is_discriminator": true,
-                        "Attribute": {
-                            "_media-type": "application/vnd.ibexa.api.Attribute+json",
-                            "identifier": "number",
-                            "name": "number",
-                     
-
-
- View more +
+
-
+
-
Examples - application/vnd.ibexa.api.ProductVariantGet+json + application/vnd.ibexa.api.TaxonomyEntry+json
- 200 -

+

OK - returns the taxonomy Entry.
-

Error - the user is not authorized to view this product variant.

+

Error - the user is not authorized to read this Entry.
-

Error - no product variant with the given code exists.

+

Error - the Entry does not exists.
- - ProductVariant + + TaxonomyEntry
+ + + + + + + + + + + + + + + + +
PropertyValue
Type + + + string + + + + +
Examples + application/vnd.ibexa.api.TaxonomyEntryBulkRemove+xml +application/vnd.ibexa.api.TaxonomyEntryBulkRemove+json + +
+
+
+
+ + +
+
Possible responses
+
+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
+ 204 + +

No Content - The entries have been deleted.

+
+ 400 + +

Error - The input does not match the input schema definition.

+
+ 401 + +

Error - The user is not authorized to delete some of the entries.

+
+
+
+ +
+
Types
+
+ + + + + + + + + + + + + +
TypeDescription
+ + TaxonomyEntryBulkRemove + +
+
+
+ +
+
+ +
+
+
+ +
+
+
+
+
+

+ file_copy + +

+ 
+                                {
+    "TaxonomyEntryBulkRemove": {
+        "entries": [ 2, 3 ]
+    }
+}
+
+
+
+ View more +
+
+
+
-
-

/product/catalog/vat

-
-
+
-

/product/catalog/vat/{region}

+

/taxonomy/{taxonomyName}/entries/move

-
+
-
- Load VAT region - + data-search="move-entries"> + Move Entries +

- GET - /product/catalog/vat/{region} + POST + /taxonomy/{taxonomyName}/entries/move

-

Loads a VAT category for the given region.

+

Bulk move several taxonomy entries relative to sibling.

Header parameters
-

Accept

-

If set, the VAT category list returned in XML or JSON format.

+

Content-Type

+

The Entry moves schema encoded in XML or JSON format.

@@ -96559,7 +103065,8 @@
Header parameters
@@ -96583,13 +103090,18 @@
Possible responses
+ + + + @@ -96597,7 +103109,7 @@
Possible responses
401 @@ -96605,7 +103117,7 @@
Possible responses
404 @@ -96626,8 +103138,8 @@
Types
@@ -96641,82 +103153,68 @@
Types
-
-
-
-
- -
- Code: 200 -
-
-
-
-
+
+
+ +
+
+
+

file_copy

- 
+                            
                                 {
-    "VatCategoryList": {
-        "_media-type": "application/vnd.ibexa.api.VatCategoryList+json",
-        "VatCategory": [
-            {
-                "_media-type": "application/vnd.ibexa.api.VatCategory+json",
-                "identifier": "standard",
-                "region": "region_1",
-                "vatValue": 18
-            },
-            {
-                "_media-type": "application/vnd.ibexa.api.VatCategory+json",
-                "identifier": "reduced",
-                "region": "region_1",
-                "vatValue": 6
-            },
-            {
-                "_media-type": "application/vnd.ibexa.api.VatCategory+json",
-                "identifier": "none",
-                "region": "region_1",
-                "vatValue": null
-            }
+    "TaxonomyEntryBulkMove": {
+        "entries": [
+            [
+                entry: 2,
+                sibling: 1,
+                position: 'next'
+            ],
+            [
+                entry: 3,
+                sibling: 1,
+                position: 'prev'
+            ],
         ]
     }
 }
- View more + View more
-
-

/product/catalog/vat/{region}/{identifier}

+

/taxonomy/{taxonomyName}/entry-assignment/{id}

-
+
-
- Load VAT specific region - + data-search="get-assignment-by-id"> + Get Assignment by ID +

GET - /product/catalog/vat/{region}/{identifier} + /taxonomy/{taxonomyName}/entry-assignment/{id}

-

Loads a VAT category for the given identifier.

+

Gets taxonomy entry Assignment by its ID.

Header parameters

Accept

-

If set, the VAT category list returned in XML or JSON format.

+

If set, the Assignment is returned in XML or JSON format.

+
+
Examples - application/vnd.ibexa.api.VatCategoryList+json + application/vnd.ibexa.api.TaxonomyEntryBulkMove+xml +application/vnd.ibexa.api.TaxonomyEntryBulkMove+json
- - 200 - + 204 -

+

No Content - The entries have been moved.

+
+ 400 + +

Error - The input does not match the input schema definition.
-

Error - the user is not authorized to read this object.

+

Error - The user is not authorized to move some of the entries.
-

Error - the VAT category region does not exist.

+

Error - Some to-be-moved or sibling entries do not exist.
- - VatCategoryList + + TaxonomyEntryBulkMove
+ + + + + + + + + + + + + + + + +
PropertyValue
Type + + + string + + + + +
Examples + application/vnd.ibexa.api.TaxonomyEntryAssignment+json + +
+
+
+
+ + +
+
Possible responses
+
+ + + + + + + + + + + + + + + + + +
CodeDescription
+ + 200 + + +

OK - returns the taxonomy entry Assignment.

+
+ 404 + +

Error - the assignment does not exist.

+
+
+
+ +
+
Types
+
+ + + + + + + + + + + + + +
TypeDescription
+ + TaxonomyEntryAssignment + +
+
+
+ +
+
+ +
+
+
+
+
+
    +
+
+
+
+
+
+
+
+
+

/taxonomy/{taxonomyName}/entry-assignments/assign-to-content

+ +
+
+
+
+
+
+ Assign entry + +
+
+
+

+ POST + /taxonomy/{taxonomyName}/entry-assignments/assign-to-content +

+

Assigns taxonomy entry to a Content item.

+

+
+
Header parameters
+
+

Accept

+

+
+ + + + + + + + + + + + + + + + + +
PropertyValue
Type + + + string + + + + +
Examples + application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json + +
+
+
+
+

Content-Type

+

@@ -96864,7 +103534,7 @@
Header parameters
@@ -96888,29 +103558,26 @@
Possible responses
@@ -96931,8 +103598,8 @@
Types
@@ -96946,65 +103613,61 @@
Types
-
-
-
-
- -
- Code: 200 -
-
-
-
-
+
+
+ +
+
+
+

file_copy

- 
+                            
                                 {
-    "VatCategory": {
-        "_media-type": "application/vnd.ibexa.api.VatCategory+json",
-        "identifier": "standard",
-        "region": "region_1",
-        "vatValue": 18
+    "TaxonomyEntryAssignToContent": {
+        "content": 130,
+        "entries": 
+        [
+            2, 3
+        ]
     }
 }
- View more + View more
- - -
-

- Taxonomy - -

-
-

/taxonomy/{taxonomyName}/entry-assignments/assign-to-content

-
-

/taxonomy/{taxonomyName}/entry-assignments/assign-to-content

+

/taxonomy/{taxonomyName}/entry-assignments/unassign-from-content

  • - + POST @@ -97097,23 +103751,23 @@

    +
    -
    - Assign entry - + data-search="unassign-entry"> + Unassign entry +

    POST - /taxonomy/{taxonomyName}/entry-assignments/assign-to-content + /taxonomy/{taxonomyName}/entry-assignments/unassign-from-content

    -

    Assigns taxonomy entry to a Content item.

    +

    Unassigns taxonomy entry from a Content item.

    Header parameters
    @@ -97144,7 +103798,7 @@
    Header parameters

@@ -97179,7 +103833,7 @@
Header parameters
@@ -97222,7 +103876,7 @@
Possible responses
401 @@ -97243,8 +103897,8 @@
Types
@@ -97258,18 +103912,18 @@
Types
-
+
-
-
-
+
+

file_copy

- 
+                            
                                 {
-    "TaxonomyEntryAssignToContent": {
+    "TaxonomyEntryUnassignFromContent": {
         "content": 130,
         "entries": 
         [
             2, 3
         ]
     }
-}
-
+}
- View more + View more
-
Examples - application/vnd.ibexa.api.VatCategory+json + application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json
- - 200 - + 201 -

+

No Content.
- 401 + 400 -

Error - the user is not authorized to read this object.

+

Error - the input does not match the input schema definition.
- 404 + 401 -

Error - the VAT category for the given identifier not exists.

+

Error - the user is not authorized to assign this Entry.
- - VatCategory + + TaxonomyEntryAssignToContent
Examples - application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json + aapplication/vnd.ibexa.api.TaxonomyEntryUnassignFromContent+json
Examples - application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json + application/vnd.ibexa.api.TaxonomyEntryUnassignFromContent+json
-

Error - the user is not authorized to assign this Entry.

+

Error - the user is not authorized to unassign this entry.
- - TaxonomyEntryAssignToContent + + TaxonomyEntryUnassignFromContent
- - - - - - - - - - - - - - - - -
PropertyValue
Type - - - string - - - - -
Examples - aapplication/vnd.ibexa.api.TaxonomyEntryUnassignFromContent+json - -
-
-
-
-

Content-Type

-

+

If set, the assignments are returned in XML or JSON format.

@@ -97481,7 +104095,8 @@
Header parameters
@@ -97505,26 +104120,21 @@
Possible responses
- - - - @@ -97545,8 +104155,8 @@
Types
@@ -97560,60 +104170,118 @@
Types
-
-
- -
-
-
-
+
+
+
+
+ +
+ Code: 200 +
+
+
+
+

file_copy

- 
+                            
+                                <?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="applic
+                            

+
+ View more +
+
+
+

+ file_copy + +

+ 
                                 {
-    "TaxonomyEntryUnassignFromContent": {
-        "content": 130,
-        "entries": 
-        [
-            2, 3
-        ]
-    }
-}
+  "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"
+        },
+        "Sectio
- View more + View more
-
- + +
+
@@ -78925,7 +78925,7 @@

/commerce/country

/commerce/country

-
+
-
- Gets list of countries. - + data-search="get-list-of-countries-deprecated"> + Get list of countries (deprecated) +
@@ -78950,7 +78950,8 @@

/commerce/country

GET /commerce/country

-

+

Deprecated, use GET /services/countries instead.

+

@@ -79096,7 +79097,7 @@
Types
-

/content/trash/{trashItemid}

+

/content/trash/{trashItemId}

-
-
-

/user/users/current

- -
-
-
-
-
-
- Load current User - -
-
-
-

- GET - /user/users/current -

-

Redirects to current User, if available.

-

-
-
Header parameters
-
-

Accept

-

If set, the User is returned in XML or JSON format (after redirection).

-
-
Examples - application/vnd.ibexa.api.TaxonomyEntryUnassignFromContent+json + application/vnd.ibexa.api.EntryAssignmentCollection+xml +application/vnd.ibexa.api.EntryAssignmentCollection+json
- 201 - -

No Content.

-
- 400 + + 200 + -

Error - the input does not match the input schema definition.

+

OK - returns the assigment collection.
- 401 + 404 -

Error - the user is not authorized to unassign this entry.

+

Error - the Content does not exists.
- - TaxonomyEntryUnassignFromContent + + EntryAssignmentCollection
Examples - application/vnd.ibexa.api.CountriesLis+xml -application/vnd.ibexa.api.CountriesLis+json + application/vnd.ibexa.api.CountriesList+xml +application/vnd.ibexa.api.CountriesList+json
- - - - - - - - - - - - - - - - -
PropertyValue
Type - - - string - - - - -
Examples - application/vnd.ibexa.api.User+xml -application/vnd.ibexa.api.User+json - -
-
-
-
- - -
-
Possible responses
-
- - - - - - - - - - - - - - - - - -
CodeDescription
- 307 - -

OK.

-
- 401 - -

User is not currently logged in.

-
-
-
- - -
-
- -
-
-
-
-
-