diff --git a/docs/api/rest_api/rest_api_reference/input/examples/content/objects/POST/ContentCreate.json.example b/docs/api/rest_api/rest_api_reference/input/examples/content/objects/POST/ContentCreate.json.example index 81dc8c3009..022999ad35 100644 --- a/docs/api/rest_api/rest_api_reference/input/examples/content/objects/POST/ContentCreate.json.example +++ b/docs/api/rest_api/rest_api_reference/input/examples/content/objects/POST/ContentCreate.json.example @@ -29,7 +29,7 @@ "fieldDefinitionIdentifier": "intro", "languageCode": "eng-GB", "fieldTypeIdentifier": "ezrichtext", - "fieldValue": + "fieldValue": { "xml": "

draft draft

" } diff --git a/docs/api/rest_api/rest_api_reference/input/examples/content/objects/content_id/locations/POST/LocationCreate.json.example b/docs/api/rest_api/rest_api_reference/input/examples/content/objects/content_id/locations/POST/LocationCreate.json.example index 45b9c13eaf..9169dacd42 100644 --- a/docs/api/rest_api/rest_api_reference/input/examples/content/objects/content_id/locations/POST/LocationCreate.json.example +++ b/docs/api/rest_api/rest_api_reference/input/examples/content/objects/content_id/locations/POST/LocationCreate.json.example @@ -3,10 +3,9 @@ "ParentLocation": { "_href": "/api/ibexa/v2/content/locations/1/59" }, - "priority": "0", - "hidden": false, - "sortField": "PATH", - "sortOrder": "ASC" - + "priority": "0", + "hidden": false, + "sortField": "PATH", + "sortOrder": "ASC" } } diff --git a/docs/api/rest_api/rest_api_reference/input/examples/content/objectstategroups/object_state_group_id/PATCH/ObjectStateGroupUpdate.json.example b/docs/api/rest_api/rest_api_reference/input/examples/content/objectstategroups/object_state_group_id/PATCH/ObjectStateGroupUpdate.json.example index 8ba08e6644..8510b26848 100644 --- a/docs/api/rest_api/rest_api_reference/input/examples/content/objectstategroups/object_state_group_id/PATCH/ObjectStateGroupUpdate.json.example +++ b/docs/api/rest_api/rest_api_reference/input/examples/content/objectstategroups/object_state_group_id/PATCH/ObjectStateGroupUpdate.json.example @@ -1,5 +1,5 @@ { - "ObjectStateGroup": { + "ObjectStateGroupUpdate": { "names": { "value": [ { diff --git a/docs/api/rest_api/rest_api_reference/input/examples/content/objectstategroups/object_state_group_id/PATCH/ObjectStateGroupUpdate.xml.example b/docs/api/rest_api/rest_api_reference/input/examples/content/objectstategroups/object_state_group_id/PATCH/ObjectStateGroupUpdate.xml.example index c0fa5e9e43..c0d7b5c7e5 100644 --- a/docs/api/rest_api/rest_api_reference/input/examples/content/objectstategroups/object_state_group_id/PATCH/ObjectStateGroupUpdate.xml.example +++ b/docs/api/rest_api/rest_api_reference/input/examples/content/objectstategroups/object_state_group_id/PATCH/ObjectStateGroupUpdate.xml.example @@ -1,6 +1,6 @@ - + New Custom State name - + diff --git a/docs/api/rest_api/rest_api_reference/input/examples/content/objectstategroups/object_state_group_id/objectstates/object_state_id/PATCH/ObjectStateUpdate.json.example b/docs/api/rest_api/rest_api_reference/input/examples/content/objectstategroups/object_state_group_id/objectstates/object_state_id/PATCH/ObjectStateUpdate.json.example index fbf9c69e38..519d608f2f 100644 --- a/docs/api/rest_api/rest_api_reference/input/examples/content/objectstategroups/object_state_group_id/objectstates/object_state_id/PATCH/ObjectStateUpdate.json.example +++ b/docs/api/rest_api/rest_api_reference/input/examples/content/objectstategroups/object_state_group_id/objectstates/object_state_id/PATCH/ObjectStateUpdate.json.example @@ -1,5 +1,5 @@ { - "ObjectStateGroup": { + "ObjectStateUpdate": { "names": { "value": [ { diff --git a/docs/api/rest_api/rest_api_reference/input/examples/content/objectstategroups/object_state_group_id/objectstates/object_state_id/PATCH/ObjectStateUpdate.xml.example b/docs/api/rest_api/rest_api_reference/input/examples/content/objectstategroups/object_state_group_id/objectstates/object_state_id/PATCH/ObjectStateUpdate.xml.example index 579ee16e61..8b7271316c 100644 --- a/docs/api/rest_api/rest_api_reference/input/examples/content/objectstategroups/object_state_group_id/objectstates/object_state_id/PATCH/ObjectStateUpdate.xml.example +++ b/docs/api/rest_api/rest_api_reference/input/examples/content/objectstategroups/object_state_group_id/objectstates/object_state_id/PATCH/ObjectStateUpdate.xml.example @@ -1,8 +1,8 @@ - + 3 eng-GB New Object State name - + diff --git a/docs/api/rest_api/rest_api_reference/input/examples/content/types/content_type_id/draft/PATCH/ContentTypeUpdate.json.example b/docs/api/rest_api/rest_api_reference/input/examples/content/types/content_type_id/draft/PATCH/ContentTypeUpdate.json.example index 9b5c31b019..ad37108944 100644 --- a/docs/api/rest_api/rest_api_reference/input/examples/content/types/content_type_id/draft/PATCH/ContentTypeUpdate.json.example +++ b/docs/api/rest_api/rest_api_reference/input/examples/content/types/content_type_id/draft/PATCH/ContentTypeUpdate.json.example @@ -1,16 +1,20 @@ { "ContentTypeUpdate": { "names": { - "value": [ { - "_languageCode": "eng-GB", - "#text": "Updated content type name" - } ] + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Updated content type name" + } + ] }, "descriptions": { - "value": [ { - "_languageCode": "eng-GB", - "#text": "This is an updated content type description" - } ] + "value": [ + { + "_languageCode": "eng-GB", + "#text": "This is an updated content type description" + } + ] } } } \ No newline at end of file diff --git a/docs/api/rest_api/rest_api_reference/input/examples/content/types/content_type_id/groups/POST/ContentTypeGroupRefList.json.example b/docs/api/rest_api/rest_api_reference/input/examples/content/types/content_type_id/groups/POST/ContentTypeGroupRefList.json.example deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/rest_api/rest_api_reference/input/examples/content/urlwildcards/POST/UrlWildcardCreate.json.example b/docs/api/rest_api/rest_api_reference/input/examples/content/urlwildcards/POST/UrlWildcardCreate.json.example index 403ba11013..0bc4c24da1 100644 --- a/docs/api/rest_api/rest_api_reference/input/examples/content/urlwildcards/POST/UrlWildcardCreate.json.example +++ b/docs/api/rest_api/rest_api_reference/input/examples/content/urlwildcards/POST/UrlWildcardCreate.json.example @@ -1,5 +1,5 @@ { - "UrlWildCardCreate": { + "URLWildcardCreate": { "sourceUrl": "/api/ibexa/v2/content/location/2", "destinationUrl": "/api/ibexa/v2/content/location/59", "forward": true diff --git a/docs/api/rest_api/rest_api_reference/input/examples/payment-methods/identifier/PATCH/PaymentMethodUpdateStruct.json.example b/docs/api/rest_api/rest_api_reference/input/examples/payment-methods/identifier/PATCH/PaymentMethodUpdateStruct.json.example index 0f00b05f18..36ecfbcf42 100644 --- a/docs/api/rest_api/rest_api_reference/input/examples/payment-methods/identifier/PATCH/PaymentMethodUpdateStruct.json.example +++ b/docs/api/rest_api/rest_api_reference/input/examples/payment-methods/identifier/PATCH/PaymentMethodUpdateStruct.json.example @@ -1,5 +1,5 @@ { - "PaymentMethodUpdateStructParser": { + "PaymentMethodUpdateStruct": { "names": { "eng-GB": "Bank transfer (updated)" } diff --git a/docs/api/rest_api/rest_api_reference/input/examples/payment-methods/identifier/PATCH/PaymentMethodUpdateStruct.xml.example b/docs/api/rest_api/rest_api_reference/input/examples/payment-methods/identifier/PATCH/PaymentMethodUpdateStruct.xml.example index 081614ad71..9bae758c99 100644 --- a/docs/api/rest_api/rest_api_reference/input/examples/payment-methods/identifier/PATCH/PaymentMethodUpdateStruct.xml.example +++ b/docs/api/rest_api/rest_api_reference/input/examples/payment-methods/identifier/PATCH/PaymentMethodUpdateStruct.xml.example @@ -1,6 +1,6 @@ - + Bank transfer (updated) - \ No newline at end of file + diff --git a/docs/api/rest_api/rest_api_reference/input/examples/product/catalog/attribute_groups/POST/AttributeGroupCreate.json.example b/docs/api/rest_api/rest_api_reference/input/examples/product/catalog/attribute_groups/POST/AttributeGroupCreate.json.example index d64e64bf7d..252c8b9a1f 100644 --- a/docs/api/rest_api/rest_api_reference/input/examples/product/catalog/attribute_groups/POST/AttributeGroupCreate.json.example +++ b/docs/api/rest_api/rest_api_reference/input/examples/product/catalog/attribute_groups/POST/AttributeGroupCreate.json.example @@ -2,7 +2,7 @@ "AttributeGroupCreate": { "identifier": "attr_group_test", "names": { - "eng-GB": "Attribute Group Test" + "eng-GB": "Attribute Group Test" }, "position": 0 } diff --git a/docs/api/rest_api/rest_api_reference/input/examples/product/catalog/attributes/POST/AttributeCreate.json.example b/docs/api/rest_api/rest_api_reference/input/examples/product/catalog/attributes/POST/AttributeCreate.json.example index 13c0ea66a5..ce3cf7b2e8 100644 --- a/docs/api/rest_api/rest_api_reference/input/examples/product/catalog/attributes/POST/AttributeCreate.json.example +++ b/docs/api/rest_api/rest_api_reference/input/examples/product/catalog/attributes/POST/AttributeCreate.json.example @@ -4,10 +4,10 @@ "type": "checkbox", "group": "attr_group_test", "names": { - "eng-GB": "Attribute" + "eng-GB": "Attribute" }, "descriptions": { - "eng-GB": "description" + "eng-GB": "description" }, "position": 0, "options": { diff --git a/docs/api/rest_api/rest_api_reference/input/examples/product/catalog/attributes/id/group_id/PATCH/AttributeUpdate.json.example b/docs/api/rest_api/rest_api_reference/input/examples/product/catalog/attributes/id/group_id/PATCH/AttributeUpdate.json.example index 4c1df8335d..33f61166b1 100644 --- a/docs/api/rest_api/rest_api_reference/input/examples/product/catalog/attributes/id/group_id/PATCH/AttributeUpdate.json.example +++ b/docs/api/rest_api/rest_api_reference/input/examples/product/catalog/attributes/id/group_id/PATCH/AttributeUpdate.json.example @@ -1,13 +1,15 @@ { "AttributeUpdate": { "identifier": "attr_group", + "names": { "eng-GB": "Attribute Group" }, "descriptions": { - "eng-GB": "description" + "eng-GB": "description" }, - "position": 0, - "options": { + "position": 0, + "options": { "foo": "bar" } + } } diff --git a/docs/api/rest_api/rest_api_reference/input/examples/product/catalog/customer_groups/POST/CustomerGroupCreate.json.example b/docs/api/rest_api/rest_api_reference/input/examples/product/catalog/customer_groups/POST/CustomerGroupCreate.json.example index 7ef71638b0..a729f64c64 100644 --- a/docs/api/rest_api/rest_api_reference/input/examples/product/catalog/customer_groups/POST/CustomerGroupCreate.json.example +++ b/docs/api/rest_api/rest_api_reference/input/examples/product/catalog/customer_groups/POST/CustomerGroupCreate.json.example @@ -4,7 +4,7 @@ "names": { "eng-GB": "Customer Group" }, - "descriptions:": { + "descriptions": { "eng-GB": "Customer Group description" }, "global_price_rate": "1" diff --git a/docs/api/rest_api/rest_api_reference/input/examples/product/catalog/product/code/PATCH/ProductUpdate.json.example b/docs/api/rest_api/rest_api_reference/input/examples/product/catalog/product/code/PATCH/ProductUpdate.json.example index b9f2209205..784b726688 100644 --- a/docs/api/rest_api/rest_api_reference/input/examples/product/catalog/product/code/PATCH/ProductUpdate.json.example +++ b/docs/api/rest_api/rest_api_reference/input/examples/product/catalog/product/code/PATCH/ProductUpdate.json.example @@ -1,6 +1,6 @@ { "ProductUpdate": { - "ContentUpdate": { + "ContentUpdate": { "__url": "/api/ibexa/v2/content/objects/67", "fields": { "field": [ diff --git a/docs/api/rest_api/rest_api_reference/input/examples/user/groups/path/roles/POST/RoleAssignInput.json.example b/docs/api/rest_api/rest_api_reference/input/examples/user/groups/path/roles/POST/RoleAssignInput.json.example index fc094e2dc3..ede4f8fc34 100644 --- a/docs/api/rest_api/rest_api_reference/input/examples/user/groups/path/roles/POST/RoleAssignInput.json.example +++ b/docs/api/rest_api/rest_api_reference/input/examples/user/groups/path/roles/POST/RoleAssignInput.json.example @@ -1,23 +1,19 @@ { "RoleAssignInput": { "Role": { - "_href": "/api/ibexa/v2/user/roles/2", - "media-type": "application/vnd.ibexa.api.RoleAssignInput+json", - "self-closing": "true" + "_href": "/api/ibexa/v2/user/roles/2" }, - "Limitation": { - "identifier": "Section", + "limitation": { + "_identifier": "Section", "values": { "ref": [ { "_href": "/api/ibexa/v2/content/sections/1", - "media-type": "application/vnd.ibexa.api.Section+json", - "self-closing": "true" + "_media-type": "application/vnd.ibexa.api.Section+json" }, { "_href": "/api/ibexa/v2/content/sections/4", - "media-type": "application/vnd.ibexa.api.Section+json", - "self-closing": "true" + "_media-type": "application/vnd.ibexa.api.Section+json" } ] } diff --git a/docs/api/rest_api/rest_api_reference/input/examples/user/users/user_id/roles/POST/RoleAssignInput.json.example b/docs/api/rest_api/rest_api_reference/input/examples/user/users/user_id/roles/POST/RoleAssignInput.json.example index 0fb9131330..929e897f7e 100644 --- a/docs/api/rest_api/rest_api_reference/input/examples/user/users/user_id/roles/POST/RoleAssignInput.json.example +++ b/docs/api/rest_api/rest_api_reference/input/examples/user/users/user_id/roles/POST/RoleAssignInput.json.example @@ -1,23 +1,17 @@ { "RoleAssignInput": { "Role": { - "_href": "/api/ibexa/v2/user/roles/2", - "_media-type": "application/vnd.ibexa.api.RoleAssignInput+xml", - "self-closing": "true" + "_href": "/api/ibexa/v2/user/roles/2" }, "limitation": { "_identifier": "Section", "values": { "ref": [ { - "_href": "/api/ibexa/v2/content/sections/1", - "media-type": "application/vnd.ibexa.api.Section+xml", - "self-closing": "true" + "_href": "/api/ibexa/v2/content/sections/1" }, { - "_href": "/api/ibexa/v2/content/sections/2", - "_media-type": "application/vnd.ibexa.api.Section+xml", - "self-closing": "true" + "_href": "/api/ibexa/v2/content/sections/2" } ] } diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-activityloggroup.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-activityloggroup.raml index 4a8caa079d..c8e33aef29 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-activityloggroup.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-activityloggroup.raml @@ -18,14 +18,14 @@ displayName: Monitoring activity type: string description: | Maximum number of returned log groups (default: limit=25) - + Example: limit=10 filter: type: array description: | List of filters (no filter by default). A filter is a type and parameters depending on this type. - + - type: `object_class`, parameter: `class` (a FQCN) - type: `action`, parameter: `value` (the action) - type: `logged_at`, parameters: `value` and `operator` @@ -40,14 +40,14 @@ displayName: Monitoring activity | Less than or equal | `<=` | | Greater than | `>` | | Greater than or equal | `>=` | - + Example: `filter[0][type]=object_class&filter[0][class]=Ibexa\Contracts\Core\Repository\Values\Content\Content&filter[1][type]=action&filter[1][value]=create&filter[2][type]=logged_at&filter[2][value]=-1hour&filter[2][operator]=>=` sort: type: array description: | List of sort clause and direction pairs (default: sort[0][type]=logged_at&sort[0][direction]=ASC) - + Example: sort[0][type]=logged_at&sort[0][direction]=DESC responses: 200: @@ -56,7 +56,7 @@ displayName: Monitoring activity type: ActivityLogGroupList example: !include examples/activityloggroup/GET/ActivityLogGroupList.xml.example application/vnd.ibexa.api.ActivityLogGroupList+json: - type: ActivityLogGroupList + type: ActivityLogGroupListWrapper example: !include examples/activityloggroup/GET/ActivityLogGroupList.json.example 401: description: Error - the user is not authorized to list activities. @@ -79,7 +79,7 @@ displayName: Monitoring activity type: ActivityLogGroupListInput example: !include examples/activityloggroup/POST/ActivityLogGroupListInput.xml.example application/vnd.ibexa.api.ActivityLogGroupListInput+json: - type: ActivityLogGroupListInput + type: ActivityLogGroupListInputWrapper example: !include examples/activityloggroup/POST/ActivityLogGroupListInput.json.example responses: 200: @@ -88,7 +88,7 @@ displayName: Monitoring activity type: ActivityLogGroupList example: !include examples/activityloggroup/POST/ActivityLogGroupList.xml.example application/vnd.ibexa.api.ActivityLogGroupList+json: - type: ActivityLogGroupList + type: ActivityLogGroupListWrapper example: !include examples/activityloggroup/POST/ActivityLogGroupList.json.example 401: description: Error - the user is not authorized to list activities. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-bookmark.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-bookmark.raml index f7f040ed1e..4fd96924c5 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-bookmark.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-bookmark.raml @@ -24,7 +24,7 @@ get: type: BookmarkList example: !include examples/bookmark/GET/BookmarkList.xml.example application/vnd.ibexa.api.BookmarkList+json: - type: BookmarkList + type: BookmarkListWrapper example: !include examples/bookmark/GET/BookmarkList.json.example 401: description: Error - the user is not authorized to list bookmarks. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-calendar.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-calendar.raml index a3d5418c7b..c70b31b1a8 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-calendar.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-calendar.raml @@ -35,7 +35,7 @@ displayName: Calendar type: EventList example: !include examples/calendar/event/GET/EventList.xml.example application/vnd.ibexa.api.EventList+json: - type: EventList + type: EventListWrapper example: !include examples/calendar/event/GET/EventList.json.example /grouped-by-day: get: @@ -73,7 +73,7 @@ displayName: Calendar type: EventGroupList example: !include examples/calendar/event/grouped-by-day/GET/EventGroupList.xml.example application/vnd.ibexa.api.EventGroupList+json: - type: EventGroupList + type: EventGroupListWrapper example: !include examples/calendar/event/grouped-by-day/GET/EventGroupList.json.example /{eventType}: post: @@ -86,10 +86,10 @@ displayName: Calendar application/vnd.ibexa.api.calendar.future_hide.UnscheduleAction+json body: application/vnd.ibexa.api.calendar.future_publication.UnscheduleAction+json: - type: UnscheduleAction + type: UnscheduleActionWrapper example: !include examples/calendar/event/eventType/POST/future_publication.UnscheduleAction.json.example application/vnd.ibexa.api.calendar.future_hide.UnscheduleAction+json: - type: UnscheduleAction + type: UnscheduleActionWrapper responses: 204: description: No Content - the action has been unscheduled. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-cart.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-cart.raml index 0f13895314..97e733ad64 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-cart.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-cart.raml @@ -17,7 +17,7 @@ post: application/vnd.ibexa.api.CartCreate+xml: type: CartCreate application/vnd.ibexa.api.CartCreate+json: - type: CartCreate + type: CartCreateWrapper example: !include examples/cart/POST/CartCreate.json.example responses: 200: @@ -25,7 +25,7 @@ post: application/vnd.ibexa.api.Cart+xml: type: Cart application/vnd.ibexa.api.Cart+json: - type: Cart + type: CartWrapper example: !include examples/cart/POST/Cart.json.example 400: description: Error - The input does not match the input schema definition. @@ -48,7 +48,7 @@ post: application/vnd.ibexa.api.CartViewInput+xml: type: CartViewInput application/vnd.ibexa.api.CartViewInput+json: - type: CartViewInput + type: CartViewInputWrapper example: !include examples/cart/view/CartViewInput.json.example responses: 200: @@ -57,7 +57,7 @@ post: application/vnd.ibexa.api.CartView+xml: type: CartView application/vnd.ibexa.api.CartView+json: - type: CartView + type: CartViewWrapper /{identifier}: get: displayName: Get Cart @@ -75,7 +75,7 @@ post: application/vnd.ibexa.api.Cart+xml: type: Cart application/vnd.ibexa.api.Cart+json: - type: Cart + type: CartWrapper example: !include examples/cart/POST/Cart.json.example 401: description: Error - the user is not authorized to get this cart. @@ -97,7 +97,7 @@ post: application/vnd.ibexa.api.CartMetadataUpdate+xml: type: CartMetadataUpdate application/vnd.ibexa.api.CartMetadataUpdate+json: - type: CartMetadataUpdate + type: CartMetadataUpdateWrapper /entry: post: displayName: Add Entry to Cart @@ -112,7 +112,7 @@ post: application/vnd.ibexa.api.CartEntryAdd+xml: type: CartEntryAdd application/vnd.ibexa.api.CartEntryAdd+json: - type: CartEntryAdd + type: CartEntryAddWrapper example: !include examples/cart/entry/POST/CartEntryAdd.json.example /{entryId}: delete: @@ -131,7 +131,7 @@ post: application/vnd.ibexa.api.CartEntryUpdate+xml: type: CartEntryUpdate application/vnd.ibexa.api.CartEntryUpdate+json: - type: CartEntryUpdate + type: CartEntryUpdateWrapper /empty: post: displayName: Empty Cart @@ -159,7 +159,7 @@ post: application/vnd.ibexa.api.CartSummary+xml: type: CartSummary application/vnd.ibexa.api.CartSummary+json: - type: CartSummary + type: CartSummaryWrapper example: !include examples/cart/summary/CartSummary.json.example 401: description: Error - The user is not authorized to read this Cart. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-commerce.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-commerce.raml index 7229c834f8..6b87bb610e 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-commerce.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-commerce.raml @@ -13,7 +13,7 @@ displayName: eCommerce API (removed) 200: body: application/vnd.ibexa.api.BasketListResponse+json: - type: BasketListResponse + type: BasketListResponseWrapper example: !include examples/commerce/basket/headers/GET/BasketListResponse.json.example 400: body: @@ -33,7 +33,7 @@ displayName: eCommerce API (removed) 200: body: application/vnd.ibexa.api.Basket+json: - type: Basket + type: BasketWrapper example: !include examples/commerce/basket/Basket.json.example /{basketId}: @@ -46,12 +46,12 @@ displayName: eCommerce API (removed) 200: body: application/vnd.ibexa.api.Basket+json: - type: Basket + type: BasketWrapper example: !include examples/commerce/basket/Basket.json.example 400: body: application/vnd.ibexa.api.ValidationResponse+json: - type: ValidationResponse + type: ValidationResponseWrapper example: !include examples/commerce/basket/current/copyfrom/_basket_id_/POST/ValidationResponse.json.example /referencenumber: @@ -70,18 +70,18 @@ displayName: eCommerce API (removed) description: Updates party (buyer, delivery, invoice) information in the basket. Removed as of Ibexa DXP 4.4. body: application/vnd.ibexa.api.PartyInvoice+json: - type: PartyTypeInput + type: PartyTypeInputWrapper example: !include examples/commerce/basket/current/party/invoice/PATCH/PartyInvoice.json.example responses: 200: body: application/vnd.ibexa.api.Basket+json: - type: Basket + type: BasketWrapper example: !include examples/commerce/basket/Basket.json.example 400: body: application/vnd.ibexa.api.ValidationResponse+json: - type: ValidationResponse + type: ValidationResponseWrapper /shippingmethod: patch: @@ -95,12 +95,12 @@ displayName: eCommerce API (removed) 200: body: application/vnd.ibexa.api.Basket+json: - type: Basket + type: BasketWrapper example: !include examples/commerce/basket/Basket.json.example 400: body: application/vnd.ibexa.api.ValidationResponse+json: - type: ValidationResponse + type: ValidationResponseWrapper /paymentmethod: patch: @@ -108,18 +108,18 @@ displayName: eCommerce API (removed) description: Updates payment information in the current basket. Removed as of Ibexa DXP 4.4. body: application/vnd.ibexa.api.PaymentMethodData.json: - type: PaymentMethodData + type: PaymentMethodDataWrapper example: !include examples/commerce/basket/current/paymentmethod/PATCH/PaymentMethodData.json.example responses: 200: body: application/vnd.ibexa.api.Basket+json: - type: Basket + type: BasketWrapper example: !include examples/commerce/basket/Basket.json.example 400: body: application/vnd.ibexa.api.ValidationResponse+json: - type: ValidationResponse + type: ValidationResponseWrapper /voucher: patch: @@ -127,18 +127,18 @@ displayName: eCommerce API (removed) description: Updates and checks voucher in current basket. Removed as of Ibexa DXP 4.4. body: application/vnd.ibexa.api.VoucherData.json: - type: VoucherData + type: VoucherDataWrapper example: !include examples/commerce/basket/current/voucher/PATCH/VoucherData.json.example responses: 200: body: application/vnd.ibexa.api.Basket+json: - type: Basket + type: BasketWrapper example: !include examples/commerce/basket/Basket.json.example 400: body: application/vnd.ibexa.api.ValidationResponse+json: - type: ValidationResponse + type: ValidationResponseWrapper /line: post: @@ -146,18 +146,18 @@ displayName: eCommerce API (removed) description: Adds products to the current basket. Removed as of Ibexa DXP 4.4. body: application/vnd.ibexa.api.BasketLineData+json: - type: BasketLineData + type: BasketLineDataWrapper example: !include examples/commerce/basket/current/lines/POST/BasketLineData.json.example responses: 200: body: application/vnd.ibexa.api.Basket+json: - type: Basket + type: BasketWrapper example: !include examples/commerce/basket/Basket.json.example 400: body: application/vnd.ibexa.api.ValidationResponse+json: - type: ValidationResponse + type: ValidationResponseWrapper example: !include examples/commerce/basket/current/lines/POST/ValidationResponse.json.example /{basketId}: @@ -168,7 +168,7 @@ displayName: eCommerce API (removed) 200: body: application/vnd.ibexa.api.Basket+json: - type: Basket + type: BasketWrapper example: !include examples/commerce/basket/_id_/GET/Basket.json.example delete: displayName: Delete Basket by ID (removed) @@ -189,13 +189,13 @@ displayName: eCommerce API (removed) Removed as of Ibexa DXP 4.4, use PATCH /cart/{identifier} instead. body: application/vnd.ibexa.api.BasketHeaderData+json: - type: BasketHeaderData + type: BasketHeaderDataWrapper example: !include examples/commerce/basket/_id_/_mode_/POST/BasketHeaderData.json.example responses: 200: body: application/vnd.ibexa.api.Basket+json: - type: Basket + type: BasketWrapper example: !include examples/commerce/basket/Basket.json.example /note: @@ -206,13 +206,13 @@ displayName: eCommerce API (removed) Removed as of Ibexa DXP 4.4. body: application/vnd.ibexa.api.BasketHeaderData+json: - type: BasketHeaderData + type: BasketHeaderDataWrapper example: !include examples/commerce/basket/_id_/_mode_/POST/BasketHeaderData.json.example responses: 200: body: application/vnd.ibexa.api.Basket+json: - type: Basket + type: BasketWrapper example: !include examples/commerce/basket/Basket.json.example /line: @@ -221,18 +221,18 @@ displayName: eCommerce API (removed) description: Adds products to the stored basket. Removed as of Ibexa DXP 4.4, use POST /cart/{identifier}/entry instead. body: application/vnd.ibexa.api.BasketLineData+json: - type: BasketLineData + type: BasketLineDataWrapper example: !include examples/commerce/basket/current/lines/POST/BasketLineData.json.example responses: 200: body: application/vnd.ibexa.api.Basket+json: - type: Basket + type: BasketWrapper example: !include examples/commerce/basket/Basket.json.example 400: body: application/vnd.ibexa.api.ValidationResponse+json: - type: ValidationResponse + type: ValidationResponseWrapper example: !include examples/commerce/basket/current/lines/POST/ValidationResponse.json.example /line/{lineId}: @@ -243,12 +243,12 @@ displayName: eCommerce API (removed) 200: body: application/vnd.ibexa.api.Basket+json: - type: Basket + type: BasketWrapper example: !include examples/commerce/basket/Basket.json.example 400: body: application/vnd.ibexa.api.ValidationResponse+json: - type: ValidationResponse + type: ValidationResponseWrapper example: !include examples/commerce/basket/_id_/line/_line_id_/DELETE/ValidationResponse.json.example /{basketName}: @@ -259,12 +259,12 @@ displayName: eCommerce API (removed) 200: body: application/vnd.ibexa.api.Basket+json: - type: Basket + type: BasketWrapper example: !include examples/commerce/basket/Basket.json.example 400: body: application/vnd.ibexa.api.ValidationResponse+json: - type: ValidationResponse + type: ValidationResponseWrapper example: !include examples/commerce/basket/POST/ValidationResponse.json.example /checkout: @@ -276,7 +276,7 @@ displayName: eCommerce API (removed) 200: body: application/vnd.ibexa.api.PaymentMethodDataResponse+json: - type: PaymentMethodDataResponse + type: PaymentMethodDataResponseWrapper example: !include examples/commerce/checkout/payment-methods/GET/PaymentMethodDataResponse.json.example /shippingmethods: @@ -287,7 +287,7 @@ displayName: eCommerce API (removed) 200: body: application/vnd.ibexa.api.ShippingMethodDataResponse+json: - type: ShippingMethodDataResponse + type: ShippingMethodDataResponseWrapper example: !include examples/commerce/checkout/shipping-methods/GET/ShippingMethodDataResponse.json.example /customer/addresses/shipping: @@ -298,7 +298,7 @@ displayName: eCommerce API (removed) 200: body: application/json: - type: ShippingAddressesResponse + type: ShippingAddressesResponseWrapper example: !include examples/commerce/customer/addresses/shipping/GET/ShippingAddressesResponse.json.example /customerprice: @@ -307,13 +307,13 @@ displayName: eCommerce API (removed) description: Gets customer prices for the requested products. Removed as of Ibexa DXP 4.4. body: application/json: - type: CustomerPriceData + type: CustomerPriceDataWrapper example: !include examples/commerce/customerprice/POST/CustomerPriceData.json.example responses: 200: body: application/json: - type: PriceResponse + type: PriceResponseWrapper example: !include examples/commerce/customerprice/POST/PriceResponse.json.example @@ -330,5 +330,5 @@ displayName: eCommerce API (removed) 200: body: application/json: - type: CountrySelectionResponse + type: CountrySelectionResponseWrapper example: !include examples/commerce/country-selection/GET/CountrySelectionResponse.json.example diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-content-locations.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-content-locations.raml index 175f2f5601..6a4cc6a72c 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-content-locations.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-content-locations.raml @@ -22,7 +22,7 @@ get: type: Location example: !include examples/content/locations/GET/LocationList.xml.example application/vnd.ibexa.api.LocationList+json: - type: Location + type: LocationWrapper example: !include examples/content/locations/GET/LocationList.json.example 404: description: Error - the Location with the given ID (remote ID or URL Alias) does not exist. @@ -45,7 +45,7 @@ get: type: Location example: !include examples/content/locations/path/GET/Location.xml.example application/vnd.ibexa.api.Location+json: - type: Location + type: LocationWrapper example: !include examples/content/locations/path/GET/Location.json.example 401: description: Error - the user is not authorized to read this Location. @@ -107,10 +107,10 @@ get: description: ETag body: application/vnd.ibexa.api.LocationUpdate+xml: - type: LocationUpdateStruct + type: LocationUpdate example: !include examples/content/locations/location_id/PATCH/LocationUpdate.xml.example application/vnd.ibexa.api.LocationUpdate+json: - type: LocationUpdateStruct + type: LocationUpdateWrapper example: !include examples/content/locations/location_id/PATCH/LocationUpdate.json.example responses: 200: @@ -119,7 +119,7 @@ get: type: Location example: !include examples/content/locations/location_id/PATCH/Location.xml.example application/vnd.ibexa.api.Location+json: - type: Location + type: LocationWrapper example: !include examples/content/locations/location_id/PATCH/Location.json.example 401: description: Error - the user is not authorized to update this Location. @@ -189,7 +189,7 @@ get: type: UrlAliasRefList example: !include examples/content/locations/path/urlaliases/GET/UrlAliasRefList.xml.example application/vnd.ibexa.api.UrlAliasRefList+json: - type: UrlAliasRefList + type: UrlAliasRefListWrapper 400: description: Error - The user has no permission to read URL aliases. 401: diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-content-objects.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-content-objects.raml index a348f5a213..763ab99a5d 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-content-objects.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-content-objects.raml @@ -19,7 +19,7 @@ post: type: ContentCreate example: !include examples/content/objects/POST/ContentCreate.xml.example application/vnd.ibexa.api.ContentCreate+json: - type: ContentCreate + type: ContentCreateWrapper example: !include examples/content/objects/POST/ContentCreate.json.example responses: 201: @@ -28,10 +28,10 @@ post: type: Content example: !include examples/content/objects/POST/Content.xml.example application/vnd.ibexa.api.Content+json: - type: Content + type: ContentWrapper example: !include examples/content/objects/POST/Content.json.example application/vnd.ibexa.api.ContentInfo+xml: - type: ContentInfo + type: ContentInfoWrapper example: !include examples/content/objects/POST/ContentInfo.xml.example 400: description: Error - the input does not match the input schema definition or the validation on a field fails. @@ -76,13 +76,13 @@ get: type: Content example: !include examples/content/objects/content_id/GET/Content.xml.example application/vnd.ibexa.api.Content+json: - type: Content + type: ContentWrapper example: !include examples/content/objects/content_id/GET/Content.json.example application/vnd.ibexa.api.ContentInfo+xml: type: ContentInfo example: !include examples/content/objects/content_id/GET/ContentInfo.xml.example application/vnd.ibexa.api.ContentInfo+json: - type: ContentInfo + type: ContentInfoWrapper 401: description: Error - the user is not authorized to read this object. This could also happen if there is no published version yet and another user owns a draft of this content item. 404: @@ -109,7 +109,7 @@ get: type: ContentInfo example: !include examples/content/objects/content_id/PATCH/ContentUpdate.xml.example application/vnd.ibexa.api.ContentUpdate+json: - type: ContentInfo + type: ContentInfoWrapper responses: 200: body: @@ -117,7 +117,7 @@ get: type: ContentInfo example: !include examples/content/objects/content_id/PATCH/ContentInfo.xml.example application/vnd.ibexa.api.ContentInfo+json: - type: ContentInfo + type: ContentInfoWrapper 400: description: Error - the input does not match the input schema definition. 401: @@ -177,7 +177,7 @@ get: type: Version example: !include examples/content/objects/content_id/currentversion/GET/Version.xml.example application/vnd.ibexa.api.Version+json: - type: Version + type: VersionWrapper example: !include examples/content/objects/content_id/currentversion/GET/Version.json.example 307: description: Temporary redirect. @@ -200,7 +200,7 @@ get: type: Version example: !include examples/content/objects/content_id/currentversion/COPY/Version.xml.example application/vnd.ibexa.api.Version+json: - type: Version + type: VersionWrapper example: !include examples/content/objects/content_id/currentversion/COPY/Version.json.example 401: description: Error - the user is not authorized to update this content item. @@ -225,7 +225,7 @@ get: type: VersionList example: !include examples/content/objects/content_id/versions/GET/VersionList.xml.example application/vnd.ibexa.api.VersionList+json: - type: VersionList + type: VersionListWrapper example: !include examples/content/objects/content_id/versions/GET/VersionList.json.example 401: description: Error - the user has no permission to read the versions. @@ -259,7 +259,7 @@ get: type: Version example: !include examples/content/objects/content_id/versions/version_no/GET/Version.xml.example application/vnd.ibexa.api.Version+json: - type: Version + type: VersionWrapper example: !include examples/content/objects/content_id/versions/version_no/GET/Version.json.example 304: description: Error - the ETag does not match the current one. @@ -292,7 +292,7 @@ get: type: VersionUpdate example: !include examples/content/objects/content_id/versions/version_no/PATCH/VersionUpdate.xml.example application/vnd.ibexa.api.VersionUpdate+json: - type: VersionUpdate + type: VersionUpdateWrapper responses: 200: body: @@ -300,7 +300,7 @@ get: type: Version example: !include examples/content/objects/content_id/versions/version_no/PATCH/Version.xml.example application/vnd.ibexa.api.Version+json: - type: Version + type: VersionWrapper 400: description: Error - the input does not match the input schema definition. 401: @@ -328,7 +328,7 @@ get: type: Version example: !include examples/content/objects/content_id/versions/version_no/COPY/Version.xml.example application/vnd.ibexa.api.Version+json: - type: Version + type: VersionWrapper example: !include examples/content/objects/content_id/versions/version_no/COPY/Version.json.example 401: description: Error - the user is not authorized to update this content item. @@ -399,7 +399,7 @@ get: type: RelationList example: !include examples/content/objects/content_id/versions/version_no/relations/GET/RelationList.xml.example application/vnd.ibexa.api.RelationList+json: - type: RelationList + type: RelationListWrapper example: !include examples/content/objects/content_id/versions/version_no/relations/GET/RelationList.json.example 401: description: Error - the user is not authorized to read this content item. @@ -421,10 +421,10 @@ get: application/vnd.ibexa.api.RelationCreate+json body: application/vnd.ibexa.api.RelationCreate+xml: - type: Relation + type: RelationCreate example: !include examples/content/objects/content_id/versions/version_no/relations/POST/RelationCreate.xml.example application/vnd.ibexa.api.RelationCreate+json: - type: Relation + type: RelationCreateWrapper example: !include examples/content/objects/content_id/versions/version_no/relations/POST/RelationCreate.json.example responses: 201: @@ -433,9 +433,8 @@ get: type: Relation example: !include examples/content/objects/content_id/versions/version_no/relations/POST/Relation.xml.example application/vnd.ibexa.api.Relation+json: - type: Relation + type: RelationWrapper example: !include examples/content/objects/content_id/versions/version_no/relations/POST/Relation.json.example - /{relationId}: get: displayName: Load Relation @@ -454,8 +453,7 @@ get: type: Relation example: !include examples/content/objects/content_id/versions/version_no/relations/relation_id/GET/Relation.xml.example application/vnd.ibexa.api.Relation+json: - type: Relation - example: examples/content/objects/content_id/versions/version_no/relations/relation_id/GET/Relation.json.example + type: RelationWrapper 401: description: Error - the user is not authorized to read this content item. 404: @@ -503,7 +501,7 @@ get: type: LocationCreate example: !include examples/content/objects/content_id/locations/POST/LocationCreate.xml.example application/vnd.ibexa.api.LocationCreate+json: - type: LocationCreate + type: LocationCreateWrapper example: !include examples/content/objects/content_id/locations/POST/LocationCreate.json.example responses: 201: @@ -512,7 +510,7 @@ get: type: Location example: !include examples/content/objects/content_id/locations/POST/Location.xml.example application/vnd.ibexa.api.Location+json: - type: Location + type: LocationWrapper example: !include examples/content/objects/content_id/locations/POST/Location.json.example 400: description: Error - the input does not match the input schema definition. @@ -538,7 +536,7 @@ get: type: LocationList example: !include examples/content/objects/content_id/locations/GET/LocationList.xml.example application/vnd.ibexa.api.LocationList+json: - type: LocationList + type: LocationListWrapper example: !include examples/content/objects/content_id/locations/GET/LocationList.json.example 401: description: Error - the user is not authorized to read this content item. @@ -564,7 +562,7 @@ get: type: ContentObjectStates example: !include examples/content/objects/content_id/objectstates/GET/ContentObjectStates.xml.example application/vnd.ibexa.api.ContentObjectStates+json: - type: ContentObjectStates + type: ContentObjectStatesWrapper example: !include examples/content/objects/content_id/objectstates/GET/ContentObjectStates.json.example 404: description: Error - The content item does not exist. @@ -589,7 +587,7 @@ get: type: ContentObjectStates example: !include examples/content/objects/content_id/objectstates/PATCH/ContentObjectStates.request.xml.example application/vnd.ibexa.api.ContentObjectStates+json: - type: ContentObjectStates + type: ContentObjectStatesWrapper example: !include examples/content/objects/content_id/objectstates/PATCH/ContentObjectStates.request.json.example responses: 204: @@ -599,7 +597,7 @@ get: type: ContentObjectStates example: !include examples/content/objects/content_id/objectstates/PATCH/ContentObjectStates.response.xml.example application/vnd.ibexa.api.ContentObjectStates+json: - type: ContentObjectStates + type: ContentObjectStatesWrapper example: !include examples/content/objects/content_id/objectstates/PATCH/ContentObjectStates.response.json.example 400: description: Error - The input does not match the input schema definition. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-content-sections.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-content-sections.raml index 6c9dd8cddf..53645c4fde 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-content-sections.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-content-sections.raml @@ -17,7 +17,7 @@ post: type: SectionInput example: !include examples/content/sections/POST/SectionInput.xml.example application/vnd.ibexa.api.SectionInput+json: - type: SectionInput + type: SectionInputWrapper example: !include examples/content/sections/POST/SectionInput.json.example responses: 201: @@ -26,7 +26,7 @@ post: type: Section example: !include examples/content/sections/POST/Section.xml.example application/vnd.ibexa.api.Section+json: - type: Section + type: SectionWrapper example: !include examples/content/sections/POST/Section.json.example get: displayName: Get Sections @@ -49,7 +49,7 @@ get: type: SectionList example: !include examples/content/sections/GET/SectionList.xml.example application/vnd.ibexa.api.SectionList+json: - type: SectionList + type: SectionListWrapper example: !include examples/content/sections/GET/SectionList.json.example 401: description: Error - The user has no permission to read the Section. @@ -72,7 +72,7 @@ get: type: Section example: !include examples/content/sections/section_id/GET/Section.xml.example application/vnd.ibexa.api.Section+json: - type: Section + type: SectionWrapper example: !include examples/content/sections/section_id/GET/Section.json.example 401: description: Error - The user is not authorized to read this Section. @@ -99,7 +99,7 @@ get: type: SectionInput example: !include examples/content/sections/section_id/PATCH/SectionInput.xml.example application/vnd.ibexa.api.SectionInput+json: - type: SectionInput + type: SectionInputWrapper example: !include examples/content/sections/section_id/PATCH/SectionInput.json.example responses: 200: @@ -109,7 +109,7 @@ get: type: Section example: !include examples/content/sections/section_id/PATCH/Section.xml.example application/vnd.ibexa.api.Section+json: - type: Section + type: SectionWrapper example: !include examples/content/sections/section_id/PATCH/Section.json.example 400: description: Error - the input does not match the input schema definition. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-content-trash.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-content-trash.raml index 74bc0c3ddb..01c3568230 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-content-trash.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-content-trash.raml @@ -20,7 +20,7 @@ get: type: Trash example: !include examples/content/trash/GET/Trash.xml.example application/vnd.ibexa.api.Trash+json: - type: Trash + type: TrashWrapper example: !include examples/content/trash/GET/Trash.json.example 401: description: Error - The user has no permission to read the Trash. @@ -49,7 +49,7 @@ delete: type: TrashItem example: !include examples/content/trash/trash_itemid/GET/TrashItem.xml.example application/vnd.ibexa.api.TrashItem+json: - type: TrashItem + type: TrashItemWrapper example: !include examples/content/trash/trash_itemid/GET/TrashItem.json.example 401: description: Error - The user has no permission to read the item in Trash. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-content-typegroups.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-content-typegroups.raml index 432d22ea4f..ccb92a5929 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-content-typegroups.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-content-typegroups.raml @@ -20,7 +20,7 @@ get: type: ContentTypeGroupList example: !include examples/content/typegroups/GET/ContentTypeGroupList.xml.example application/vnd.ibexa.api.ContentTypeGroupList+json: - type: ContentTypeGroupList + type: ContentTypeGroupListWrapper example: !include examples/content/typegroups/GET/ContentTypeGroupList.json.example 307: description: Temporary redirect. @@ -47,7 +47,7 @@ post: type: ContentTypeGroupInput example: !include examples/content/typegroups/POST/ContentTypeGroupInput.xml.example application/vnd.ibexa.api.ContentTypeGroupInput+json: - type: ContentTypeGroupInput + type: ContentTypeGroupInputWrapper example: !include examples/content/typegroups/POST/ContentTypeGroupInput.json.example responses: 201: @@ -57,7 +57,7 @@ post: type: ContentTypeGroup example: !include examples/content/typegroups/POST/ContentTypeGroup.xml.example application/vnd.ibexa.api.ContentTypeGroup+json: - type: ContentTypeGroup + type: ContentTypeGroupWrapper example: !include examples/content/typegroups/POST/ContentTypeGroup.json.example 400: description: Error - The input does not match the input schema definition. @@ -82,10 +82,10 @@ post: description: OK - returns the content type group. body: application/vnd.ibexa.api.ContentTypeGroup+xml: - type: ContentTypeGroup + type: ContentTypeList example: !include examples/content/typegroups/content_type_group_id/GET/ContentTypeGroup.xml.example application/vnd.ibexa.api.ContentTypeGroup+json: - type: ContentTypeGroup + type: ContentTypeListWrapper example: !include examples/content/typegroups/content_type_group_id/GET/ContentTypeGroup.json.example 401: description: Error - The user is not authorized to read this content type group. @@ -112,7 +112,7 @@ post: type: ContentTypeGroupInput example: !include examples/content/typegroups/content_type_group_id/PATCH/ContentTypeGroupInput.xml.example application/vnd.ibexa.api.ContentTypeGroupInput+json: - type: ContentTypeGroupInput + type: ContentTypeGroupInputWrapper example: !include examples/content/typegroups/content_type_group_id/PATCH/ContentTypeGroupInput.json.example responses: 200: @@ -122,7 +122,7 @@ post: type: ContentTypeGroup example: !include examples/content/typegroups/content_type_group_id/PATCH/ContentTypeGroup.xml.example application/vnd.ibexa.api.ContentTypeGroup+json: - type: ContentTypeGroup + type: ContentTypeGroupWrapper example: !include examples/content/typegroups/content_type_group_id/PATCH/ContentTypeGroup.json.example 400: description: Error - The input does not match the input schema definition. @@ -164,12 +164,12 @@ post: type: ContentTypeInfoList example: !include examples/content/typegroups/content_type_group_id/types/GET/ContentTypeInfoList.xml.example application/vnd.ibexa.api.ContentTypeInfoList+json: - type: ContentTypeInfoList + type: ContentTypeInfoListWrapper example: !include examples/content/typegroups/content_type_group_id/types/GET/ContentTypeInfoList.json.example application/vnd.ibexa.api.ContentTypeList+xml: type: ContentTypeList application/vnd.ibexa.api.ContentTypeList+json: - type: ContentTypeList + type: ContentTypeListWrapper 401: description: Error - The user has no permission to read the content types. post: @@ -195,7 +195,7 @@ post: type: ContentTypeCreate example: !include examples/content/typegroups/content_type_group_id/types/POST/ContentTypeCreate.xml.example application/vnd.ibexa.api.ContentTypeCreate+json: - type: ContentTypeCreate + type: ContentTypeCreateWrapper example: !include examples/content/typegroups/content_type_group_id/types/POST/ContentTypeCreate.json.example responses: 201: @@ -205,7 +205,7 @@ post: type: ContentType example: !include examples/content/typegroups/content_type_group_id/types/POST/ContentType.xml.example application/vnd.ibexa.api.ContentType+json: - type: ContentType + type: ContentTypeWrapper 400: description: Error - The input does not match the input schema definition. Validation on a Field definition fails. Validation of the content type fails, e.g. multiple Fields of a same singular Field Type are provided. Publish is set to true and the input is not complete e.g. no Field definitions are provided. 401: diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-content-types.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-content-types.raml index 9185ea9d45..a135909845 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-content-types.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-content-types.raml @@ -30,12 +30,12 @@ get: type: ContentTypeInfoList example: !include examples/content/types/GET/ContentTypeInfoList.xml.example application/vnd.ibexa.api.ContentTypeInfoList+json: - type: ContentTypeInfoList + type: ContentTypeInfoListWrapper example: !include examples/content/types/GET/ContentTypeInfoList.json.example application/vnd.ibexa.api.ContentTypeList+xml: type: ContentTypeList application/vnd.ibexa.api.ContentTypeList+json: - type: ContentTypeList + type: ContentTypeListWrapper description: OK - returns a list of content types. 401: description: Error - The user has no permission to read the content types. @@ -58,7 +58,7 @@ get: type: ContentType example: !include examples/content/types/content_type_id/GET/ContentType.xml.example application/vnd.ibexa.api.ContentType+json: - type: ContentType + type: ContentTypeWrapper example: !include examples/content/types/content_type_id/GET/ContentType.json.example description: OK - returns the content type. 401: @@ -92,7 +92,7 @@ get: type: ContentTypeUpdate example: !include examples/content/types/content_type_id/POST/ContentTypeUpdate.xml.example application/vnd.ibexa.api.ContentTypeUpdate+json: - type: ContentTypeUpdate + type: ContentTypeUpdateWrapper example: !include examples/content/types/content_type_id/POST/ContentTypeUpdate.json.example responses: 201: @@ -102,7 +102,7 @@ get: type: ContentTypeInfo example: !include examples/content/types/content_type_id/POST/ContentTypeInfo.xml.example application/vnd.ibexa.api.ContentTypeInfo+json: - type: ContentTypeInfo + type: ContentTypeInfoWrapper example: !include examples/content/types/content_type_id/POST/ContentTypeInfo.json.example 400: description: Error - The input does not match the input schema definition. @@ -139,7 +139,7 @@ get: application/vnd.ibexa.api.FieldDefinitionList+xml: type: FieldDefinitions application/vnd.ibexa.api.FieldDefinitionList+json: - type: FieldDefinitions + type: FieldDefinitionsWrapper 404: description: Error - The content type does not exist. /{fieldDefinitionId}: @@ -160,7 +160,7 @@ get: type: FieldDefinition example: !include examples/content/types/content_type_id/field_definition_id/GET/FieldDefinition.xml.example application/vnd.ibexa.api.FieldDefinition+json: - type: FieldDefinition + type: FieldDefinitionWrapper example: !include examples/content/types/content_type_id/field_definition_id/GET/FieldDefinition.json.example 401: description: Error - The user is not authorized to read the content type. @@ -182,7 +182,7 @@ get: application/vnd.ibexa.api.ContentType+xml: type: ContentType application/vnd.ibexa.api.ContentType+json: - type: ContentType + type: ContentTypeWrapper description: OK - returns the content type. 401: description: Error - The user is not authorized to read this content type. @@ -207,7 +207,7 @@ get: type: ContentTypeUpdate example: !include examples/content/types/content_type_id/draft/PATCH/ContentTypeUpdate.xml.example application/vnd.ibexa.api.ContentTypeUpdate+json: - type: ContentTypeUpdate + type: ContentTypeUpdateWrapper example: !include examples/content/types/content_type_id/draft/PATCH/ContentTypeUpdate.json.example responses: 200: @@ -217,7 +217,7 @@ get: type: ContentTypeInfo example: !include examples/content/types/content_type_id/draft/PATCH/ContentTypeInfo.xml.example application/vnd.ibexa.api.ContentTypeInfo+json: - type: ContentTypeInfo + type: ContentTypeInfoWrapper example: !include examples/content/types/content_type_id/draft/PATCH/ContentTypeInfo.json.example 400: @@ -271,7 +271,7 @@ get: application/vnd.ibexa.api.FieldDefinitionList+xml: type: FieldDefinitions application/vnd.ibexa.api.FieldDefinitionList+json: - type: FieldDefinitions + type: FieldDefinitionsWrapper 404: description: Error - The content type draft does not exist. post: @@ -293,7 +293,7 @@ get: type: FieldDefinitionCreate example: !include examples/content/types/content_type_id/draft/field_definitions/POST/FieldDefinitionCreate.xml.example application/vnd.ibexa.api.FieldDefinitionCreate+json: - type: FieldDefinitionCreate + type: FieldDefinitionCreateWrapper responses: 201: description: Field definition created. @@ -302,7 +302,7 @@ get: type: FieldDefinition example: !include examples/content/types/content_type_id/draft/field_definitions/POST/FieldDefinition.xml.example application/vnd.ibexa.api.FieldDefinition+json: - type: FieldDefinition + type: FieldDefinitionWrapper 400: description: Error - The input does not match the input schema definition or validation on the Field definition fails. 401: @@ -327,7 +327,7 @@ get: type: FieldDefinition example: !include examples/content/types/content_type_id/draft/field_definitions/field_definition_id/GET/FieldDefinition.xml.example application/vnd.ibexa.api.FieldDefinition+json: - type: FieldDefinition + type: FieldDefinitionWrapper example: !include examples/content/types/content_type_id/draft/field_definitions/field_definition_id/GET/FieldDefinition.json.example 401: description: Error - The user is not authorized to read the content type draft. @@ -352,7 +352,7 @@ get: type: FieldDefinitionUpdate example: !include examples/content/types/content_type_id/draft/field_definitions/field_definition_id/PATCH/FieldDefinitionUpdate.xml.example application/vnd.ibexa.api.FieldDefinitionUpdate+json: - type: FieldDefinitionUpdate + type: FieldDefinitionUpdateWrapper responses: 200: description: OK - attributes updated. @@ -361,7 +361,7 @@ get: type: FieldDefinition example: !include examples/content/types/content_type_id/draft/field_definitions/field_definition_id/PATCH/FieldDefinition.xml.example application/vnd.ibexa.api.FieldDefinition+json: - type: FieldDefinition + type: FieldDefinitionWrapper 400: description: Error - The input does not match the input schema definition. 401: @@ -395,7 +395,7 @@ get: type: ContentTypeGroupRefList example: !include examples/content/types/content_type_id/groups/GET/ContentTypeGroupRefList.xml.example application/vnd.ibexa.api.ContentTypeGroupRefList+json: - type: ContentTypeGroupRefList + type: ContentTypeGroupRefListWrapper example: !include examples/content/types/content_type_id/groups/GET/ContentTypeGroupRefList.json.example 401: description: Error - The user is not authorized to read this content type. @@ -421,8 +421,7 @@ get: type: ContentTypeGroupRefList example: !include examples/content/types/content_type_id/groups/POST/ContentTypeGroupRefList.xml.example application/vnd.ibexa.api.ContentTypeGroupRefList+json: - type: ContentTypeGroupRefList - example: !include examples/content/types/content_type_id/groups/POST/ContentTypeGroupRefList.json.example + type: ContentTypeGroupRefListWrapper 400: description: Error - The input does not match the input schema definition. 401: @@ -443,10 +442,10 @@ get: 200: body: application/vnd.ibexa.api.ContentTypeGroupRefList+xml: - type: ContentTypeGroup + type: ContentTypeGroupRefList example: !include examples/content/types/content_type_id/groups/id/DELETE/ContentTypeGroupRefList.xml.example application/vnd.ibexa.api.ContentTypeGroupRefList+json: - type: ContentTypeGroup + type: ContentTypeGroupRefListWrapper example: !include examples/content/types/content_type_id/groups/id/DELETE/ContentTypeGroupRefList.json.example 401: description: Error - The user is not authorized to delete this content type. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-content-urlaliases.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-content-urlaliases.raml index 5486c704b8..cd7148ebe7 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-content-urlaliases.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-content-urlaliases.raml @@ -15,7 +15,7 @@ get: type: UrlAliasRefList example: !include examples/content/urlaliases/GET/UrlAliasRefList.xml.example application/vnd.ibexa.api.UrlAliasRefList+json: - type: UrlAliasRefList + type: UrlAliasRefListWrapper example: !include examples/content/urlaliases/GET/UrlAliasRefList.json.example 401: description: Error - The user has no permission to read URL aliases. @@ -38,7 +38,7 @@ post: type: UrlAliasCreate example: !include examples/content/urlaliases/POST/UrlAliasCreate.xml.example application/vnd.ibexa.api.UrlAliasCreate+json: - type: UrlAliasCreate + type: UrlAliasCreateWrapper example: !include examples/content/urlaliases/POST/UrlAliasCreate.json.example responses: 201: @@ -48,7 +48,7 @@ post: type: UrlAlias example: !include examples/content/urlaliases/POST/UrlAlias.xml.example application/vnd.ibexa.api.UrlAlias+json: - type: UrlAlias + type: UrlAliasWrapper example: !include examples/content/urlaliases/POST/UrlAlias.json.example 400: description: Error - The input does not match the input schema definition. @@ -74,7 +74,7 @@ post: type: UrlAlias example: !include examples/content/urlaliases/url_alias_id/GET/UrlAlias.xml.example application/vnd.ibexa.api.UrlAlias+json: - type: UrlAlias + type: UrlAliasWrapper example: !include examples/content/urlaliases/url_alias_id/GET/UrlAlias.json.example 401: description: Error - The user is not authorized to read URL aliases. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-content-urlwildcards.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-content-urlwildcards.raml index b91cbc99c1..e3d04ef08f 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-content-urlwildcards.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-content-urlwildcards.raml @@ -15,7 +15,7 @@ get: type: UrlWildcardList example: !include examples/content/urlwildcards/GET/UrlWildcardList.xml.example application/vnd.ibexa.api.UrlWildcardList+json: - type: UrlWildcardList + type: UrlWildcardListWrapper example: !include examples/content/urlwildcards/GET/UrlWildcardList.json.example 401: description: Error - The user has no permission to read URL wildcards. @@ -38,7 +38,7 @@ post: type: UrlWildcardCreate example: !include examples/content/urlwildcards/POST/UrlWildcardCreate.xml.example application/vnd.ibexa.api.UrlWildcardCreate+json: - type: UrlWildcardCreate + type: UrlWildcardCreateWrapper example: !include examples/content/urlwildcards/POST/UrlWildcardCreate.json.example responses: 201: @@ -48,7 +48,7 @@ post: type: UrlWildcard example: !include examples/content/urlwildcards/POST/UrlWildcard.xml.example application/vnd.ibexa.api.UrlWildcard+json: - type: UrlWildcard + type: UrlWildcardWrapper example: !include examples/content/urlwildcards/POST/UrlWildcard.json.example 400: description: Error - The input does not match the input schema definition. @@ -74,7 +74,7 @@ post: type: UrlWildcard example: !include examples/content/urlwildcards/wildcard_id/GET/UrlWildcard.xml.example application/vnd.ibexa.api.UrlWildcard+json: - type: UrlWildcard + type: UrlWildcardWrapper example: !include examples/content/urlwildcards/wildcard_id/GET/UrlWildcard.json.example 401: description: Error - The user is not authorized to read URL wildcards. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-corporate.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-corporate.raml index 29f0645651..571472c53e 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-corporate.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-corporate.raml @@ -17,7 +17,7 @@ get: type: CorporateAccountRoot example: !include examples/corporate/GET/CorporateAccountRoot.xml.example application/vnd.ibexa.api.CorporateAccountRoot+json: - type: CorporateAccountRoot + type: CorporateAccountRootWrapper example: !include examples/corporate/GET/CorporateAccountRoot.json.example /companies: @@ -68,7 +68,7 @@ get: type: CompanyList example: !include examples/corporate/companies/GET/CompanyList.xml.example application/vnd.ibexa.api.CompanyList+json: - type: CompanyList + type: CompanyListWrapper example: !include examples/corporate/companies/GET/CompanyList.json.example 400: description: Returned when invalid Criterion or Sort clause is used @@ -94,7 +94,7 @@ get: type: CompanyCreate example: !include examples/corporate/companies/POST/CompanyCreate.xml.example application/vnd.ibexa.api.CompanyCreate+json: - type: CompanyCreate + type: CompanyCreateWrapper example: !include examples/corporate/companies/POST/CompanyCreate.json.example responses: 201: @@ -103,7 +103,7 @@ get: type: Company example: !include examples/corporate/companies/company_id/GET/Company.xml.example application/vnd.ibexa.api.Company+json: - type: Company + type: CompanyWrapper example: !include examples/corporate/companies/company_id/GET/Company.json.example 400: description: Error - the input does not match the input schema definition. @@ -125,7 +125,7 @@ get: 200: body: application/vnd.ibexa.api.Company+json: - type: Company + type: CompanyWrapper example: !include examples/corporate/companies/company_id/GET/Company.json.example application/vnd.ibexa.api.Company+xml: type: Company @@ -173,7 +173,7 @@ get: type: CompanyUpdate example: !include examples/corporate/companies/company_id/PATCH/CompanyUpdate.xml.example application/vnd.ibexa.api.CompanyUpdate+json: - type: CompanyUpdate + type: CompanyUpdateWrapper example: !include examples/corporate/companies/company_id/PATCH/CompanyUpdate.json.example responses: 200: @@ -183,7 +183,7 @@ get: type: Company example: !include examples/corporate/companies/company_id/GET/Company.xml.example application/vnd.ibexa.api.Company+json: - type: Company + type: CompanyWrapper example: !include examples/corporate/companies/company_id/GET/Company.json.example 400: description: Error - the input does not match the input schema definition. @@ -232,7 +232,7 @@ get: type: MemberList example: !include examples/corporate/companies/company_id/members/GET/MemberList.xml.example application/vnd.ibexa.api.MemberList+json: - type: MemberList + type: MemberListWrapper example: !include examples/corporate/companies/company_id/members/GET/MemberList.json.example 400: body: @@ -258,7 +258,7 @@ get: type: MemberCreate example: !include examples/corporate/companies/company_id/members/POST/MemberCreate.xml.example application/vnd.ibexa.api.MemberCreate+json: - type: MemberCreate + type: MemberCreateWrapper example: !include examples/corporate/companies/company_id/members/POST/MemberCreate.json.example responses: 201: @@ -267,7 +267,7 @@ get: type: Member example: !include examples/corporate/companies/company_id/members/member_id/GET/Member.xml.example application/vnd.ibexa.api.Member+json: - type: Member + type: MemberWrapper example: !include examples/corporate/companies/company_id/members/member_id/GET/Member.json.example 400: description: Error - the input does not match the input schema definition. @@ -290,7 +290,7 @@ get: type: Member example: !include examples/corporate/companies/company_id/members/member_id/GET/Member.xml.example application/vnd.ibexa.api.Member+json: - type: Member + type: MemberWrapper example: !include examples/corporate/companies/company_id/members/member_id/GET/Member.json.example 401: description: Error - The user is not authorized to read this company. @@ -335,7 +335,7 @@ get: type: MemberUpdate example: !include examples/corporate/companies/company_id/members/member_id/PATCH/MemberUpdate.xml.example application/vnd.ibexa.api.MemberUpdate+json: - type: MemberUpdate + type: MemberUpdateWrapper example: !include examples/corporate/companies/company_id/members/member_id/PATCH/MemberUpdate.json.example responses: 200: @@ -345,7 +345,7 @@ get: type: Member example: !include examples/corporate/companies/company_id/members/member_id/GET/Member.xml.example application/vnd.ibexa.api.Member+json: - type: Member + type: MemberWrapper example: !include examples/corporate/companies/company_id/members/member_id/GET/Member.json.example 400: description: Error - the input does not match the input schema definition. @@ -380,7 +380,7 @@ get: type: SalesRepresentativesList example: !include examples/corporate/sales-representatives/GET/SalesRepresentativesList.xml.example application/vnd.ibexa.api.SalesRepresentativesList+json: - type: SalesRepresentativesList + type: SalesRepresentativesListWrapper example: !include examples/corporate/sales-representatives/GET/SalesRepresentativesList.json.example 401: description: Error - the user is not authorized to read Sales Representatives List. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-languages.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-languages.raml index 4461acaefb..bd16171fc2 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-languages.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-languages.raml @@ -15,7 +15,7 @@ get: type: LanguageList example: !include examples/languages/GET/LanguageList.xml.example application/vnd.ibexa.api.LanguageList+json: - type: LanguageList + type: LanguageListWrapper example: !include examples/languages/GET/LanguageList.json.example /{code}: @@ -34,5 +34,5 @@ get: type: Language example: !include examples/languages/code/GET/Language.xml.example application/vnd.ibexa.api.Language+json: - type: Language + type: LanguageWrapper example: !include examples/languages/code/GET/Language.json.example diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-objectstategroups.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-objectstategroups.raml index b54bf1e2a7..5a32bb32ed 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-objectstategroups.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-objectstategroups.raml @@ -18,7 +18,7 @@ get: type: ObjectStateGroupList example: !include examples/content/objectstategroups/GET/ObjectStateGroupList.xml.example application/vnd.ibexa.api.ObjectStateGroupList+json: - type: ObjectStateGroupList + type: ObjectStateGroupListWrapper example: !include examples/content/objectstategroups/GET/ObjectStateGroupList.json.example 401: description: Error - The user has no permission to read Object state groups. @@ -41,7 +41,7 @@ post: type: ObjectStateGroupCreate example: !include examples/content/objectstategroups/POST/ObjectStateGroupCreate.xml.example application/vnd.ibexa.api.ObjectStateGroupCreate+json: - type: ObjectStateGroupCreate + type: ObjectStateGroupCreateWrapper example: !include examples/content/objectstategroups/POST/ObjectStateGroupCreate.json.example responses: 201: @@ -51,7 +51,7 @@ post: type: ObjectStateGroup example: !include examples/content/objectstategroups/POST/ObjectStateGroup.xml.example application/vnd.ibexa.api.ObjectStateGroup+json: - type: ObjectStateGroup + type: ObjectStateGroupWrapper example: !include examples/content/objectstategroups/POST/ObjectStateGroup.json.example 400: description: Error - The input does not match the input schema definition. @@ -79,7 +79,7 @@ post: type: ObjectStateGroup example: !include examples/content/objectstategroups/object_state_group_id/GET/ObjectStateGroup.xml.example application/vnd.ibexa.api.ObjectStateGroup+json: - type: ObjectStateGroup + type: ObjectStateGroupWrapper example: !include examples/content/objectstategroups/object_state_group_id/GET/ObjectStateGroup.json.example 401: description: Error - The user is not authorized to read this Object state group. @@ -106,7 +106,7 @@ post: type: ObjectStateGroupUpdate example: !include examples/content/objectstategroups/object_state_group_id/PATCH/ObjectStateGroupUpdate.xml.example application/vnd.ibexa.api.ObjectStateGroupUpdate+json: - type: ObjectStateGroupUpdate + type: ObjectStateGroupUpdateWrapper example: !include examples/content/objectstategroups/object_state_group_id/PATCH/ObjectStateGroupUpdate.json.example responses: 200: @@ -116,7 +116,7 @@ post: type: ObjectStateGroup example: !include examples/content/objectstategroups/object_state_group_id/PATCH/ObjectStateGroup.xml.example application/vnd.ibexa.api.ObjectStateGroup+json: - type: ObjectStateGroup + type: ObjectStateGroupWrapper example: !include examples/content/objectstategroups/object_state_group_id/PATCH/ObjectStateGroup.json.example 400: description: Error - The input does not match the input schema definition. @@ -156,7 +156,7 @@ post: type: ObjectStateList example: !include examples/content/objectstategroups/object_state_group_id/objectstates/GET/ObjectStateList.xml.example application/vnd.ibexa.api.ObjectStateList+json: - type: ObjectStateList + type: ObjectStateListWrapper example: !include examples/content/objectstategroups/object_state_group_id/objectstates/GET/ObjectStateList.json.example 401: description: Error - The user has no permission to read Object states. @@ -179,7 +179,7 @@ post: type: ObjectStateCreate example: !include examples/content/objectstategroups/object_state_group_id/objectstates/POST/ObjectStateCreate.xml.example application/vnd.ibexa.api.ObjectStateCreate+json: - type: ObjectStateCreate + type: ObjectStateCreateWrapper example: !include examples/content/objectstategroups/object_state_group_id/objectstates/POST/ObjectStateCreate.json.example responses: 201: @@ -189,7 +189,7 @@ post: type: ObjectState example: !include examples/content/objectstategroups/object_state_group_id/objectstates/POST/ObjectState.xml.example application/vnd.ibexa.api.ObjectState+json: - type: ObjectState + type: ObjectStateWrapper example: !include examples/content/objectstategroups/object_state_group_id/objectstates/POST/ObjectState.json.example 400: description: Error - The input does not match the input schema definition. @@ -217,7 +217,7 @@ post: type: ObjectState example: !include examples/content/objectstategroups/object_state_group_id/objectstates/object_state_id/GET/ObjectState.xml.example application/vnd.ibexa.api.ObjectState+json: - type: ObjectState + type: ObjectStateWrapper example: !include examples/content/objectstategroups/object_state_group_id/objectstates/object_state_id/GET/ObjectState.json.example 401: description: Error - The user is not authorized to read this Object state. @@ -244,7 +244,7 @@ post: type: ObjectStateUpdate example: !include examples/content/objectstategroups/object_state_group_id/objectstates/object_state_id/PATCH/ObjectStateUpdate.xml.example application/vnd.ibexa.api.ObjectStateUpdate+json: - type: ObjectStateUpdate + type: ObjectStateUpdateWrapper example: !include examples/content/objectstategroups/object_state_group_id/objectstates/object_state_id/PATCH/ObjectStateUpdate.json.example responses: 200: @@ -254,7 +254,7 @@ post: type: ObjectState example: !include examples/content/objectstategroups/object_state_group_id/objectstates/object_state_id/PATCH/ObjectState.xml.example application/vnd.ibexa.api.ObjectState+json: - type: ObjectState + type: ObjectStateWrapper example: !include examples/content/objectstategroups/object_state_group_id/objectstates/object_state_id/PATCH/ObjectState.json.example 400: description: Error - The input does not match the input schema definition. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-orders.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-orders.raml index 7b230d8fb6..383d2b68ec 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-orders.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-orders.raml @@ -15,13 +15,13 @@ displayName: Orders application/vnd.ibexa.api.OrderCreate+json body: application/vnd.ibexa.api.OrderCreate+json: - type: OrderCreate + type: OrderCreateWrapper example: !include examples/orders/POST/OrderCreate.json.example responses: 200: body: application/vnd.ibexa.api.Order+json: - type: Order + type: OrderWrapper example: !include examples/orders/POST/Order.json.example 400: description: Error - the input does not match the input schema definition. @@ -45,7 +45,7 @@ displayName: Orders application/vnd.ibexa.api.OrderList+xml: type: OrderList application/vnd.ibexa.api.OrderList+json: - type: OrderList + type: OrderListWrapper example: !include examples/orders/GET/OrderList.json.example 401: description: Error - the user has no permission to read orders. @@ -67,7 +67,7 @@ displayName: Orders application/vnd.ibexa.api.Order+xml: type: Order application/vnd.ibexa.api.Order+json: - type: Order + type: OrderWrapper example: !include examples/orders/GET/Order.json.example 401: description: Error - the user has no permission to read orders. @@ -92,7 +92,7 @@ displayName: Orders type: ShipmentRefList example: !include examples/shipments/GET/ShipmentRefList.xml.example application/vnd.ibexa.api.ShipmentRefList+json: - type: ShipmentRefList + type: ShipmentRefListWrapper example: !include examples/shipments/GET/ShipmentRefList.json.example 401: description: Error - the user has no permission to read order's shipment lists. @@ -117,7 +117,7 @@ displayName: Orders type: ShipmentCreate example: !include examples/orders/POST/ShipmentCreate.xml.example application/vnd.ibexa.api.ShipmentCreate+json: - type: ShipmentCreate + type: ShipmentCreateWrapper example: !include examples/orders/POST/ShipmentCreate.json.example responses: 200: @@ -126,7 +126,7 @@ displayName: Orders application/vnd.ibexa.api.Shipment+xml: type: Shipment application/vnd.ibexa.api.Shipment+json: - type: Shipment + type: ShipmentWrapper /{id}: get: @@ -145,7 +145,7 @@ displayName: Orders application/vnd.ibexa.api.Order+xml: type: Order application/vnd.ibexa.api.Order+json: - type: Order + type: OrderWrapper example: !include examples/orders/GET/Order.json.example 401: description: Error - the user has no permission to read orders. @@ -156,7 +156,7 @@ displayName: Orders description: Updates an order. body: application/vnd.ibexa.api.OrderUpdate+json: - type: OrderUpdate + type: OrderUpdateWrapper example: !include examples/orders/PATCH/OrderUpdate.json.example headers: Accept: @@ -171,7 +171,7 @@ displayName: Orders 200: body: application/vnd.ibexa.api.Order+json: - type: OrderUpdate + type: OrderWrapper example: !include examples/orders/GET/Order.json.example 400: description: Error - the input does not match the input schema definition. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-payment-methods.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-payment-methods.raml index 903da396ef..5f912f7f11 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-payment-methods.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-payment-methods.raml @@ -18,7 +18,7 @@ post: type: PaymentMethodCreateStruct example: !include examples/payment-methods/POST/PaymentMethodCreateStruct.xml.example application/vnd.ibexa.api.PaymentMethodCreateStruct+json: - type: PaymentMethodCreateStruct + type: PaymentMethodCreateStructWrapper example: !include examples/payment-methods/POST/PaymentMethodCreateStruct.json.example responses: 200: @@ -27,7 +27,7 @@ post: application/vnd.ibexa.api.PaymentMethod+xml: type: PaymentMethod application/vnd.ibexa.api.PaymentMethod+json: - type: PaymentMethod + type: PaymentMethodWrapper example: !include examples/payment-methods/POST/PaymentMethod.json.example 400: description: Error - the input does not match the input schema definition. @@ -54,7 +54,7 @@ post: application/vnd.ibexa.api.PaymentMethodViewInput+xml: type: PaymentMethodViewInput application/vnd.ibexa.api.PaymentMethodViewInput+json: - type: PaymentMethodViewInput + type: PaymentMethodViewInputWrapper example: !include examples/payment-methods/view/POST/PaymentMethodViewInput.json.example responses: 200: @@ -62,7 +62,7 @@ post: application/vnd.ibexa.api.PaymentMethodView+xml: type: PaymentMethodView application/vnd.ibexa.api.PaymentMethodView+json: - type: PaymentMethodView + type: PaymentMethodViewWrapper example: !include examples/payment-methods/view/POST/PaymentMethodView.json.example 400: description: Error - the input does not match the input schema definition. @@ -81,7 +81,7 @@ post: description: OK - loads the payment method. body: application/vnd.ibexa.api.PaymentMethod+json: - type: PaymentMethod + type: PaymentMethodWrapper example: !include examples/payment-methods/id/GET/PaymentMethod.json.example 401: description: Error - the user has no permission to read payment methods. @@ -104,7 +104,7 @@ post: application/vnd.ibexa.api.PaymentMethod+xml: type: PaymentMethod application/vnd.ibexa.api.PaymentMethod+json: - type: PaymentMethod + type: PaymentMethodWrapper example: !include examples/payment-methods/identifier/GET/PaymentMethod.json.example 401: description: Error - the user has no permission to read payment methods. @@ -137,7 +137,7 @@ post: type: PaymentMethodUpdateStruct example: !include examples/payment-methods/identifier/PATCH/PaymentMethodUpdateStruct.xml.example application/vnd.ibexa.api.PaymentMethodUpdateStruct+json: - type: PaymentMethodUpdateStruct + type: PaymentMethodUpdateStructWrapper example: !include examples/payment-methods/identifier/PATCH/PaymentMethodUpdateStruct.json.example responses: 200: @@ -146,7 +146,7 @@ post: application/vnd.ibexa.api.PaymentMethod+xml: type: PaymentMethod application/vnd.ibexa.api.PaymentMethod+json: - type: PaymentMethod + type: PaymentMethodWrapper example: !include examples/payment-methods/identifier/PATCH/PaymentMethod.json.example 400: description: Error - the input does not match the input schema definition. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-product-attributegroups.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-product-attributegroups.raml index c5cc886b1a..ccf60ada21 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-product-attributegroups.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-product-attributegroups.raml @@ -3,7 +3,7 @@ get: 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.AttributeGroupListGet+json: - type: AttributeGroupListGet + type: AttributeGroupListGetWrapper example: !include examples/product/catalog/attribute_groups/GET/AttributeGroupListGet.json.example headers: Accept: @@ -22,7 +22,7 @@ get: application/vnd.ibexa.api.AttributeGroupList+xml: type: AttributeGroupList application/vnd.ibexa.api.AttributeGroupList+json: - type: AttributeGroupList + type: AttributeGroupListWrapper example: !include examples/product/catalog/attribute_groups/GET/AttributeGroupList.json.example 401: description: Error - the user has no permission to read attribute groups. @@ -40,13 +40,13 @@ post: application/vnd.ibexa.api.AttributeGroupCreate+json body: application/vnd.ibexa.api.AttributeGroupCreate+json: - type: AttributeGroupCreate + type: AttributeGroupCreateWrapper example: !include examples/product/catalog/attribute_groups/POST/AttributeGroupCreate.json.example responses: 201: body: application/vnd.ibexa.api.AttributeGroup+json: - type: AttributeGroup + type: AttributeGroupWrapper example: !include examples/product/catalog/attribute_groups/POST/AttributeGroup.json.example 400: description: Error - the input does not match the input schema definition. @@ -62,7 +62,7 @@ post: application/vnd.ibexa.api.AttributeGroupGet+xml: type: AttributeGroupGet application/vnd.ibexa.api.AttributeGroupGet+json: - type: AttributeGroupGet + type: AttributeGroupGetWrapper example: !include examples/product/catalog/attribute_groups/id/GET/AttributeGroupGet.json.example headers: Accept: @@ -81,7 +81,7 @@ post: application/vnd.ibexa.api.AttributeGroup+xml: type: AttributeGroup application/vnd.ibexa.api.AttributeGroup+json: - type: AttributeGroup + type: AttributeGroupWrapper example: !include examples/product/catalog/attribute_groups/id/GET/AttributeGroup.json.example 401: description: Error - the user has no permission to read attribute groups. @@ -103,7 +103,7 @@ post: application/vnd.ibexa.api.AttributeGroupUpdate+xml: type: AttributeGroupUpdate application/vnd.ibexa.api.AttributeGroupUpdate+json: - type: AttributeGroupUpdate + type: AttributeGroupUpdateWrapper example: !include examples/product/catalog/attribute_groups/id/PATCH/AttributeGroupUpdate.json.example responses: 201: @@ -111,7 +111,7 @@ post: application/vnd.ibexa.api.AttributeGroup+xml: type: AttributeGroup application/vnd.ibexa.api.AttributeGroup+json: - type: AttributeGroup + type: AttributeGroupWrapper example: !include examples/product/catalog/attribute_groups/id/PATCH/AttributeGroup.json.example 400: description: Error - the input does not match the input schema definition. @@ -158,7 +158,7 @@ post: application/vnd.ibexa.api.AttributeGroupViewInput+xml: type: AttributeGroupViewInput application/vnd.ibexa.api.AttributeGroupViewInput+json: - type: AttributeGroupViewInput + type: AttributeGroupViewInputWrapper example: !include examples/product/catalog/attribute_groups/POST/AttributeGroupViewInput.json.example responses: 200: @@ -166,7 +166,7 @@ post: application/vnd.ibexa.api.AttributeGroupView+xml: type: AttributeGroupView application/vnd.ibexa.api.AttributeGroupView+json: - type: AttributeGroupView + type: AttributeGroupViewWrapper example: !include examples/product/catalog/attribute_groups/POST/AttributeGroupView.json.example 400: description: Error - the input does not match the input schema definition. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-product-attributes.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-product-attributes.raml index fa3ca3a19a..200932d04e 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-product-attributes.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-product-attributes.raml @@ -12,13 +12,13 @@ post: application/vnd.ibexa.api.AttributeCreate+json body: application/vnd.ibexa.api.AttributeCreate+json: - type: AttributeCreate + type: AttributeCreateWrapper example: !include examples/product/catalog/attributes/POST/AttributeCreate.json.example responses: 201: body: application/vnd.ibexa.api.Attribute+json: - type: Attribute + type: AttributeWrapper example: !include examples/product/catalog/attributes/POST/Attribute.json.example 400: description: Error - the input does not match the input schema definition. @@ -42,7 +42,7 @@ post: application/vnd.ibexa.api.Attribute+xml: type: Attribute application/vnd.ibexa.api.Attribute+json: - type: Attribute + type: AttributeWrapper example: !include examples/product/catalog/attributes/id/GET/Attribute.json.example 401: description: Error - the user has no permission to read the attribute. @@ -69,13 +69,13 @@ post: application/vnd.ibexa.api.AttributeUpdate+json body: application/vnd.ibexa.api.AttributeUpdate+json: - type: AttributeUpdate + type: AttributeUpdateWrapper example: !include examples/product/catalog/attributes/id/group_id/PATCH/AttributeUpdate.json.example responses: 201: body: application/vnd.ibexa.api.Attribute+json: - type: Attribute + type: AttributeWrapper example: !include examples/product/catalog/attributes/id/group_id/PATCH/Attribute.json.example 400: description: Error - the input does not match the input schema definition. @@ -109,7 +109,7 @@ get: application/vnd.ibexa.api.AttributeList+xml: type: AttributeList application/vnd.ibexa.api.AttributeList+json: - type: AttributeList + type: AttributeListWrapper example: !include examples/product/catalog/attributes/GET/AttributeList.json.example 401: description: Error - the user has no permission to read user groups. @@ -132,7 +132,7 @@ get: application/vnd.ibexa.api.AttributeViewInput+xml: type: AttributeViewInput application/vnd.ibexa.api.AttributeViewInput+json: - type: AttributeViewInput + type: AttributeViewInputWrapper example: !include examples/product/catalog/attributes/POST/AttributeViewInput.json.example responses: 200: @@ -140,7 +140,7 @@ get: application/vnd.ibexa.api.AttributeView+xml: type: AttributeView application/vnd.ibexa.api.AttributeView+json: - type: AttributeView + type: AttributeViewWrapper example: !include examples/product/catalog/attributes/POST/AttributeView.json.example 400: description: Error - the input does not match the input schema definition. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-product-attributetypes.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-product-attributetypes.raml index 70ac5d4343..d7ed3cebe7 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-product-attributetypes.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-product-attributetypes.raml @@ -14,7 +14,7 @@ get: application/vnd.ibexa.api.AttributeTypeList+xml: type: AttributeTypeList application/vnd.ibexa.api.AttributeTypeList+json: - type: AttributeTypeList + type: AttributeTypeListWrapper /{identifier}: get: displayName: Get Attribute Type @@ -32,6 +32,6 @@ get: application/vnd.ibexa.api.AttributeType+xml: type: AttributeType application/vnd.ibexa.api.AttributeType+json: - type: AttributeType + type: AttributeTypeWrapper 404: description: Error - The Attribute Type does not exist. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-product-catalogs.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-product-catalogs.raml index c64f633adc..4a38a0da77 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-product-catalogs.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-product-catalogs.raml @@ -12,13 +12,13 @@ post: application/vnd.ibexa.api.CatalogCreate+json body: application/vnd.ibexa.api.CatalogCreate+json: - type: CatalogCreate + type: CatalogCreateWrapper example: !include examples/product/catalog/catalog/POST/CatalogCreate.json.example responses: 201: body: application/vnd.ibexa.api.CatalogCreate+json: - type: Catalog + type: CatalogWrapper example: !include examples/product/catalog/catalog/identifier/GET/Catalog.json.example 400: description: Error - the input does not match the input schema definition. @@ -52,7 +52,7 @@ post: application/vnd.ibexa.api.Catalog+xml: type: Catalog application/vnd.ibexa.api.Catalog+json: - type: Catalog + type: CatalogWrapper example: !include examples/product/catalog/catalog/identifier/GET/Catalog.json.example 401: description: Error - the user is not authorized to view this catalog. @@ -72,13 +72,13 @@ post: application/vnd.ibexa.api.CatalogUpdate+json body: application/vnd.ibexa.api.CatalogUpdate+json: - type: CatalogUpdate + type: CatalogUpdateWrapper example: !include examples/product/catalog/catalog/identifier/PATCH/CatalogUpdate.json.example responses: 201: body: application/vnd.ibexa.api.Catalog+json: - type: CatalogUpdate + type: CatalogWrapper example: !include examples/product/catalog/catalog/identifier/PATCH/Catalog.json.example 400: description: Error - the input does not match the input schema definition. @@ -103,13 +103,13 @@ post: application/vnd.ibexa.api.CatalogCopy+json body: application/vnd.ibexa.api.CatalogCopy+json: - type: CatalogCopy + type: CatalogCopyWrapper example: !include examples/product/catalog/catalog/identifier/POST/CatalogCopy.json.example responses: 201: body: application/vnd.ibexa.api.Catalog+json: - type: CatalogCopy + type: CatalogWrapper example: !include examples/product/catalog/catalog/identifier/POST/Catalog.json.example 400: description: Error - the input does not match the input schema definition. @@ -138,15 +138,15 @@ post: application/vnd.ibexa.api.CatalogViewInput+xml: type: CatalogViewInput application/vnd.ibexa.api.CatalogViewInput+json: - type: CatalogViewInput + type: CatalogViewInputWrapper example: !include examples/product/catalog/catalog/POST/CatalogViewInput.json.example responses: 200: body: application/vnd.ibexa.api.CatalogView+xml: - type: ProductView + type: CatalogView application/vnd.ibexa.api.CatalogView+json: - type: ProductView + type: CatalogViewWrapper example: !include examples/product/catalog/catalog/POST/CatalogView.json.example 400: description: Error - the input does not match the input schema definition. @@ -170,7 +170,7 @@ post: application/vnd.ibexa.api.ProductViewInput+xml: type: ProductViewInput application/vnd.ibexa.api.ProductViewInput+json: - type: ProductViewInput + type: ProductViewInputWrapper example: !include examples/product/catalog/catalog/POST/CatalogProductsViewInput.json.example responses: 200: @@ -178,7 +178,7 @@ post: application/vnd.ibexa.api.ProductView+xml: type: ProductView application/vnd.ibexa.api.ProductView+json: - type: ProductView + type: ProductViewWrapper example: !include examples/product/catalog/catalog/POST/CatalogProductsView.json.example 400: description: Error - the input does not match the input schema definition. @@ -199,7 +199,7 @@ post: application/vnd.ibexa.api.ProductFilterList+xml: type: ProductFilterList application/vnd.ibexa.api.ProductFilterList+json: - type: ProductFilterList + type: ProductFilterListWrapper example: !include examples/product/catalog/catalog/GET/ProductFilterList.json.example /sort_clauses: @@ -218,5 +218,5 @@ post: application/vnd.ibexa.api.ProductSortClauseList+xml: type: ProductSortClauseList application/vnd.ibexa.api.ProductSortClauseList+json: - type: ProductSortClauseList + type: ProductSortClauseListWrapper example: !include examples/product/catalog/catalog/GET/ProductSortClauseList.json.example diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-product-currency.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-product-currency.raml index 682d94964f..52b08af34c 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-product-currency.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-product-currency.raml @@ -12,13 +12,13 @@ post: application/vnd.ibexa.api.CurrencyCreate+json body: application/vnd.ibexa.api.CurrencyCreate+json: - type: CurrencyCreate + type: CurrencyCreateWrapper example: !include examples/product/catalog/currency/POST/CurrencyCreate.json.example responses: 200: body: application/vnd.ibexa.api.Currency+json: - type: CurrencyCreate + type: CurrencyWrapper example: !include examples/product/catalog/currency/POST/Currency.json.example 400: description: Error - the input does not match the input schema definition. @@ -39,7 +39,7 @@ get: description: OK - loads currencies. body: application/vnd.ibexa.api.CurrencyList+json: - type: CurrencyList + type: CurrencyListWrapper example: !include examples/product/catalog/currency/GET/CurrencyList.json.example 401: description: Error - the user has no permission to read currencies. @@ -57,7 +57,7 @@ get: description: OK - loads the currency. body: application/vnd.ibexa.api.Currency+json: - type: Currency + type: CurrencyWrapper example: !include examples/product/catalog/currency/currency_id/GET/Currency.json.example 401: description: Error - the user has no permission to read currencies. @@ -68,7 +68,7 @@ get: description: Updates a currency. body: application/vnd.ibexa.api.CurrencyUpdate+json: - type: CurrencyUpdate + type: CurrencyUpdateWrapper example: !include examples/product/catalog/currency/currency_id/PATCH/CurrencyUpdate.json.example headers: Accept: @@ -83,7 +83,7 @@ get: 200: body: application/vnd.ibexa.api.Currency+json: - type: Currency + type: CurrencyWrapper example: !include examples/product/catalog/currency/currency_id/PATCH/Currency.json.example 400: description: Error - the input does not match the input schema definition. @@ -121,7 +121,7 @@ get: application/vnd.ibexa.api.CurrencyViewInput+xml: type: CurrencyViewInput application/vnd.ibexa.api.CurrencyViewInput+json: - type: CurrencyViewInput + type: CurrencyViewInputWrapper example: !include examples/product/catalog/currency/POST/CurrencyViewInput.json.example responses: 200: @@ -129,7 +129,7 @@ get: application/vnd.ibexa.api.CurrencyView+xml: type: CurrencyView application/vnd.ibexa.api.CurrencyView+json: - type: CurrencyView + type: CurrencyViewWrapper example: !include examples/product/catalog/currency/POST/CurrencyView.json.example 400: description: Error - the input does not match the input schema definition. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-product-customergroups.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-product-customergroups.raml index 59134cbc60..344cafada6 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-product-customergroups.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-product-customergroups.raml @@ -10,7 +10,7 @@ get: 200: body: application/vnd.ibexa.api.CustomerGroupList+json: - type: CustomerGroupList + type: CustomerGroupListWrapper example: !include examples/product/catalog/customer_groups/GET/CustomerGroupList.json.example 401: description: Error - the user has no permission to read customer groups. @@ -28,13 +28,13 @@ post: application/vnd.ibexa.api.CustomerGroupCreate+json body: application/vnd.ibexa.api.CustomerGroupCreate+json: - type: CustomerGroupCreate + type: CustomerGroupCreateWrapper example: !include examples/product/catalog/customer_groups/POST/CustomerGroupCreate.json.example responses: 201: body: application/vnd.ibexa.api.CustomerGroup+json: - type: CustomerGroup + type: CustomerGroupWrapper example: !include examples/product/catalog/customer_groups/POST/CustomerGroup.json.example 400: description: Error - the input does not match the input schema definition. @@ -56,7 +56,7 @@ post: 200: body: application/vnd.ibexa.api.CustomerGroup+json: - type: CustomerGroup + type: CustomerGroupWrapper example: !include examples/product/catalog/customer_groups/identifier/GET/CustomerGroup.json.example 401: description: Error - the user has no permission to read customer groups. @@ -74,13 +74,13 @@ post: application/vnd.ibexa.api.CustomerGroupUpdate+json body: application/vnd.ibexa.api.CustomerGroupUpdate+json: - type: CustomerGroupUpdate + type: CustomerGroupUpdateWrapper example: !include examples/product/catalog/customer_groups/identifier/PATCH/CustomerGroupUpdate.json.example responses: 201: body: application/vnd.ibexa.api.CustomerGroup+json: - type: CustomerGroup + type: CustomerGroupWrapper example: !include examples/product/catalog/customer_groups/identifier/PATCH/CustomerGroup.json.example 400: description: Error - the input does not match the input schema definition. @@ -114,7 +114,7 @@ post: application/vnd.ibexa.api.CustomerGroupViewInput+xml: type: CustomerGroupViewInput application/vnd.ibexa.api.CustomerGroupViewInput+json: - type: CustomerGroupViewInput + type: CustomerGroupViewInputWrapper example: !include examples/product/catalog/customer_groups/POST/CustomerGroupViewInput.json.example responses: 200: @@ -122,7 +122,7 @@ post: application/vnd.ibexa.api.CustomerGroupView+xml: type: CustomerGroupView application/vnd.ibexa.api.CustomerGroupView+json: - type: CustomerGroupView + type: CustomerGroupViewWrapper example: !include examples/product/catalog/customer_groups/POST/CustomerGroupView.json.example 400: description: Error - the input does not match the input schema definition. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-product-products.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-product-products.raml index 0460832801..24ab65c054 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-product-products.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-product-products.raml @@ -13,13 +13,13 @@ application/vnd.ibexa.api.ProductCreate+json body: application/vnd.ibexa.api.ProductCreate+json: - type: ProductCreate + type: ProductCreateWrapper example: !include examples/product/catalog/product/POST/ProductCreate.json.example responses: 201: body: application/vnd.ibexa.api.ProductCreate+json: - type: Product + type: ProductWrapper example: !include examples/product/catalog/product/code/GET/Product.json.example 400: description: Error - the input does not match the input schema definition. @@ -53,13 +53,13 @@ application/vnd.ibexa.api.ProductGet+json body: application/vnd.ibexa.api.ProductGet+json: - type: ProductGet + type: ProductGetWrapper example: !include examples/product/catalog/product/code/GET/ProductGet.json.example responses: 200: body: application/vnd.ibexa.api.Product+json: - type: Product + type: ProductWrapper example: !include examples/product/catalog/product/code/GET/Product.json.example 401: description: Error - the user is not authorized to view this product. @@ -79,13 +79,13 @@ application/vnd.ibexa.api.ProductUpdate+json body: application/vnd.ibexa.api.ProductUpdate+json: - type: ProductUpdate + type: ProductUpdateWrapper example: !include examples/product/catalog/product/code/PATCH/ProductUpdate.json.example responses: 201: body: application/vnd.ibexa.api.Product+json: - type: ProductUpdate + type: ProductWrapper example: !include examples/product/catalog/product/code/PATCH/Product.json.example 400: description: Error - the input does not match the input schema definition. @@ -109,7 +109,7 @@ description: OK - loads the list of product prices. body: application/vnd.ibexa.api.PriceList+json: - type: PriceList + type: PriceListWrapper example: !include examples/product/catalog/product/code/prices/GET/PriceList.json.example 401: description: Error - the user has no permission to read prices. @@ -129,20 +129,20 @@ application/vnd.ibexa.api.CustomPriceCreateStruct+json body: application/vnd.ibexa.api.PriceCreateStruct+json: - type: PriceCreateStruct + type: PriceCreateStructWrapper example: !include examples/product/catalog/product/code/prices/POST/PriceCreateStruct.json.example application/vnd.ibexa.api.CustomPriceCreateStruct+json: - type: CustomPriceCreateStruct + type: CustomPriceCreateStructWrapper example: !include examples/product/catalog/product/code/prices/POST/CustomPriceCreateStruct.json.example responses: 200: description: OK - creates product price. body: application/vnd.ibexa.api.Price+json: - type: PriceCreateStruct + type: PriceWrapper example: !include examples/product/catalog/product/code/prices/Price.json.example application/vnd.ibexa.api.CustomPrice+json: - type: CustomPriceCreateStruct + type: CustomPriceWrapper example: !include examples/product/catalog/product/code/prices/CustomPrice.json.example 400: description: Error - the input does not match the input schema definition. @@ -162,7 +162,7 @@ description: OK - gets price in given currency. body: application/vnd.ibexa.api.Price+json: - type: Price + type: PriceWrapper example: !include examples/product/catalog/product/code/prices/currencyCode/GET/Price.json.example 401: description: Error - the user has no permission to read prices. @@ -183,7 +183,7 @@ description: OK - gets price in given currency and customer group. body: application/vnd.ibexa.api.CustomPrice+json: - type: Price + type: CustomPriceWrapper example: !include examples/product/catalog/product/code/prices/currencyCode/customer-group/customerGroupIdentifier/GET/CustomPrice.json.example 401: description: Error - the user has no permission to read prices. @@ -223,23 +223,21 @@ application/vnd.ibexa.api.CustomPriceUpdateStruct+json body: application/vnd.ibexa.api.PriceUpdateStruct+json: - type: PriceUpdateStruct - example: - !include examples/product/catalog/product/code/prices/id/PATCH/PriceUpdate.json.example + type: PriceUpdateStructWrapper + example: !include examples/product/catalog/product/code/prices/id/PATCH/PriceUpdate.json.example application/vnd.ibexa.api.CustomPriceUpdateStruct+json: - type: CustomPriceUpdateStruct - example: - !include examples/product/catalog/product/code/prices/id/PATCH/CustomPriceUpdate.json.example + type: CustomPriceUpdateStructWrapper + example: !include examples/product/catalog/product/code/prices/id/PATCH/CustomPriceUpdate.json.example responses: 200: description: OK - updates product price. body: application/vnd.ibexa.api.Price+json: - type: Price - example: !include examples/product/catalog/product/code/prices/id/PATCH/PriceUpdate.json.example + type: PriceWrapper + example: !include examples/product/catalog/product/code/prices/id/Price.json.example application/vnd.ibexa.api.CustomPrice+json: - type: CustomPrice - example: !include examples/product/catalog/product/code/prices/id/PATCH/CustomPriceUpdate.json.example + type: CustomPriceWrapper + example: !include examples/product/catalog/product/code/prices/id/CustomPrice.json.example 400: description: Error - the input does not match the input schema definition. 401: @@ -258,13 +256,13 @@ get: application/vnd.ibexa.api.ProductListGet+json body: application/vnd.ibexa.api.ProductListGet+json: - type: ProductListGet + type: ProductListGetWrapper example: !include examples/product/catalog/product/GET/ProductListGet.json.example responses: 200: body: application/vnd.ibexa.api.ProductList+json: - type: ProductList + type: ProductListWrapper example: !include examples/product/catalog/product/GET/ProductList.json.example 401: description: Error - the user has no permission to read product. @@ -287,7 +285,7 @@ get: application/vnd.ibexa.api.ProductViewInput+xml: type: ProductViewInput application/vnd.ibexa.api.ProductViewInput+json: - type: ProductViewInput + type: ProductViewInputWrapper example: !include examples/product/catalog/product/POST/ProductViewInput.json.example responses: 200: @@ -295,7 +293,7 @@ get: application/vnd.ibexa.api.ProductView+xml: type: ProductView application/vnd.ibexa.api.ProductView+json: - type: ProductView + type: ProductViewWrapper example: !include examples/product/catalog/product/POST/ProductView.json.example 400: description: Error - the input does not match the input schema definition. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-product-producttypes.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-product-producttypes.raml index 23fad796d3..cea85687a5 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-product-producttypes.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-product-producttypes.raml @@ -12,13 +12,13 @@ post: application/vnd.ibexa.api.ProductTypeCreate+json body: application/vnd.ibexa.api.ProductTypeCreate+json: - type: ProductTypeCreate + type: ProductTypeCreateWrapper example: !include examples/product/catalog/product_types/POST/ProductTypeCreate.json.example responses: 201: body: application/vnd.ibexa.api.ProductType+json: - type: ProductType + type: ProductTypeWrapper example: !include examples/product/catalog/product_types/POST/ProductType.json.example 400: description: Error - the input does not match the input schema definition. @@ -46,7 +46,7 @@ get: application/vnd.ibexa.api.ProductTypeListGet+xml: type: ProductTypeListGet application/vnd.ibexa.api.ProductTypeListGet+json: - type: ProductTypeListGet + type: ProductTypeListGetWrapper example: !include examples/product/catalog/product_types/GET/ProductTypeListGet.json.example responses: 200: @@ -54,7 +54,7 @@ get: application/vnd.ibexa.api.ProductTypeList+xml: type: ProductTypeList application/vnd.ibexa.api.ProductTypeList+json: - type: ProductTypeList + type: ProductTypeListWrapper example: !include examples/product/catalog/product_types/GET/ProductTypeList.json.example 401: description: Error - the user has no permission to read product type. @@ -73,8 +73,7 @@ get: application/vnd.ibexa.api.ProductTypeUsage+xml: type: ProductTypeUsage application/vnd.ibexa.api.ProductTypeUsage+json: - type: ProductTypeUsage - example: !include examples/product/catalog/product_types/is_used/GET/ProductTypeUsage.json.example + type: ProductTypeUsageWrapper 404: description: Error - product type not found. /{id}: @@ -93,7 +92,7 @@ get: application/vnd.ibexa.api.ProductType+xml: type: ProductType application/vnd.ibexa.api.ProductType+json: - type: ProductType + type: ProductTypeWrapper example: !include examples/product/catalog/product_types/id/GET/ProductType.json.example 401: description: Error - the user has no permission to read product type. @@ -111,13 +110,13 @@ get: application/vnd.ibexa.api.ProductTypeUpdate+json body: application/vnd.ibexa.api.ProductTypeUpdate+json: - type: ProductTypeUpdate + type: ProductTypeUpdateWrapper example: !include examples/product/catalog/product_types/id/PATCH/ProductTypeUpdate.json.example responses: 201: body: application/vnd.ibexa.api.ProductType+json: - type: ProductTypeUpdate + type: ProductTypeWrapper example: !include examples/product/catalog/product_types/id/PATCH/ProductType.json.example 400: description: Error - the input does not match the input schema definition. @@ -152,7 +151,7 @@ get: application/vnd.ibexa.api.ProductTypeViewInput+xml: type: ProductTypeViewInput application/vnd.ibexa.api.ProductTypeViewInput+json: - type: ProductTypeViewInput + type: ProductTypeViewInputWrapper example: !include examples/product/catalog/product_types/POST/ProductTypeViewInput.json.example responses: 200: @@ -160,7 +159,7 @@ get: application/vnd.ibexa.api.ProductTypeView+xml: type: ProductTypeView application/vnd.ibexa.api.ProductTypeView+json: - type: ProductTypeView + type: ProductTypeViewWrapper example: !include examples/product/catalog/product_types/POST/ProductTypeView.json.example 400: description: Error - the input does not match the input schema definition. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-product-productvariant.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-product-productvariant.raml index c21e26c98d..909b2d8860 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-product-productvariant.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-product-productvariant.raml @@ -11,7 +11,7 @@ 200: body: application/vnd.ibexa.api.ProductVariant+json: - type: ProductVariant + type: ProductVariantWrapper example: !include examples/product/catalog/product_variants/code/GET/ProductVariant.json.example 401: description: Error - the user is not authorized to view this product variant. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-product-productvariants.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-product-productvariants.raml index 452923b6e5..b3fc76c969 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-product-productvariants.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-product-productvariants.raml @@ -13,7 +13,7 @@ application/vnd.ibexa.api.ProductVariantCreate+json body: application/vnd.ibexa.api.ProductVariantCreate+json: - type: ProductVariantCreate + type: ProductVariantCreateWrapper example: !include examples/product/catalog/product_variants/POST/ProductVariantCreate.json.example responses: 201: @@ -41,7 +41,7 @@ application/vnd.ibexa.api.ProductVariantGenerate+json body: application/vnd.ibexa.api.ProductVariantGenerate+json: - type: ProductVariantGenerate + type: ProductVariantGenerateWrapper example: !include examples/product/catalog/product_variants/POST/ProductVariantGenerate.json.example responses: 201: @@ -77,13 +77,13 @@ application/vnd.ibexa.api.ProductVariantUpdate+json body: application/vnd.ibexa.api.ProductVariantUpdate+json: - type: ProductVariantUpdate + type: ProductVariantUpdateWrapper example: !include examples/product/catalog/product_variants/code/PATCH/ProductVariantUpdate.json.example responses: 201: body: application/vnd.ibexa.api.ProductVariant+json: - type: ProductVariant + type: ProductVariantWrapper example: !include examples/product/catalog/product_variants/code/PATCH/ProductVariant.json.example 400: description: Error - the input does not match the input schema definition. @@ -112,7 +112,7 @@ application/vnd.ibexa.api.ProductVariantViewInput+xml: type: ProductVariantViewInput application/vnd.ibexa.api.ProductVariantViewInput+json: - type: ProductVariantViewInput + type: ProductVariantViewInputWrapper example: !include examples/product/catalog/product_variants/POST/ProductVariantViewInput.json.example responses: 200: @@ -120,7 +120,7 @@ application/vnd.ibexa.api.ProductVariantView+xml: type: ProductVariantView application/vnd.ibexa.api.ProductVariantView+json: - type: ProductVariantView + type: ProductVariantViewWrapper example: !include examples/product/catalog/product_variants/POST/ProductVariantView.json.example 400: description: Error - the input does not match the input schema definition. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-product-regions.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-product-regions.raml index 59e8807b2b..cf346c3c57 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-product-regions.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-product-regions.raml @@ -14,7 +14,7 @@ get: application/vnd.ibexa.api.RegionList+xml: type: RegionList application/vnd.ibexa.api.RegionList+json: - type: RegionList + type: RegionListWrapper example: !include examples/product/catalog/regions/GET/RegionList.json.example 401: description: Error - the user has no permission to read regions. @@ -35,7 +35,7 @@ get: application/vnd.ibexa.api.Region+xml: type: Region application/vnd.ibexa.api.Region+json: - type: Region + type: RegionWrapper 404: description: Error - the region does not exist. @@ -58,7 +58,7 @@ get: application/vnd.ibexa.api.RegionViewInput+xml: type: RegionViewInput application/vnd.ibexa.api.RegionViewInput+json: - type: RegionViewInput + type: RegionViewInputWrapper example: !include examples/product/catalog/regions/POST/RegionViewInput.json.example responses: 200: @@ -66,7 +66,7 @@ get: application/vnd.ibexa.api.RegionView+xml: type: RegionView application/vnd.ibexa.api.RegionView+json: - type: RegionView + type: RegionViewWrapper example: !include examples/product/catalog/regions/POST/RegionView.json.example 400: description: Error - the input does not match the input schema definition. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-product-vat.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-product-vat.raml index 34dca1bd0d..6376ba1851 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-product-vat.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-product-vat.raml @@ -11,7 +11,7 @@ 200: body: application/vnd.ibexa.api.VatCategoryList+json: - type: VatCategoryList + type: VatCategoryListWrapper example: !include examples/product/catalog/vat/region/GET/VatCategoryList.json.example 401: description: Error - the user is not authorized to read this object. @@ -30,7 +30,7 @@ 200: body: application/vnd.ibexa.api.VatCategory+json: - type: VatCategory + type: VatCategoryWrapper example: !include examples/product/catalog/vat/region/identifier/GET/VatCategory.json.example 401: description: Error - the user is not authorized to read this object. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-root.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-root.raml index 012a607478..72b6e11b6b 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-root.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-root.raml @@ -16,5 +16,5 @@ get: type: Root example: !include examples/GET/Root.xml.example application/vnd.ibexa.api.Root+json: - type: Root + type: RootWrapper example: !include examples/GET/Root.json.example diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-segment-groups.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-segment-groups.raml index ebe30a6c3b..1c5f223ee4 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-segment-groups.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-segment-groups.raml @@ -16,7 +16,7 @@ get: type: SegmentGroupList example: !include examples/segment_groups/GET/SegmentGroupList.xml.example application/vnd.ibexa.api.SegmentGroupList+json: - type: SegmentGroupList + type: SegmentGroupListWrapper example: !include examples/segment_groups/GET/SegmentGroupList.json.example 401: description: Error - the user is not authorized to list segment groups. @@ -43,7 +43,7 @@ get: type: SegmentGroup example: !include examples/segment_groups/identifier/GET/SegmentGroup.xml.example application/vnd.ibexa.api.SegmentGroup+json: - type: SegmentGroup + type: SegmentGroupWrapper example: !include examples/segment_groups/identifier/GET/SegmentGroup.json.example 401: description: Error - the user is not authorized to load this segment group. @@ -67,7 +67,7 @@ get: type: SegmentList example: !include examples/segment_groups/identifier/segments/GET/SegmentList.xml.example application/vnd.ibexa.api.SegmentList+json: - type: SegmentList + type: SegmentListWrapper example: !include examples/segment_groups/identifier/segments/GET/SegmentList.json.example 401: description: Error - the user is not authorized to load this group's segments. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-segments.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-segments.raml index 7f7abd2b6a..c9c8b86c2b 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-segments.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-segments.raml @@ -16,7 +16,7 @@ displayName: Segments application/vnd.ibexa.api.Segment+xml: type: Segment application/vnd.ibexa.api.Segment+json: - type: Segment + type: SegmentWrapper 401: description: Error - the user is not authorized to load this group's segments. 404: diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-services.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-services.raml index 44458e08af..8ba5b4c273 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-services.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-services.raml @@ -16,4 +16,4 @@ displayName: Services type: CountryList example: !include examples/services/countries/GET/CountriesList.xml.example application/vnd.ibexa.api.CountriesList+json: - type: CountryList + type: CountryListWrapper diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-shipments.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-shipments.raml index a69d607b81..c35fa1df9c 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-shipments.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-shipments.raml @@ -14,10 +14,10 @@ get: description: OK - loads the shipments. body: application/vnd.ibexa.api.ShipmentRefList+xml: - type: Shipment + type: ShipmentRefList example: !include examples/shipments/GET/ShipmentRefList.xml.example application/vnd.ibexa.api.ShipmentRefList+json: - type: Shipment + type: ShipmentRefListWrapper example: !include examples/shipments/GET/ShipmentRefList.json.example 401: description: Error - the user has no permission to read shipment lists. @@ -42,7 +42,7 @@ get: type: Shipment example: !include examples/shipments/identifier/GET/Shipment.xml.example application/vnd.ibexa.api.Shipment+json: - type: Shipment + type: ShipmentWrapper example: !include examples/shipments/identifier/GET/Shipment.json.example 401: description: Error - the user has no permission to read shipments. @@ -68,7 +68,7 @@ get: type: ShipmentUpdate example: !include examples/shipments/identifier/PATCH/ShipmentUpdate.xml.example application/vnd.ibexa.api.ShipmentUpdate+json: - type: ShipmentUpdate + type: ShipmentUpdateWrapper example: !include examples/shipments/identifier/PATCH/ShipmentUpdate.json.example responses: 200: @@ -77,7 +77,7 @@ get: type: Shipment example: !include examples/shipments/identifier/PATCH/Shipment.xml.example application/vnd.ibexa.api.Shipment+json: - type: Shipment + type: ShipmentWrapper example: !include examples/shipments/identifier/PATCH/Shipment.json.example 400: description: Error - the input does not match the input schema definition. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-shipping.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-shipping.raml index 992827f82f..fbf31c799a 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-shipping.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-shipping.raml @@ -18,7 +18,7 @@ displayName: Shipping methods type: ShippingMethodRefList example: !include examples/shipping/methods/GET/ShippingMethodRefList.xml.example application/vnd.ibexa.api.ShippingMethodRefList+json: - type: ShippingMethodRefList + type: ShippingMethodRefListWrapper example: !include examples/shipping/methods/GET/ShippingMethodRefList.json.example 401: description: Error - the user has no permission to read shipping methods. @@ -40,7 +40,7 @@ displayName: Shipping methods type: ShippingMethod example: !include examples/shipping/methods/identifier/GET/ShippingMethod.xml.example application/vnd.ibexa.api.ShippingMethod+json: - type: ShippingMethod + type: ShippingMethodWrapper example: !include examples/shipping/methods/identifier/GET/ShippingMethod.json.example 401: description: Error - the user has no permission to read shipping methods. @@ -65,7 +65,7 @@ displayName: Shipping methods type: ShippingMethodTypesList example: !include examples/shipping/method-types/GET/ShippingMethodTypesList.xml.example application/vnd.ibexa.api.ShippingMethodTypesList+json: - type: ShippingMethodTypesList + type: ShippingMethodTypesListWrapper example: !include examples/shipping/method-types/GET/ShippingMethodTypesList.json.example 401: description: Error - the user has no permission to read shipping methods types. @@ -90,7 +90,7 @@ displayName: Shipping methods type: ShippingMethodType example: !include examples/shipping/method-types/identifier/GET/ShippingMethodType.xml.example application/vnd.ibexa.api.ShippingMethodType+json: - type: ShippingMethodType + type: ShippingMethodTypeWrapper example: !include examples/shipping/method-types/identifier/GET/ShippingMethodType.json.example 401: description: Error - the user has no permission to read shipping methods. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-taxonomy.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-taxonomy.raml index ce77aa74bf..416c12a88a 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-taxonomy.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-taxonomy.raml @@ -18,7 +18,7 @@ displayName: Taxonomy application/vnd.ibexa.api.TaxonomyEntry+xml: type: TaxonomyEntry application/vnd.ibexa.api.TaxonomyEntry+json: - type: TaxonomyEntry + type: TaxonomyEntryWrapper 401: description: Error - the user is not authorized to read this Entry. 404: @@ -40,7 +40,7 @@ displayName: Taxonomy application/vnd.ibexa.api.TaxonomyEntry+xml: type: TaxonomyEntry application/vnd.ibexa.api.TaxonomyEntry+json: - type: TaxonomyEntry + type: TaxonomyEntryWrapper 401: description: Error - the user is not authorized to read this Entry. 404: @@ -62,7 +62,7 @@ displayName: Taxonomy application/vnd.ibexa.api.TaxonomyEntry+xml: type: TaxonomyEntry application/vnd.ibexa.api.TaxonomyEntry+json: - type: TaxonomyEntry + type: TaxonomyEntryWrapper 401: description: Error - the user is not authorized to read this Entry. 404: @@ -81,7 +81,7 @@ displayName: Taxonomy application/vnd.ibexa.api.TaxonomyEntryBulkRemove+xml: type: TaxonomyEntryBulkRemove application/vnd.ibexa.api.TaxonomyEntryBulkRemove+json: - type: TaxonomyEntryBulkRemove + type: TaxonomyEntryBulkRemoveWrapper example: !include examples/taxonomy/entries/DELETE/TaxonomyEntryBulkRemove.json.example responses: 204: @@ -104,7 +104,7 @@ displayName: Taxonomy application/vnd.ibexa.api.TaxonomyEntryBulkMove+xml: type: TaxonomyEntryBulkMove application/vnd.ibexa.api.TaxonomyEntryBulkMove+json: - type: TaxonomyEntryBulkMove + type: TaxonomyEntryBulkMoveWrapper example: !include examples/taxonomy/entries/move/POST/TaxonomyEntryBulkMove.json.example responses: 204: @@ -132,7 +132,7 @@ displayName: Taxonomy application/vnd.ibexa.api.TaxonomyEntryAssignment+xml: type: TaxonomyEntryAssignment application/vnd.ibexa.api.TaxonomyEntryAssignment+json: - type: TaxonomyEntryAssignment + type: TaxonomyEntryAssignmentWrapper 404: description: Error - the assignment does not exist. /entry-assignments: @@ -146,7 +146,7 @@ displayName: Taxonomy application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json body: application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json: - type: TaxonomyEntryAssignToContent + type: TaxonomyEntryAssignToContentWrapper example: !include examples/taxonomy/POST/TaxonomyEntryAssignToContent.json.example responses: 201: @@ -165,7 +165,7 @@ displayName: Taxonomy application/vnd.ibexa.api.TaxonomyEntryUnassignFromContent+json body: application/vnd.ibexa.api.TaxonomyEntryUnassignFromContent+json: - type: TaxonomyEntryUnassignFromContent + type: TaxonomyEntryUnassignFromContentWrapper example: !include examples/taxonomy/POST/TaxonomyEntryUnassignFromContent.json.example responses: 201: @@ -194,7 +194,7 @@ displayName: Taxonomy 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 + type: EntryAssignmentCollectionWrapper 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/ibexa-types.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-types.raml index bce968ba3c..322512ef3d 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-types.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-types.raml @@ -1,3 +1,28 @@ +UnixTimestamp: + type: integer + +TimezoneDate: + type: object + properties: + date: string + timezone_type: integer + timezone: string + +Fields: + type: object + properties: + field: + type: Field[] + +Href: + type: object + properties: + _href: + type: string + xml: + attribute: true + name: href + Asset: type: object description: 'Asset value object' @@ -46,8 +71,22 @@ BaseObject: properties: _media-type: type: string + xml: + attribute: true + name: media-type _href: type: string + required: false + xml: + attribute: true + name: href + +BookmarkListWrapper: + description: 'JSON object with only a BookmarkList property.' + type: object + properties: + BookmarkList: + type: BookmarkList BookmarkList: description: 'List of bookmarked Locations.' @@ -58,7 +97,22 @@ BookmarkList: type: integer items: description: 'List of bookmarked Locations.' - type: Location[] + type: array + items: + type: object + properties: + Location: + type: Location + _media-type: + type: string + __href: + type: string + +ContentWrapper: + description: 'JSON object with only a Content property.' + type: object + properties: + Content: Content Content: description: 'Content ID matcher class.' @@ -67,9 +121,15 @@ Content: _remoteId: description: 'Remote ID of the content type.' type: string + xml: + attribute: true + name: remoteId _id: description: 'Unique ID of the content type.' type: integer + xml: + attribute: true + name: id ContentType: description: 'Content type.' type: BaseObject @@ -94,9 +154,11 @@ Content: lastModificationDate: description: 'Content item modification date.' type: datetime + required: false publishedDate: description: 'Content item publication date.' type: datetime + required: false mainLanguageCode: description: 'The main language code of the content item.' type: string @@ -108,11 +170,17 @@ Content: type: boolean status: description: 'Status of the content. Possible values: const STATUS_DRAFT = 0;const STATUS_PUBLISHED = 1; const STATUS_TRASHED = 2.' - #enum: ['DRAFT', 'PUBLISHED', 'TRASHED'] + enum: [ 'DRAFT', 'PUBLISHED', 'TRASHED' ] ObjectStates: description: 'Object states.' type: BaseObject +ContentCreateWrapper: + description: 'JSON object with only a ContentCreate property.' + type: object + properties: + ContentCreate: ContentCreate + ContentCreate: description: 'This class is used for creating a new content item.' type: object @@ -120,19 +188,23 @@ ContentCreate: ContentType: description: 'The content type for which the new content item is created.' required: true - type: ContentType + type: ContentCreateContentType | Href Section: description: 'The Section the content item is assigned to. If not set the Section of the parent is used or a default Section.' - type: Section + type: Href + required: false User: description: 'The owner of the content. If not given the current authenticated User is set as owner.' type: integer + required: false alwaysAvailable: description: "Indicates if the content item is shown in the main language if it's not present in an other requested language." - type: boolean + type: string + required: false remoteId: description: 'Remote identifier used as a custom identifier for the content item. Needs to be a unique Content->remoteId string value.' type: string + required: false mainLanguageCode: description: 'The main language code for the content. This language will also be used for as initial language for the first created version. It is also used as default language for added fields.' required: true @@ -140,10 +212,13 @@ ContentCreate: modificationDate: description: 'Modification date. If not given, the current integer is used.' type: datetime + required: false LocationCreate: - type: object[] + type: object + required: true fields: type: object + required: true properties: field: object[] @@ -167,6 +242,12 @@ ContentImageVariation: description: 'Size of an image file.' type: integer +ContentInfoWrapper: + description: 'JSON object with only a ContentInfo property.' + type: object + properties: + ContentInfo: ContentInfo + ContentInfo: description: 'This class provides all version independent information of the content item.' type: BaseObject @@ -246,13 +327,19 @@ ContentMetadataUpdateStruct: description: "If set, will change the content's 'always-available' name." type: string +ContentObjectStatesWrapper: + description: 'JSON object with only a ContentObjectStates property.' + type: object + properties: + ContentObjectStates: ContentObjectStates + ContentObjectStates: description: 'Represents a list of object states.' type: object properties: ObjectState: description: 'List of object state values.' - type: BaseObject[] + type: Href[] ContentStruct: description: 'Base struct for content create/update structs.' @@ -262,6 +349,27 @@ ContentStruct: description: 'Adds a field to the field collection. This method could also be implemented by a magic setter so that $fields[$fieldDefIdentifier][$language] = $value or without language $fields[$fieldDefIdentifier] = $value is an equivalent call.' type: string +ContentCreateContentType: + type: object + properties: + _href: + type: string + xml: + attribute: true + name: href + FieldDefinitions: + type: BaseObject + properties: + FieldDefinitions: + type: FieldDefinition[] + required: false + +ContentTypeWrapper: + description: 'JSON object with only a ContentType property.' + type: object + properties: + ContentType: ContentType + ContentType: description: 'This class represents a content type.' type: BaseObject @@ -271,16 +379,16 @@ ContentType: type: integer status: description: 'The status of the content type. Possible values: const STATUS_DEFINED = 0; Status constant for defined (aka published) Type, const STATUS_DRAFT = 1; Status constant for draft (aka temporary) Type; const STATUS_MODIFIED = 2; Status constant for modified (aka deferred for publishing) Type.' - enum: [ ] + enum: [ "DEFINED", "DRAFT", "MODIFIED", "PUBLISHED" ] identifier: description: 'String identifier of a content type.' type: string names: description: 'Name of a content type.' - type: Value[] + type: ValueObject descriptions: description: 'Description of a content type.' - type: Value[] + type: ValueObject creationDate: description: 'Creation date of the content type.' type: datetime @@ -304,7 +412,7 @@ ContentType: type: string urlAliasSchema: description: 'URL alias schema. If nothing is provided, $nameSchema will be used instead.' - type: string + type: string | nil nameSchema: description: 'Name schema. Can be composed of FieldDefinition identifier place holders.' type: string @@ -316,16 +424,13 @@ ContentType: type: boolean defaultSortField: description: 'Specifies which property the child Locations should be sorted on by default when created. Map for Location sort fields to their respective SortClauses - class name/identifier and modified subnode. One of the fallowing values: const SORT_FIELD_PATH = 1; const SORT_FIELD_PUBLISHED = 2; const SORT_FIELD_MODIFIED = 3; const SORT_FIELD_SECTION = 4; const SORT_FIELD_DEPTH = 5; const SORT_FIELD_PRIORITY = 8; const SORT_FIELD_NAME = 9; const SORT_FIELD_NODE_ID = 11; const SORT_FIELD_CONTENTOBJECT_ID = 12.' - enum: [ ] + enum: [ "PATH", "PUBLISHED", "MODIFIED", "SECTION", "DEPTH", "PRIORITY", "NAME", "NODE_ID", "CONTENTOBJECT_ID" ] defaultSortOrder: description: 'Specifies whether the sort order should be ascending or descending by default when created. Map for Location sort order to their respective Query SORT constants. Possible values: const SORT_ORDER_DESC = 0; const SORT_ORDER_ASC = 1.' - enum: [ ] + enum: [ "ASC", "DESC" ] FieldDefinitions: description: 'This method returns the content type Field definitions from this type.' - type: BaseObject - properties: - FieldDefinitions: - type: FieldDefinition[] + type: FieldDefinitions ContentTypeCreateStruct: description: 'This class is used for creating content types.' @@ -353,33 +458,39 @@ ContentTypeCreateStruct: type: boolean defaultSortField: description: 'Specifies which property the child Locations should be sorted on by default when created.' - type: integer + type: string defaultSortOrder: description: 'Specifies whether the sort order should be ascending or descending by default when created.' - type: integer + type: string defaultAlwaysAvailable: description: 'If an instance of a content type is created the always available flag is set by default this this value.' type: boolean names: description: 'An array of names with languageCode keys. At least one name in the main language is required.' - required: true - type: string[] + type: ValueObject + required: false descriptions: description: 'An array of descriptions with languageCode keys.' - type: string[] + type: ValueObject + required: false addFieldDefinition: description: 'Adds a new Field definition.' type: FieldDefinitionCreateStruct + required: false creatorId: description: 'If set this value overrides the current User as creator.' type: integer + required: false creationDate: description: 'f set this value overrides the current time for creation.' type: datetime -ContentTypeDraft: - description: 'This class represents a draft of a content type.' +ContentTypeGroupWrapper: + description: 'JSON object with only a ContentTypeGroup property.' type: object + properties: + ContentTypeGroup: ContentTypeGroup + ContentTypeGroup: description: 'This class represents a content type group value.' type: BaseObject @@ -406,8 +517,14 @@ ContentTypeGroup: description: 'Content types.' type: BaseObject +ContentTypeGroupInputWrapper: + description: 'JSON object with only a ContentTypeGroupInput property.' + type: object + properties: + ContentTypeGroupInput: ContentTypeGroupInput + ContentTypeGroupInput: - type: BaseObject + type: object ContentTypeGroupCreateStruct: description: 'This class is used for creating a content type group.' @@ -419,6 +536,13 @@ ContentTypeGroupCreateStruct: creationDate: description: 'If set this value overrides the current time for creation.' type: datetime + +ContentTypeGroupListWrapper: + description: 'JSON object with only a ContentTypeGroupList property.' + type: object + properties: + ContentTypeGroupList: ContentTypeGroupList + ContentTypeGroupList: description: 'List of content type groups.' type: BaseObject @@ -428,10 +552,19 @@ ContentTypeGroupList: ContentTypeGroupRef: description: 'Content type group reference.' - type: BaseObject + type: array + items: + type: BaseObject + properties: + unlink: + type: Unlink + required: false + +ContentTypeGroupRefListWrapper: + description: 'JSON object with only a ContentTypeGroupRefList property.' + type: object properties: - Unlink: - type: Unlink + ContentTypeGroupRefList: ContentTypeGroupRefList ContentTypeGroupRefList: description: 'List of content type groups references.' @@ -459,6 +592,12 @@ ContentTypeGroupUpdateStruct: description: 'If set this value overrides the current time for modified.' type: datetime +ContentTypeInfoWrapper: + description: 'JSON object with only a ContentTypeInfo property.' + type: object + properties: + ContentTypeInfo: ContentTypeInfo + ContentTypeInfo: description: 'This class stores content type information.' type: BaseObject @@ -468,16 +607,16 @@ ContentTypeInfo: type: integer status: description: 'The status of the content type. Possible values: const STATUS_DEFINED = 0; Status constant for defined (aka published) Type, const STATUS_DRAFT = 1; Status constant for draft (aka temporary) Type; const STATUS_MODIFIED = 2; Status constant for modified (aka deferred for publishing) Type.' - enum: [ ] + enum: [ "DEFINED", "DRAFT", "MODIFIED", "PUBLISHED" ] identifier: description: 'String identifier of a content type.' type: string names: description: 'Name of a content type.' - type: Value[] + type: ValueObject descriptions: description: 'Description of a content type.' - type: Value[] + type: ValueObject creationDate: description: 'Creation date of the content type.' type: datetime @@ -501,7 +640,7 @@ ContentTypeInfo: type: string urlAliasSchema: description: 'URL alias schema. If nothing is provided, $nameSchema will be used instead.' - type: string + type: string | nil nameSchema: description: 'Name schema. Can be composed of FieldDefinition identifier place holders.' type: string @@ -516,10 +655,16 @@ ContentTypeInfo: type: boolean defaultSortField: description: 'Specifies which property the child Locations should be sorted on by default when created. Map for Location sort fields to their respective SortClauses - class name/identifier and modified subnode. One of the fallowing values: const SORT_FIELD_PATH = 1; const SORT_FIELD_PUBLISHED = 2; const SORT_FIELD_MODIFIED = 3; const SORT_FIELD_SECTION = 4; const SORT_FIELD_DEPTH = 5; const SORT_FIELD_PRIORITY = 8; const SORT_FIELD_NAME = 9; const SORT_FIELD_NODE_ID = 11; const SORT_FIELD_CONTENTOBJECT_ID = 12.' - enum: [ ] + enum: [ "PATH", "PUBLISHED", "MODIFIED", "SECTION", "DEPTH", "PRIORITY", "NAME", "NODE_ID", "CONTENTOBJECT_ID" ] defaultSortOrder: description: 'Specifies whether the sort order should be ascending or descending by default when created. Map for Location sort order to their respective Query SORT constants. Possible values: const SORT_ORDER_DESC = 0; const SORT_ORDER_ASC = 1.' - enum: [ ] + enum: [ "ASC", "DESC" ] + +ContentTypeInfoListWrapper: + description: 'JSON object with only a ContentTypeInfoList property.' + type: object + properties: + ContentTypeList: ContentTypeInfoList ContentTypeInfoList: description: 'List of content type information.' @@ -529,6 +674,12 @@ ContentTypeInfoList: description: 'This class stores content type information.' type: ContentTypeInfo[] +ContentTypeListWrapper: + description: 'JSON object with only a ContentTypeList property.' + type: object + properties: + ContentTypeList: ContentTypeList + ContentTypeList: description: 'List of content types.' type: BaseObject @@ -543,42 +694,55 @@ ContentTypeUpdateStruct: identifier: description: 'If set the unique identifier of a type is changed to this value.' type: string + required: false remoteId: description: 'If set the remote ID is changed to this value.' type: string + required: false urlAliasSchema: description: 'If set the URL alias schema is changed to this value.' type: string + required: false nameSchema: description: 'f set the name schema is changed to this value.' type: string + required: false isContainer: description: 'If set the container flag is set to this value.' type: boolean + required: false mainLanguageCode: description: 'If set the main language is changed to this value.' type: string + required: false defaultSortField: description: 'If set the default sort field is changed to this value.' - type: integer + enum: [ "PATH", "PUBLISHED", "MODIFIED", "SECTION", "DEPTH", "PRIORITY", "NAME", "NODE_ID", "CONTENTOBJECT_ID" ] + required: false defaultSortOrder: description: 'If set the default sort order is set to this value.' - type: integer + enum: [ "ASC", "DESC" ] + required: false defaultAlwaysAvailable: description: 'If set the default always available flag is set to this value.' type: boolean + required: false modifierId: description: 'If set this value overrides the current User as creator.' type: integer + required: false modificationDate: description: 'If set this value overrides the current time for creation.' type: datetime + required: false names: description: 'If set this array of names with languageCode keys replace the complete name collection.' - type: Value[] + type: ValueObject + required: false descriptions: description: 'If set this array of descriptions with languageCode keys replace the complete description collection.' - type: Value[] + type: ValueObject + required: false ContentUpdateStruct: description: 'This class is used for updating the fields of a content item draft.' @@ -598,6 +762,9 @@ Country: _id: description: 'ID that represents a country name.' type: string + xml: + attribute: true + name: id name: description: 'Name of the country.' type: string @@ -611,6 +778,12 @@ Country: description: 'IDC' type: integer +CountryListWrapper: + description: 'JSON object with only a CountryList property.' + type: object + properties: + CountryList: CountryList + CountryList: description: 'This class is representing an ISO-3166 formatted list of world countries.' type: BaseObject @@ -643,26 +816,31 @@ Criterion: operator: description: 'The operator used by the Criterion.' type: string + required: false value: description: 'The value(s) matched by the Criteria.' type: array items: any + required: false target: description: 'The target used by the Criteria (field, metadata...).' type: string + required: false valueData: description: 'Additional value data, required by some Criteria, MapLocationDistance for instance.' type: Value + required: false Specifications: description: "Criterion description function. Returns the combination of the Criterion's supported operator/value, as an array of objects." type: Specifications[] - ValueTypeCheckCallback: - description: 'Returns a callback that checks the values types depending on the operator specifications.' - type: integer + required: false DateRange: description: 'Representation of date range.' - type: object + type: BaseObject + properties: + startDate: string + endDate: string Event: description: 'Calendar event.' @@ -697,43 +875,70 @@ EventGroup: description: 'Event group.' type: BaseObject properties: - currentPage: + _currentPage: description: 'Current page representation.' type: string + xml: + attribute: true + name: currentPage nextPage: description: 'Next page representation.' type: string + required: false groupKey: type: DateRange + required: false totalCount: description: 'Total count of events.' type: integer events: type: Event[] +EventGroupListWrapper: + description: 'JSON object with only a EventGroupList property.' + type: object + properties: + EventGroupList: EventGroupList + EventGroupList: description: 'Grouped calendar event list.' - type: EventList + type: BaseObject properties: groups: type: EventGroup[] +EventListWrapper: + description: 'JSON object with only a EventList property.' + type: object + properties: + EventList: EventList + EventList: description: 'List of calendar events.' type: BaseObject properties: - currentPage: + _currentPage: description: 'Current page representation.' type: string + xml: + attribute: true + name: currentPage nextPage: description: 'Next page representation.' type: string + required: false totalCount: description: 'Total count of events.' type: integer events: type: Event[] +UnscheduleActionWrapper: + description: 'JSON object with only a UnscheduleAction property.' + type: object + properties: + UnscheduleAction: UnscheduleAction + UnscheduleAction: description: 'This class represents events to unschedule' type: object @@ -769,24 +974,39 @@ Field: id: description: 'The field ID.' type: integer + required: false fieldDefinitionIdentifier: description: 'The Field definition identifier.' type: string languageCode: description: 'The language code.' type: string + required: false fieldTypeIdentifier: description: 'Field Type identifier.' type: string + required: false fieldValue: description: 'A Field Type value or a value type which can be converted by the corresponding field type.' type: any +FieldDefinitionsWrapper: + description: 'JSON object with only a FieldDefinitions property.' + type: object + properties: + FieldDefinitions: FieldDefinitions + FieldDefinitions: type: object properties: FieldDefinition: FieldDefinition[] +FieldDefinitionWrapper: + description: 'JSON object with only a FieldDefinition property.' + type: object + properties: + FieldDefinition: FieldDefinition + FieldDefinition: description: 'This class represents a Field definition.' type: BaseObject @@ -823,20 +1043,32 @@ FieldDefinition: type: boolean names: description: 'Names of content types.' - type: Value[] + type: ValueObject descriptions: description: 'Descriptions of content types.' - type: Value[] + type: ValueObject fieldSettings: description: 'Settings for the Field definition supported by the field type.' type: any validatorConfiguration: description: 'Validator configuration of this Field definition supported by the field type.' - type: StringLengthValidator + type: StringLengthValidatorWrapper | [] + +FieldDefinitionCreateWrapper: + description: 'JSON object with only a FieldDefinitionCreate property.' + type: object + properties: + FieldDefinitionCreate: FieldDefinitionCreate FieldDefinitionCreate: type: BaseObject +FieldDefinitionUpdateWrapper: + description: 'JSON object with only a FieldDefinitionUpdate property.' + type: object + properties: + FieldDefinitionUpdate: FieldDefinitionUpdate + FieldDefinitionUpdate: type: BaseObject @@ -927,6 +1159,12 @@ FieldDefinitionUpdateStruct: description: 'If set the the searchable flag is set to this value.' type: boolean +JWTWrapper: + description: 'JSON object with only a JWT property.' + type: object + properties: + JWT: JWT + JWT: description: 'This class represents the JWT authentication token' type: object @@ -935,22 +1173,34 @@ JWT: description: 'JWT authentication token' type: string +JWTInputWrapper: + description: 'JSON object with only a JWTInput property.' + type: object + properties: + JWTInput: JWTInput + JWTInput: description: 'This class represents the input for a JWT authentication token' type: object properties: - user: + username: description: 'User name' type: string password: description: 'User password' type: string +LanguageWrapper: + description: 'JSON object with only a Language property.' + type: object + properties: + Language: Language + Language: description: 'This class represents a language in the Repository.' type: BaseObject properties: - id: + languageId: description: 'The language ID (auto generated).' type: integer languageCode: @@ -959,9 +1209,6 @@ Language: name: description: 'Human readable name of the language.' type: string - enabled: - description: 'Indicates if the language is enabled or not.' - type: boolean LanguageCode: description: 'Language code.' @@ -970,6 +1217,12 @@ LanguageCode: languageCode: type: string +LanguageListWrapper: + description: 'JSON object with only a LanguageList property.' + type: object + properties: + LanguageList: LanguageList + LanguageList: description: 'List of languages.' type: BaseObject @@ -993,14 +1246,26 @@ LanguageCreateStruct: Limitation: description: 'This class represents a Limitation applied to a policy.' - type: BaseObject + type: object properties: _identifier: description: 'Returns the limitation identifier (one of the defined constants) or a custom limitation. Constants: CONTENTTYPE = Class; LANGUAGE = Language; LOCATION = Node; OWNER = Owner; PARENTOWNER = ParentOwner; PARENTCONTENTTYPE = ParentClass; PARENTDEPTH = ParentDepth; SECTION = Section; NEWSECTION = NewSection; SITEACCESS = SiteAccess; STATE = State; NEWSTATE = NewState; SUBTREE = Subtree; USERGROUP = Group; PARENTUSERGROUP = ParentGroup; STATUS = Status.' - enum: [ 'CONTENTTYPE', 'LANGUAGE', 'LOCATION', 'OWNER', 'PARENTOWNER', 'PARENTCONTENTTYPE', 'PARENTDEPTH', 'SECTION', 'NEWSECTION','SITEACCESS', 'STATE', 'NEWSTATE', 'SUBTREE', 'USERGROUP', 'PARENTUSERGROUP', 'STATUS' ] - Values: + enum: [ 'ContentType', 'Language', 'Location', 'Owner', 'Parentowner', 'ParentContentType', 'ParentDepth', 'Section', 'NewSection','SiteAccess', 'State', 'NewState', 'Subtree', 'UserGroup', 'ParentUserGroup', 'Status', 'Class' ] + xml: + attribute: true + name: identifier + values: description: 'A read-only list of IDs or identifiers for which the limitation should be applied. The value of this property must conform to a hash, which means that it may only consist of array and scalar values, but must not contain objects or resources.' - type: Ref[] + type: object + properties: + ref: + type: Href[] + +LocationWrapper: + description: 'JSON object with only a Location property.' + type: object + properties: + Location: Location Location: description: 'This class represents a Location in the Repository.' @@ -1033,6 +1298,7 @@ Location: Children: description: 'Children Location.' type: Ref + required: false pathString: description: 'The materialized path of the Location entry e.g. /1/2/.' type: string @@ -1054,9 +1320,33 @@ Location: UrlAliases: description: 'This class represents URL aliases.' type: Ref + required: false + +LocationCreateWrapper: + description: 'JSON object with only a LocationCreate property.' + type: object + properties: + LocationCreate: LocationCreate LocationCreate: - type: BaseObject + type: object + properties: + ParentLocation: + type: object + properties: + _href: + type: string + xml: + attribute: true + name: href + priority: + type: string + hidden: + type: string | boolean + sortField: + type: string + sortOrder: + type: string LocationCreateStruct: description: 'This class is used to create a new Location for a content item.' @@ -1082,37 +1372,48 @@ LocationCreateStruct: required: true type: integer +LocationListWrapper: + description: 'JSON object with only a LocationList property.' + type: object + properties: + LocationList: LocationList + LocationList: description: 'This class represents a queried Location list holding a totalCount and a partial list of Locations (by offset/limit parameters and permission filters).' - type: object + type: BaseObject properties: - totalCount: - description: 'The total count of found Locations (filtered by permissions).' - type: integer - Locations: + Location: description: 'The partial list of Locations controlled by offset/limit.' - type: Location[] + type: Ref[] LocationQuery: description: 'This class is used to perform a Location query.' type: object -LocationUpdateStruct: +LocationUpdateWrapper: + description: 'JSON object with only a LocationUpdate property.' + type: object + properties: + LocationUpdate: LocationUpdate + +LocationUpdate: description: 'This class is used for updating Location meta data.' type: object properties: priority: description: 'If set the Location priority is changed to the new value.' - type: integer + type: string remoteId: description: 'If set the Location gets a new remoteId. Needs to be a unique Location->remoteId string value.' - type: integer + type: string + hidden: + type: boolean sortField: description: 'If set the sortField is changed. The sort field specifies which property the child Locations should be sorted on. Valid values are found at {@link Location::SORT_FIELD_*}.' - type: integer + enum: [ 'PATH', 'PUBLISHED', 'MODIFIED', 'SECTION', 'DEPTH', 'CLASS_IDENTIFIER', 'CLASS_NAME', 'PRIORITY', 'NAME', 'MODIFIED_SUBNODE', 'NODE_ID', 'CONTENTOBJECT_ID' ] sortOrder: description: 'If set the sortOrder is changed. The sort order specifies whether the sort order should be ascending or descending. Valid values are {@link Location::SORT_ORDER_*}.' - type: integer + enum: [ 'ASC', 'DESC' ] Message: description: 'Class for translatable messages, which only occur in singular form. The message might include replacements, in the form %[A-Za-z]%. Those are replaced by the values provided. A raw % can be escaped like %%.' @@ -1161,6 +1462,12 @@ NotificationList: description: 'List of notifications.' type: Notification[] +ObjectStateWrapper: + description: 'JSON object with only a ObjectState property.' + type: object + properties: + ObjectState: ObjectState + ObjectState: description: 'This class represents a Object state value.' type: BaseObject @@ -1179,19 +1486,19 @@ ObjectState: type: BaseObject languageCodes: description: 'The available language codes for names an descriptions.' - type: string[] + type: string names: description: 'Names.' - type: object - properties: - Value: - type: Value + type: ValueObject descriptions: description: 'Descriptions.' - type: object - properties: - Value: - type: Value + type: ValueObject + +ObjectStateCreateWrapper: + description: 'JSON object with only a ObjectStateCreate property.' + type: object + properties: + ObjectStateCreate: ObjectStateCreate ObjectStateCreate: description: 'This class represents a value for creating Object states.' @@ -1203,7 +1510,7 @@ ObjectStateCreate: type: string priority: description: 'Priority for ordering. If not set the Object state is created as the last one.' - type: integer + type: string defaultLanguageCode: description: 'The default language code.' required: true @@ -1223,6 +1530,12 @@ ObjectStateCreate: properties: value: Value[] +ObjectStateGroupWrapper: + description: 'JSON object with only a ObjectStateGroup property.' + type: object + properties: + ObjectStateGroup: ObjectStateGroup + ObjectStateGroup: description: 'This class represents an Object state group value.' type: BaseObject @@ -1238,22 +1551,22 @@ ObjectStateGroup: type: string languageCodes: description: 'The available language codes for names an descriptions.' - type: string[] + type: string ObjectStates: description: 'Object States.' type: BaseObject - Names: + names: description: 'List of names.' - type: object - properties: - Value: - type: Value - Descriptions: + type: ValueObject + descriptions: description: 'List of descriptions.' - type: object - properties: - Value: - type: Value + type: ValueObject + +ObjectStateGroupCreateWrapper: + description: 'JSON object with only a ObjectStateGroupCreate property.' + type: object + properties: + ObjectStateGroupCreate: ObjectStateGroupCreate ObjectStateGroupCreate: description: 'This class represents a value for creating Object state groups.' @@ -1270,10 +1583,16 @@ ObjectStateGroupCreate: names: description: 'An array of names with languageCode keys. At least one name in the main language is required.' required: true - type: string[] + type: ValueObject descriptions: description: 'An array of descriptions with languageCode keys.' - type: string[] + type: ValueObject + +ObjectStateGroupListWrapper: + description: 'JSON object with only a ObjectStateGroupList property.' + type: object + properties: + ObjectStateGroupList: ObjectStateGroupList ObjectStateGroupList: description: 'List of Object state groups.' @@ -1281,7 +1600,13 @@ ObjectStateGroupList: properties: ObjectStateGroup: description: 'This class represents an Object state group value.' - type: ObjectStateGroup + type: ObjectStateGroup[] + +ObjectStateGroupUpdateWrapper: + description: 'JSON object with only a ObjectStateGroupUpdate property.' + type: object + properties: + ObjectStateGroupUpdate: ObjectStateGroupUpdate ObjectStateGroupUpdate: description: 'This class represents a value for updating Object state groups.' @@ -1290,15 +1615,25 @@ ObjectStateGroupUpdate: identifier: description: 'Readable unique string identifier of a group.' type: string + required: false defaultLanguageCode: description: 'The default language code.' type: string + required: false names: description: 'An array of names with languageCode keys.' - type: string[] + type: ValueObject + required: false descriptions: description: 'An array of descriptions with languageCode keys.' - type: string[] + type: ValueObject + required: false + +ObjectStateListWrapper: + description: 'JSON object with only a ObjectStateList property.' + type: object + properties: + ObjectStateList: ObjectStateList ObjectStateList: description: 'List of Object states.' @@ -1307,6 +1642,12 @@ ObjectStateList: ObjectState: type: ObjectState[] +ObjectStateUpdateWrapper: + description: 'JSON object with only a ObjectStateUpdate property.' + type: object + properties: + ObjectStateUpdate: ObjectStateUpdate + ObjectStateUpdate: description: 'This class represents a value for updating Object states.' type: object @@ -1314,15 +1655,19 @@ ObjectStateUpdate: identifier: description: 'Readable unique string identifier of a group.' type: string + required: false defaultLanguageCode: description: 'The default language code.' type: string + required: false names: description: 'An array of names with languageCode keys.' - type: string[] + type: ValueObject + required: false descriptions: description: 'An array of descriptions with languageCode keys.' - type: string[] + type: ValueObject + required: false PasswordValidationContext: description: 'Context of the password validation.' @@ -1350,6 +1695,12 @@ Plural: type: array items: any +PolicyWrapper: + description: 'JSON object with only a Policy property.' + type: object + properties: + Policy: Policy + Policy: description: 'This class represents a policy value.' type: BaseObject @@ -1363,9 +1714,13 @@ Policy: function: description: "Name of the module function Or all functions with '*' e.g. read." type: string - Limitations: + limitations: description: 'Limitations.' - type: Limitation[] + type: object + required: false + properties: + limitation: + type: Limitation[] PolicyCreateStruct: description: 'This class is used to create a policy.' @@ -1386,6 +1741,12 @@ PolicyDraft: description: 'Original policy ID the policy was created from. Used when role status is Role::STATUS_DRAFT.' type: integer +PolicyListWrapper: + description: 'JSON object with only a PolicyList property.' + type: object + properties: + PolicyList: PolicyList + PolicyList: description: 'List of policies.' type: BaseObject @@ -1412,58 +1773,79 @@ Query: description: 'This class is used to perform a Content query.' type: object properties: - filter: + Filter: description: 'The Query filter. Can contain multiple criterion, as items of a logical one (by default AND).' type: Criterion - query: + required: false + Query: description: 'The Query query. Can contain multiple criterion, as items of a logical one (by default AND).' type: Criterion + required: false sortClauses: description: 'Query sorting clauses.' type: SortClause[] + required: false facetBuilders: description: "An array of facet builders. Search engines may ignore any, or given facet builders they don't support and will just return search result facets supported by the engine. API consumer should dynamically iterate over returned facets for further use." type: FacetBuilder[] + required: false offset: description: 'Query offset. Sets the offset for search hits, used for paging the results.' type: integer + required: false limit: description: 'Query limit. Limit for number of search hits to return. If value is `0`, search query will not return any search hits, useful for doing a count.' type: integer + required: false spellcheck: description: 'If true spellcheck suggestions are returned.' type: boolean + required: false performCount: description: 'If true, search engine should perform count even if that means extra lookup.' type: boolean + required: false Ref: type: BaseObject + +RelationWrapper: + description: 'JSON object with only a Relation property.' + type: object properties: - _media-type: - type: string - _href: - type: string + Relation: Relation Relation: description: 'Class representing a relation between content.' type: BaseObject properties: - id: - description: 'ID of the relation.' - type: integer - sourceFieldDefinitionIdentifier: - description: 'Source content type Field Definition ID. For relation not of type RelationType::COMMON this field denotes the Field definition ID of the attribute where the relation is anchored.' - type: string - SourceContentInfo: + SourceContent: description: 'The content of the source content of the relation.' - type: ContentInfo - DestinationContentInfo: + type: Ref + DestinationContent: description: 'The content of the destination content of the relation.' - type: ContentInfo - type: + type: Ref + RelationType: description: 'The relation type bitmask. Relations: Relation::COMMON = 1, Relation::EMBED = 2, Relation::LINK = 4, Relation::FIELD = 8, Relation::ASSET = 16' - type: integer + type: string + +RelationCreateWrapper: + description: 'JSON object with only a RelationCreate property.' + type: object + properties: + RelationCreate: RelationCreate + +RelationCreate: + type: object + properties: + Destination: + type: Href + +RelationListWrapper: + description: 'JSON object with only a Relations property.' + type: object + properties: + Relations: RelationList RelationList: description: 'Class representing a list of relations between content.' @@ -1472,9 +1854,15 @@ RelationList: Relation: type: Relation[] +RoleWrapper: + description: 'JSON object with only a Role property.' + type: object + properties: + Role: Role + Role: description: 'This class represents a role.' - type: BaseObject + type: object properties: identifier: description: 'Readable string identifier of a role.' @@ -1483,17 +1871,30 @@ Role: description: 'Returns the list of policies of this role.' type: BaseObject +RoleAssignmentWrapper: + description: 'JSON object with only a RoleAssignment property.' + type: object + properties: + RoleAssignment: RoleAssignment + RoleAssignment: description: 'This value object represents an assignment of a User or User group to a role including a limitation.' type: BaseObject properties: - Limitation: + limitation: description: 'Returns the limitation of the role assignment.' type: RoleLimitation + required: false Role: description: 'Returns the role to which the User or User group is assigned to.' type: Ref +RoleAssignmentListWrapper: + description: 'JSON object with only a RoleAssignmentList property.' + type: object + properties: + RoleAssignmentList: RoleAssignmentList + RoleAssignmentList: description: 'This value object represents a list of assignments of a User or User group to a role including a limitation.' type: BaseObject @@ -1515,6 +1916,12 @@ RoleCreateStruct: description: 'Adds a policy to this role.' type: PolicyCreateStruct +RoleDraftWrapper: + description: 'JSON object with only a Role property.' + type: object + properties: + Role: RoleDraft + RoleDraft: description: 'This class represents a draft of a role, extends Role.' type: Role @@ -1531,6 +1938,12 @@ RoleUpdateStruct: description: 'Readable string identifier of a role.' type: string +RoleListWrapper: + description: 'JSON object with only a RoleList property.' + type: object + properties: + RoleList: RoleList + RoleList: description: 'This class represents a list roles.' type: BaseObject @@ -1538,6 +1951,12 @@ RoleList: Role: type: Role[] +RootWrapper: + description: 'JSON object with only a Root property.' + type: object + properties: + Root: Root + Root: description: 'This class represents a root.' type: BaseObject @@ -1566,15 +1985,19 @@ Root: usersByRoleId: description: 'Users by Role ID.' type: BaseObject + required: false usersByRemoteId: description: 'Users by remote ID.' type: BaseObject + required: false usersByEmail: description: 'Users by e-mail.' type: BaseObject + required: false usersByLogin: description: 'Users by login.' type: BaseObject + required: false roles: description: 'Roles.' type: BaseObject @@ -1632,6 +2055,12 @@ SearchResult: description: 'The value objects found for the query.' type: URL[] +SectionWrapper: + description: 'JSON object with only a Section property.' + type: object + properties: + Section: Section + Section: description: 'This class represents a Section.' type: BaseObject @@ -1646,8 +2075,19 @@ Section: description: 'Name of the Section.' type: string +SectionInputWrapper: + description: 'JSON object with only a SectionInput property.' + type: object + properties: + SectionInput: SectionInput + SectionInput: - type: BaseObject + type: object + properties: + identifier: + type: string + name: + type: string SectionCreateStruct: description: 'This class represents a Section.' @@ -1656,6 +2096,12 @@ SectionCreateStruct: SectionLimitation: type: RoleLimitation +SectionListWrapper: + description: 'JSON object with only a SectionList property.' + type: object + properties: + SectionList: SectionList + SectionList: description: 'This class represents a Section list.' type: BaseObject @@ -1678,9 +2124,15 @@ SectionUpdateStruct: description: 'This class is used to provide data for updating a Section. At least one property has to be set.' type: object +SessionWrapper: + description: 'JSON object with only a Session property.' + type: object + properties: + Session: Session + Session: description: 'Value for session.' - type: BaseObject + type: object properties: name: description: 'Name.' @@ -1695,12 +2147,24 @@ Session: description: 'User.' type: BaseObject +SegmentGroupListWrapper: + description: 'JSON object with only a SegmentGroupList property.' + type: object + properties: + SegmentGroupList: SegmentGroupList + SegmentGroupList: description: 'This class lists segment groups.' type: BaseObject properties: SegmentGroup: SegmentGroup[] +SegmentGroupWrapper: + description: 'JSON object with only a SegmentGroup property.' + type: object + properties: + SegmentGroup: SegmentGroup + SegmentGroup: description: 'This class represents a segment group.' type: BaseObject @@ -1709,12 +2173,24 @@ SegmentGroup: identifier: string name: string +SegmentListWrapper: + description: 'JSON object with only a SegmentList property.' + type: object + properties: + SegmentList: SegmentList + SegmentList: description: 'This class lists segments.' type: BaseObject properties: Segment: Segment[] +SegmentWrapper: + description: 'JSON object with only a Segment property.' + type: object + properties: + Segment: Segment + Segment: description: 'This class represents a segment.' type: BaseObject @@ -1755,16 +2231,22 @@ Specifications: description: 'Limitation on the number of items as the value. Only usable if {@see $valueFormat} is {@see self::FORMAT_ARRAY}.' type: integer +StringLengthValidatorWrapper: + description: 'JSON object with only a StringLengthValidator property.' + type: object + properties: + StringLengthValidator: StringLengthValidator + StringLengthValidator: description: 'Validator for checking min. and max. length of strings.' type: object properties: maxStringLength: description: 'Maximum length of strings.' - type: integer + type: integer | nil minStringLength: description: 'Minimum length of strings.' - type: integer + type: integer | nil SubtreeLimitation: type: RoleLimitation @@ -1777,12 +2259,24 @@ Translation: description: 'Base class for translation messages extends ValueObject.' type: object +TrashWrapper: + description: 'JSON object with only a Trash property.' + type: object + properties: + Trash: Trash + Trash: type: BaseObject properties: TrashItem: type: TrashItem[] +TrashItemWrapper: + description: 'JSON object with only a TrashItem property.' + type: object + properties: + TrashItem: TrashItem + TrashItem: description: 'This class represents a trash item, which is actually a trashed Location.' type: Location @@ -1794,7 +2288,7 @@ Unlink: _href: type: string _method: - enum: [ ] + enum: [ "DELETE" ] URL: description: 'This class represents a URL in the Repository.' @@ -1819,8 +2313,38 @@ URL: description: 'Modified date.' type: datetime +UrlAliasCreateWrapper: + description: 'JSON object with only a UrlAliasCreate property.' + type: object + properties: + UrlAliasCreate: UrlAliasCreate + UrlAliasCreate: - type: BaseObject + type: object + properties: + _type: + type: string + location: + type: Href + required: false + resource: + type: string + required: false + languageCode: + type: string + required: false + alwaysAvailable: + type: string | boolean + required: false + forward: + type: string | boolean + required: false + +UrlAliasWrapper: + description: 'JSON object with only a UrlAlias property.' + type: object + properties: + UrlAlias: UrlAlias UrlAlias: description: 'This class represents a URL alias in the Repository.' @@ -1828,10 +2352,16 @@ UrlAlias: properties: _id: description: 'A unique identifier for the alias.' - type: integer + type: string + xml: + attribute: true + name: id _type: description: 'The type of the URL Alias i.e. one of URLAlias::LOCATION=0, URLAlias::RESOURCE=1, URLAlias::VIRTUAL=2.' - enum: [ ] + enum: [ "LOCATION", "RESOURCE", "VIRTUAL" ] + xml: + attribute: true + name: type resource: description: 'If type = URLAlias::LOCATION it is a Location ID otherwise a string (e.g. /content/search).' type: any @@ -1840,7 +2370,7 @@ UrlAlias: type: string languageCodes: description: 'The languageCodes for which this path is valid.' - type: string[] + type: string alwaysAvailable: description: 'Fallback indicator for other languages.' type: boolean @@ -1854,12 +2384,18 @@ UrlAlias: description: 'If false this alias was autogenerated otherwise manually created.' type: boolean +UrlAliasRefListWrapper: + description: 'JSON object with only a UrlAliasRefList property.' + type: object + properties: + UrlAliasRefList: UrlAliasRefList + UrlAliasRefList: description: 'List of URL alias in the Repository.' type: BaseObject properties: UrlAlias: - type: UrlAlias[] + type: Ref[] UrlQuery: description: 'This class is used to perform a URL query.' @@ -1903,13 +2439,22 @@ URLUpdateStruct: description: 'Modified date.' type: datetime +UrlWildcardWrapper: + description: 'JSON object with only a UrlWildcard property.' + type: object + properties: + UrlWildcard: UrlWildcard + UrlWildcard: description: 'This class represents a URL alias in the Repository.' type: BaseObject properties: - id: + _id: description: 'The unique ID.' type: integer + xml: + attribute: true + name: id sourceUrl: description: 'The source URL.' type: string @@ -1920,9 +2465,28 @@ UrlWildcard: description: 'Indicates if the URL is redirected or not.' type: boolean +UrlWildcardCreateWrapper: + description: 'JSON object with only a URLWildcardCreate property.' + type: object + properties: + URLWildcardCreate: UrlWildcardCreate + UrlWildcardCreate: description: 'Creates a new URL wildcard.' - type: BaseObject + type: object + properties: + sourceUrl: + type: string + destinationUrl: + type: string + forward: + type: boolean | string + +UrlWildcardListWrapper: + description: 'JSON object with only a UrlWildcardList property.' + type: object + properties: + UrlWildcardList: UrlWildcardList UrlWildcardList: description: 'List of URL alias in the Repository.' @@ -1942,16 +2506,28 @@ URLWildcardTranslationResult: description: 'Indicates if the URL is redirected or not.' type: boolean +UserWrapper: + description: 'JSON object with only a User property.' + type: object + properties: + User: User + User: description: 'This class represents a User value.' type: BaseObject properties: - id: + _id: description: 'Unique ID of the content type.' type: integer - remoteId: + xml: + attribute: true + name: id + _remoteId: description: 'Remote ID of the content type.' type: string + xml: + attribute: true + name: remoteId ContentType: description: 'This class represents a content type.' type: BaseObject @@ -2006,9 +2582,10 @@ User: Roles: description: 'Roles.' type: BaseObject -# maxLogin: -# description: 'Max number of time User is allowed to login.' -# type: integer + maxLogin: + description: 'Max number of time User is allowed to login.' + type: integer + required: false UserCreateStruct: description: 'This class is used to create a new User in the Repository.' @@ -2030,54 +2607,146 @@ UserCreateStruct: description: 'Indicates if the User is enabled after creation.' type: boolean -UserGroup: - description: 'This class represents a User group.' - type: BaseObject - properties: - Unassign: - type: Unlink - -UserGroupCreateStruct: - description: 'This class is used to create a new User group in the Repository, extends ContentCreateStruct.' - type: object - -UserGroupRefList: - description: 'Returns a list of the sub groups.' - type: BaseObject - properties: - UserGroup: - description: 'This class represents a User group.' - type: UserGroup - -UserGroupRoleAssignment: - description: 'This class represents a User group to role assignment.' - type: object - properties: - UserGroup: - description: 'Returns the User group to which the role is assigned to.' - type: UserGroup - -UserGroupUpdate: - description: 'This class is used to update a User group in the Repository.' - type: BaseObject - -UserGroupUpdateStruct: - description: 'This class is used to update a User group in the Repository.' +UserGroupWrapper: + description: 'JSON object with only a UserGroup property.' type: object properties: - contentUpdateStruct: - description: 'The update structure for the profile content.' - type: ContentUpdateStruct - contentMetadataUpdateStruct: - description: 'The update structure for the profile meta data.' - type: ContentMetadataUpdateStruct + UserGroup: UserGroup -UserGroupList: - description: 'This class represents a User Group list.' - type: BaseObject - -UserList: - description: 'This class represents a list of users.' +UserGroup: + description: 'Content ID matcher class.' + type: BaseObject + properties: + _remoteId: + description: 'Remote ID of the content type.' + type: string + xml: + attribute: true + name: remoteId + _id: + description: 'Unique ID of the content type.' + type: integer + xml: + attribute: true + name: id + ContentType: + description: 'Content type.' + type: Ref + name: + type: string + Versions: + description: 'Returns the VersionInfo for this version.' + type: Ref + Section: + description: 'The Section to which the content item is assigned to.' + type: Ref + MainLocation: + type: Ref + Locations: + description: 'Location of the content item.' + type: Ref + Owner: + description: 'The owner of the content item.' + type: Ref + lastModificationDate: + description: 'Content item modification date.' + type: datetime + mainLanguageCode: + description: 'The main language code of the content item.' + type: string + alwaysAvailable: + type: boolean + Version: + type: Version + ParentUserGroup: + type: Ref + Subgroups: + type: Ref + Users: + type: Ref + Roles: + type: Ref + +UserGroupUnassign: + description: 'This class represents a User group.' + type: BaseObject + properties: + Unassign: + type: Unlink + +UserGroupCreateStruct: + description: 'This class is used to create a new User group in the Repository, extends ContentCreateStruct.' + type: object + +UserGroupRefListWrapper: + description: 'JSON object with only a UserGroupRefList property.' + type: object + properties: + UserGroupRefList: UserGroupRefList + +UserGroupRefList: + description: 'Returns a list of the sub groups.' + type: BaseObject + properties: + UserGroup: + description: 'This class represents a User group.' + type: Ref[] + +UserGroupRoleAssignment: + description: 'This class represents a User group to role assignment.' + type: object + properties: + UserGroup: + description: 'Returns the User group to which the role is assigned to.' + type: UserGroup + +UserGroupUpdateWrapper: + description: 'JSON object with only a UserGroupUpdate property.' + type: object + properties: + UserGroupUpdate: UserGroupUpdate + +UserGroupUpdate: + description: 'This class is used to update a User group in the Repository.' + type: object + properties: + Section: + properties: + _href: + type: string + xml: + attribute: true + name: href + +UserGroupUpdateStruct: + description: 'This class is used to update a User group in the Repository.' + type: object + properties: + contentUpdateStruct: + description: 'The update structure for the profile content.' + type: ContentUpdateStruct + contentMetadataUpdateStruct: + description: 'The update structure for the profile meta data.' + type: ContentMetadataUpdateStruct + +UserGroupListWrapper: + description: 'JSON object with only a UserGroupList property.' + type: object + properties: + UserGroupList: UserGroupList + +UserGroupList: + description: 'This class represents a User Group list.' + type: BaseObject + +UserListWrapper: + description: 'JSON object with only a UserList property.' + type: object + properties: + UserList: UserList + +UserList: + description: 'This class represents a list of users.' type: BaseObject properties: User: @@ -2116,6 +2785,12 @@ UserPreferenceSetStruct: description: 'Value of User preference e.g. America/New_York.' type: string +UserRefListWrapper: + description: 'JSON object with only a UserRefList property.' + type: object + properties: + UserRefList: UserRefList + UserRefList: description: 'Returns a list of the users.' type: BaseObject @@ -2166,6 +2841,16 @@ UserUpdateStruct: description: 'The update structure for the profile meta data.' type: ContentMetadataUpdateStruct +ValueArray: + properties: + value: Value[] + +ValueObject: + type: object + properties: + value: + type: Value[] + Value: description: 'Struct that stores extra value information for a Criterion object.' type: object @@ -2175,16 +2860,13 @@ Value: type: string '#text': description: 'Content type description.' - type: string + type: string | nil -ValueObject: - description: 'The base class for all value objects and structs. Supports readonly properties by marking them as protected.' +VersionWrapper: + description: 'JSON object with only a Version property.' type: object properties: - Properties: - description: 'Function where list of properties are returned.' - type: array - items: any + Version: Version Version: description: 'Returns the VersionInfo for this version.' @@ -2194,8 +2876,10 @@ Version: description: 'VersionInfo for this version.' type: VersionInfo Fields: - description: 'Fields.' - type: Field + properties: + field: + description: 'Fields of a Company content item.' + type: Field[] Relations: description: 'Relations of the user.' type: BaseObject @@ -2215,7 +2899,7 @@ VersionInfo: type: integer status: description: 'One of: VersionInfo::STATUS_DRAFT=0, VersionInfo::STATUS_PUBLISHED=1, VersionInfo::STATUS_ARCHIVED=3.' - enum: [ ] + enum: [DRAFT, PUBLISHED, ARCHIVED] modificationDate: description: 'The last modified date of this version.' type: datetime @@ -2230,20 +2914,20 @@ VersionInfo: type: string languageCodes: description: 'List of languages in this version. Reflects which languages fields exists in for this version.' - type: string[] + type: string VersionTranslationInfo: description: 'Translation information.' type: VersionTranslationInfo names: description: 'Names.' - type: Value + type: ValueArray Content: description: 'Represents a content item in a specific version.' type: BaseObject VersionItem: description: 'Version of content.' - type: BaseObject + type: object properties: Version: description: 'Returns the VersionInfo for this version.' @@ -2251,6 +2935,12 @@ VersionItem: VersionInfo: type: VersionInfo +VersionListWrapper: + description: 'JSON object with only a VersionList property.' + type: object + properties: + VersionList: VersionList + VersionList: description: 'List of all versions of the content.' type: BaseObject @@ -2267,6 +2957,12 @@ VersionTranslationInfo: Language: type: LanguageCode[] +VersionUpdateWrapper: + description: 'JSON object with only a VersionUpdate property.' + type: object + properties: + VersionUpdate: VersionUpdate + VersionUpdate: description: 'This class is used to update a content version.' type: BaseObject @@ -2294,9 +2990,15 @@ View: #TODO outdated example Result: type: object +ContentTypeCreateWrapper: + description: 'JSON object with only a ContentTypeCreate property.' + type: object + properties: + ContentTypeCreate: ContentTypeCreate + ContentTypeCreate: description: 'This class is used to create a content type.' - type: BaseObject + type: object properties: identifier: type: string @@ -2319,64 +3021,104 @@ ContentTypeCreate: defaultAlwaysAvailable: type: boolean names: - type: Value[] + type: ValueObject descriptions: - type: Value[] + type: ValueObject FieldDefinition: type: FieldDefinition + required: false creatorId: description: 'If set, this value overrides the current user as creator.' type: any + required: false creationDate: type: datetime + required: false + +ContentTypeUpdateWrapper: + description: 'JSON object with only a ContentTypeUpdate property.' + type: object + properties: + ContentTypeUpdate: ContentTypeUpdate ContentTypeUpdate: description: 'This class is used to update a content type.' - type: BaseObject + type: object properties: identifier: type: string + required: false mainLanguageCode: type: string + required: false remoteId: type: string + required: false urlAliasSchema: - type: string + type: string | nil + required: false nameSchema: type: string + required: false isContainer: type: boolean + required: false defaultSortField: description: 'Specifies which property the child Locations should be sorted on by default when updated.' type: any + required: false defaultSortOrder: description: 'Specifies whether the sort order should be ascending or descending by default when updated.' type: any + required: false defaultAlwaysAvailable: - type: boolean + type: string | boolean + required: false names: - type: Value[] + type: ValueObject + required: false descriptions: - type: Value[] + type: ValueObject + required: false modifierId: description: 'If set, this value overrides the current user as creator.' type: any + required: false modificationDate: type: datetime + required: false + +ViewInputWrapper: + description: 'JSON object with only a ViewInput property.' + type: object + properties: + ViewInput: ViewInput ViewInput: description: 'This class represents a View input.' - type: BaseObject + type: object properties: identifier: description: 'Content identifier.' type: string - FilterQuery: - type: object + languageCode: + type: string + required: false + useAlwaysAvailable: + type: string + required: false + Query: + type: Query + +UserCreateWrapper: + description: 'JSON object with only a UserCreate property.' + type: object + properties: + UserCreate: UserCreate UserCreate: description: 'This class is used to create a User.' - type: BaseObject + type: object properties: mainLanguageCode: type: string @@ -2390,60 +3132,94 @@ UserCreate: type: string enabled: type: boolean + required: false + +UserGroupCreateWrapper: + description: 'JSON object with only a UserGroupCreate property.' + type: object + properties: + UserGroupCreate: UserGroupCreate UserGroupCreate: description: 'This class is used to create a User Group.' - type: BaseObject + type: object properties: mainLanguageCode: type: string remoteId: type: string fields: - type: Field[] + type: Fields + +RoleAssignInputWrapper: + description: 'JSON object with only a RoleAssignInput property.' + type: object + properties: + RoleAssignInput: RoleAssignInput RoleAssignInput: description: 'This class represents a Role assign input.' - type: BaseObject + type: object properties: - id: - description: 'The unique ID of the Role assignment.' - type: integer Role: description: 'Returns the Role to which the user or user group is assigned to.' - type: Role - Limitation: + type: Ref + limitation: description: 'Returns the Limitation of the Role assignment.' type: Limitation +UserUpdateWrapper: + description: 'JSON object with only a UserUpdate property.' + type: object + properties: + UserUpdate: UserUpdate + UserUpdate: description: 'This class is used to update a User.' - type: BaseObject + type: object properties: login: type: string email: type: string + required: false password: type: string + required: false enabled: type: boolean + required: false maxLogin: type: integer + required: false ContentUpdate: description: 'The update structure for the profile content.' type: ContentUpdate + required: false ContentMetadataUpdate: description: 'The update structure for the profile metadata.' type: ContentMetadataUpdate + required: false + +RoleInputWrapper: + description: 'JSON object with only a RoleInput property.' + type: object + properties: + RoleInput: RoleInput RoleInput: description: 'This class represents a Role input.' - type: BaseObject + type: object properties: identifier: type: string +PolicyCreateWrapper: + description: 'JSON object with only a PolicyCreate property.' + type: object + properties: + PolicyCreate: PolicyCreate + PolicyCreate: description: 'This class is used to create a Policy.' type: BaseObject @@ -2457,6 +3233,12 @@ PolicyCreate: Limitations: type: Limitation[] +PolicyUpdateWrapper: + description: 'JSON object with only a PolicyUpdate property.' + type: object + properties: + PolicyUpdate: PolicyUpdate + PolicyUpdate: description: 'This class is used to update a Policy.' type: BaseObject @@ -2464,9 +3246,15 @@ PolicyUpdate: Limitations: type: Limitation[] +SessionInputWrapper: + description: 'JSON object with only a SessionInput property.' + type: object + properties: + SessionInput: SessionInput + SessionInput: description: 'This class represents a session input.' - type: BaseObject + type: object properties: login: type: string @@ -2477,13 +3265,33 @@ BaseCommerceResponse: description: 'Removed' type: object +BasketWrapper: + description: 'JSON object with only a Basket property.' + type: object + properties: + Basket: Basket + Basket: description: 'Removed' type: BaseCommerceResponse +BasketLineDataWrapper: + description: 'JSON object with only a BasketLineData property.' + type: object + properties: + BasketLineData: BasketLineData + BasketLineData: description: 'Removed' + type: array + items: + type: object + +PartyTypeInputWrapper: + description: 'JSON object with only a PartyData property.' type: object + properties: + PartyData: PartyTypeInput PartyTypeInput: description: 'Removed' @@ -2493,26 +3301,62 @@ Party: description: 'Removed' type: object +ShippingMethodDataResponseWrapper: + description: 'JSON object with only a ShippingMethodDataResponse property.' + type: object + properties: + ShippingMethodDataResponse: ShippingMethodDataResponse + ShippingMethodDataResponse: description: 'Removed' type: BaseCommerceResponse +PaymentMethodDataResponseWrapper: + description: 'JSON object with only a PaymentMethodDataResponse property.' + type: object + properties: + PaymentMethodDataResponse: PaymentMethodDataResponse + PaymentMethodDataResponse: description: 'Removed' type: BaseCommerceResponse +ShippingAddressesResponseWrapper: + description: 'JSON object with only a ShippingAddressesResponse property.' + type: object + properties: + ShippingAddressesResponse: ShippingAddressesResponse + ShippingAddressesResponse: description: 'Removed' type: BaseCommerceResponse +BasketListResponseWrapper: + description: 'JSON object with only a BasketListResponse property.' + type: object + properties: + BasketListResponse: BasketListResponse + BasketListResponse: description: 'Removed' type: BaseCommerceResponse +ValidationResponseWrapper: + description: 'JSON object with only a ValidationResponse property.' + type: object + properties: + ValidationResponse: ValidationResponse + ValidationResponse: description: 'Removed' type: BaseCommerceResponse +CountrySelectionResponseWrapper: + description: 'JSON object with only a CountrySelectionResponse property.' + type: object + properties: + CountrySelectionResponse: CountrySelectionResponse + CountrySelectionResponse: description: 'Removed' type: BaseCommerceResponse @@ -2521,18 +3365,41 @@ ShippingMethodData: description: 'Removed' type: object +PaymentMethodDataWrapper: + description: 'JSON object with only a PaymentMethodData property.' + type: object + properties: + PaymentMethodData: PaymentMethodData + PaymentMethodData: description: 'Removed' type: object +VoucherDataWrapper: + description: 'JSON object with only a VoucherData property.' + type: object + properties: + VoucherData: VoucherData + VoucherData: description: 'Removed' type: object +CustomerPriceDataWrapper: + type: object + properties: + PriceResponse: CustomerPriceData + CustomerPriceData: description: 'Removed' type: object +BasketHeaderDataWrapper: + description: 'JSON object with only a BasketHeaderData property.' + type: object + properties: + BasketHeaderData: BasketHeaderData + BasketHeaderData: description: 'Removed' type: object @@ -2541,10 +3408,22 @@ BasketLinesData: description: 'Removed' type: object +PriceResponseWrapper: + description: 'JSON object with only a PriceResponse property.' + type: object + properties: + PriceResponse: PriceResponse + PriceResponse: description: 'Removed' type: BaseCommerceResponse +CartWrapper: + description: 'JSON object with only a Cart property.' + type: object + properties: + Cart: Cart + Cart: description: 'This class represents a Cart' type: object @@ -2557,12 +3436,18 @@ Cart: type: string owner: description: 'User reference' - type: User + type: Ref Currency: type: Currency entries: type: CartEntry[] +CartCreateWrapper: + description: 'JSON object with only a CartCreate property.' + type: object + properties: + CartCreate: CartCreate + CartCreate: description: 'This class represents a new Cart to create' type: object @@ -2589,6 +3474,12 @@ CartEntry: quantity: integer Price: Price +CartEntryUpdateWrapper: + description: 'JSON object with only a CartEntryUpdate property.' + type: object + properties: + CartEntryUpdate: CartEntryUpdate + CartEntryUpdate: type: object properties: @@ -2598,6 +3489,12 @@ CartEntryUpdate: type: object required: false +CartEntryAddWrapper: + description: 'JSON object with only a CartEntryAdd property.' + type: object + properties: + CartEntryAdd: CartEntryAdd + CartEntryAdd: description: 'This class represents a cart entry' type: object @@ -2624,6 +3521,12 @@ CartProduct: type: string required: true +CartSummaryWrapper: + description: 'JSON object with only a CartSummary property.' + type: object + properties: + CartSummary: CartSummary + CartSummary: description: 'This class represents a cart summary.' type: object @@ -2639,18 +3542,24 @@ CartSummary: updatedAt: type: datetime Owner: - type: User + type: Ref SummaryEntryCollection: type: SummaryEntryCollection TotalPrice: - type: Price + type: RestPriceWrapper TotalPriceInclVat: - type: Price + type: RestPriceWrapper vatCategorySummary: - type: VatCategorySummary + type: VatCategorySummary[] Currency: type: Currency +CartViewInputWrapper: + description: 'JSON object with only a CartViewInput property.' + type: object + properties: + CartViewInput: CartViewInput + CartViewInput: description: 'This class represents a cart view input.' type: object @@ -2667,20 +3576,34 @@ CartQuery: limit: integer ownerId: integer +CartViewWrapper: + description: 'JSON object with only a CartView property.' + type: object + properties: + CartView: CartView + CartView: description: 'This class represents a cart view.' type: object properties: identifier: string - Result: ViewResult + Result: CartListViewResult -ViewResult: +CartListViewResult: type: object properties: count: integer Result: CartList -CartList: object +CartList: + description: 'This class represents a cart list.' + type: object + +CartMetadataUpdateWrapper: + description: 'JSON object with only a CartMetadataUpdate property.' + type: object + properties: + CartMetadataUpdate: CartMetadataUpdate CartMetadataUpdate: description: 'This class represents the update of cart metadata.' @@ -2691,6 +3614,12 @@ CartMetadataUpdate: names: Value[] descriptions: Value[] +CatalogWrapper: + description: 'JSON object with only a Catalog property.' + type: object + properties: + Catalog: Catalog + Catalog: description: 'This class represents a catalog.' type: object @@ -2708,33 +3637,47 @@ Catalog: status: type: string User: - type: User + type: Ref Criteria: - type: Criterion + type: Criterion[] CatalogList: description: 'This class represents a catalog list.' type: object properties: - Catalogs: + Catalog: type: Catalog[] +CatalogCreateWrapper: + description: 'JSON object with only a CatalogCreate property.' + type: object + properties: + CatalogCreate: CatalogCreate + CatalogCreate: description: 'This class is used to create a catalog.' type: object properties: identifier: type: string - Criteria: + criteria: type: Criterion names: type: object descriptions: type: object + required: false status: type: string creator_id: type: integer + required: false + +CatalogUpdateWrapper: + description: 'JSON object with only a CatalogUpdate property.' + type: object + properties: + CatalogUpdate: CatalogUpdate CatalogUpdate: description: 'This class is used to update a catalog.' @@ -2744,13 +3687,19 @@ CatalogUpdate: type: string transition: type: string - Criteria: + criteria: type: Criterion names: type: object descriptions: type: object +CatalogCopyWrapper: + description: 'JSON object with only a CatalogCopy property.' + type: object + properties: + CatalogCopy: CatalogCopy + CatalogCopy: description: 'This class is used to copy a catalog.' type: object @@ -2761,18 +3710,32 @@ CatalogCopy: description: 'Optional' type: integer +CatalogViewInputWrapper: + description: 'JSON object with only a ViewInput property.' + type: object + properties: + ViewInput: CatalogViewInput + CatalogViewInput: description: 'This class represents a catalog view input.' type: object properties: CatalogQuery: type: object + xml: + name: ViewInput + +ProductFilterListWrapper: + description: 'JSON object with only a ProductFilterList property.' + type: object + properties: + ProductFilterList: ProductFilterList ProductFilterList: description: 'This class represents a product filter list.' type: object properties: - productFilters: + ProductFilter: type: ProductFilter[] ProductFilter: @@ -2786,16 +3749,28 @@ ProductSortClause: name: type: string +ProductSortClauseListWrapper: + description: 'JSON object with only a ProductSortClauseList property.' + type: object + properties: + ProductSortClauseList: ProductSortClauseList + ProductSortClauseList: description: 'This class represents a product sort clause list.' type: object properties: - productSortClauses: + ProductSortClause: type: ProductSortClause[] +CurrencyWrapper: + description: 'JSON object with only a Currency property.' + type: object + properties: + Currency: Currency + Currency: description: 'This class represents currency.' - type: object + type: BaseObject properties: id: type: integer @@ -2806,13 +3781,25 @@ Currency: enabled: type: boolean +CurrencyListWrapper: + description: 'JSON object with only a CurrencyList property.' + type: object + properties: + CurrencyList: CurrencyList + CurrencyList: description: 'This class represents a currency list.' - type: object + type: BaseObject properties: - Currencies: + Currency: type: Currency[] +CurrencyCreateWrapper: + description: 'JSON object with only a CurrencyCreate property.' + type: object + properties: + CurrencyCreate: CurrencyCreate + CurrencyCreate: description: 'This class is used to create currency.' type: object @@ -2824,6 +3811,12 @@ CurrencyCreate: enabled: type: boolean +CurrencyUpdateWrapper: + description: 'JSON object with only a CurrencyUpdate property.' + type: object + properties: + CurrencyUpdate: CurrencyUpdate + CurrencyUpdate: description: 'This class is used to update currency.' type: object @@ -2833,6 +3826,12 @@ CurrencyUpdate: enabled: type: boolean +CurrencyViewWrapper: + description: 'JSON object with only a CurrencyView property.' + type: object + properties: + CurrencyView: CurrencyView + CurrencyView: description: 'This class represents a currency view.' type: object @@ -2844,6 +3843,12 @@ CurrencyView: Result: type: object +RegionWrapper: + description: 'JSON object with only a Region property.' + type: object + properties: + Region: Region + Region: description: 'This class represents a region.' type: object @@ -2851,12 +3856,24 @@ Region: identifier: type: string +RegionListWrapper: + description: 'JSON object with only a RegionList property.' + type: object + properties: + RegionList: RegionList + RegionList: description: 'This class represents a region list.' type: object properties: - Regions: - type: Region[] + Region: + type: Ref[] + +AttributeGroupWrapper: + description: 'JSON object with only a AttributeGroup property.' + type: object + properties: + AttributeGroup: AttributeGroup AttributeGroup: description: 'This class represents an attribute group.' @@ -2869,12 +3886,24 @@ AttributeGroup: position: type: integer +AttributeGroupGetWrapper: + description: 'JSON object with only a AttributeGroupGet property.' + type: object + properties: + AttributeGroupGet: AttributeGroupGet + AttributeGroupGet: description: 'This class represents an attribute group query.' type: object properties: languages: string[] +AttributeGroupCreateWrapper: + description: 'JSON object with only a AttributeGroupCreate property.' + type: object + properties: + AttributeGroupCreate: AttributeGroupCreate + AttributeGroupCreate: description: 'This class is used to create an attribute group.' type: object @@ -2882,10 +3911,16 @@ AttributeGroupCreate: identifier: type: string names: - type: string[] + type: object position: type: integer +AttributeGroupUpdateWrapper: + description: 'JSON object with only a AttributeGroupUpdate property.' + type: object + properties: + AttributeGroupUpdate: AttributeGroupUpdate + AttributeGroupUpdate: description: 'This class is used to update an attribute group.' type: object @@ -2897,11 +3932,23 @@ AttributeGroupUpdate: position: type: integer +AttributeGroupListWrapper: + description: 'JSON object with only a AttributeGroupList property.' + type: object + properties: + AttributeGroupList: AttributeGroupList + AttributeGroupList: description: 'This class represents an attribute group list.' + type: BaseObject + properties: + AttributeGroup: AttributeGroup[] + +AttributeGroupListGetWrapper: + description: 'JSON object with only a AttributeGroupListGet property.' type: object properties: - attributeGroups: AttributeGroup[] + AttributeGroupListGet: AttributeGroupListGet AttributeGroupListGet: description: 'This class represents an attribute group list request.' @@ -2911,6 +3958,12 @@ AttributeGroupListGet: offset: integer limit: integer +AttributeGroupViewInputWrapper: + description: 'JSON object with only a ViewInput property.' + type: object + properties: + ViewInput: AttributeGroupViewInput + AttributeGroupViewInput: description: 'This class represents an attribute group view input.' type: object @@ -2919,18 +3972,38 @@ AttributeGroupViewInput: AttributeGroupQuery: type: object properties: - limit: integer - offset: integer + limit: string + offset: string name_prefix: string + xml: + name: ViewInput + +AttributeGroupViewWrapper: + description: 'JSON object with only a AttributeGroupView property.' + type: object + properties: + AttributeGroupView: AttributeGroupView AttributeGroupView: description: 'This class represents an attribute group view.' - type: object + type: BaseObject properties: identifier: type: string - AttributeGroupList: - type: AttributeGroupList + Result: + type: AttributeGroupListResult + +AttributeGroupListResult: + type: BaseObject + properties: + count: integer + AttributeGroupList: AttributeGroupList + +AttributeWrapper: + description: 'JSON object with only a Attribute property.' + type: object + properties: + Attribute: Attribute Attribute: description: 'This class represents an attribute.' @@ -2947,13 +4020,19 @@ Attribute: type_identifier: type: string value: - type: boolean - Group: - type: AttributeGroup + type: any + group: + type: string position: type: integer options: - type: object + type: object | array + +AttributeCreateWrapper: + description: 'JSON object with only a AttributeCreate property.' + type: object + properties: + AttributeCreate: AttributeCreate AttributeCreate: description: 'This class is used to create an attribute.' @@ -2969,11 +4048,16 @@ AttributeCreate: type: object descriptions: type: object - positions: + position: type: integer options: - type: array - items: any + type: object | array + +AttributeUpdateWrapper: + description: 'JSON object with only a AttributeUpdate property.' + type: object + properties: + AttributeUpdate: AttributeUpdate AttributeUpdate: description: 'This class is used to update an attribute.' @@ -2985,17 +4069,28 @@ AttributeUpdate: type: object descriptions: type: object - positions: + position: type: integer options: - type: array - items: any + type: object + +AttributeListWrapper: + description: 'JSON object with only a AttributeList property.' + type: object + properties: + AttributeList: AttributeList AttributeList: description: 'This class represents an attribute list.' type: object properties: - attributes: Attribute[] + Attribute: Attribute[] + +AttributeViewInputWrapper: + description: 'JSON object with only a ViewInput property.' + type: object + properties: + ViewInput: AttributeViewInput AttributeViewInput: description: 'This class represents an attribute view input.' @@ -3005,6 +4100,14 @@ AttributeViewInput: type: string AttributeQuery: type: object + xml: + name: ViewInput + +AttributeViewWrapper: + description: 'JSON object with only a AttributeView property.' + type: object + properties: + AttributeView: AttributeView AttributeView: description: 'This class represents an attribute view.' @@ -3017,6 +4120,12 @@ AttributeView: Result: type: object +AttributeTypeWrapper: + description: 'JSON object with only a AttributeType property.' + type: object + properties: + AttributeType: AttributeType + AttributeType: description: 'This class represents an attribute type.' type: object @@ -3026,6 +4135,12 @@ AttributeType: name: type: string +AttributeTypeListWrapper: + description: 'JSON object with only a AttributeTypeList property.' + type: object + properties: + AttributeTypeList: AttributeTypeList + AttributeTypeList: description: 'This class represents an attribute type list.' type: object @@ -3033,6 +4148,12 @@ AttributeTypeList: attributeTypes: type: AttributeType[] +CustomerGroupWrapper: + description: 'JSON object with only a CustomerGroup property.' + type: object + properties: + CustomerGroup: CustomerGroup + CustomerGroup: description: 'This class represents a customer group.' type: object @@ -3052,13 +4173,25 @@ CustomerGroup: description: 'A numeric string' type: string +CustomerGroupListWrapper: + description: 'JSON object with only a CustomerGroupList property.' + type: object + properties: + CustomerGroupList: CustomerGroupList + CustomerGroupList: description: 'This class represents a customer group list.' type: object properties: - customerGroups: + CustomerGroup: type: CustomerGroup[] +CustomerGroupCreateWrapper: + description: 'JSON object with only a CustomerGroupCreate property.' + type: object + properties: + CustomerGroupCreate: CustomerGroupCreate + CustomerGroupCreate: description: 'This class is used to create a customer group.' type: object @@ -3073,6 +4206,12 @@ CustomerGroupCreate: description: 'numeric-string' type: string +CustomerGroupUpdateWrapper: + description: 'JSON object with only a CustomerGroupUpdate property.' + type: object + properties: + CustomerGroupUpdate: CustomerGroupUpdate + CustomerGroupUpdate: description: 'This class is used to update a customer group.' type: object @@ -3081,8 +4220,17 @@ CustomerGroupUpdate: type: object identifier: type: string - position: - type: integer + global_price_rate: + type: string + descriptions: + type: string[] + required: false + +CustomerGroupViewInputWrapper: + description: 'JSON object with only a ViewInput property.' + type: object + properties: + ViewInput: CustomerGroupViewInput CustomerGroupViewInput: description: 'This class represents a customer group view input.' @@ -3090,19 +4238,39 @@ CustomerGroupViewInput: properties: CustomerGroupQuery: type: object + xml: + name: ViewInput + +CustomerGroupViewWrapper: + description: 'JSON object with only a CustomerGroupView property.' + type: object + properties: + CustomerGroupView: CustomerGroupView CustomerGroupView: description: 'This class represents a customer group view.' type: object properties: - CurrencyView: - type: CurrencyView identifier: type: string - CurrencyQuery: + CustomerGroupQuery: type: object Result: - type: object + type: CustomerGroupListResult + +CustomerGroupListResult: + type: BaseObject + properties: + CustomerGroupList: + type: BaseObject + properties: + CustomerGroup: CustomerGroup[] + +CurrencyViewInputWrapper: + description: 'JSON object with only a ViewInput property.' + type: object + properties: + ViewInput: CurrencyViewInput CurrencyViewInput: description: 'This class represents a currency view input.' @@ -3110,6 +4278,8 @@ CurrencyViewInput: properties: CurrencyQuery: type: object + xml: + name: ViewInput AttributeAssignment: type: object @@ -3121,6 +4291,12 @@ AttributeAssignment: Attribute: type: Attribute +ProductTypeWrapper: + description: 'JSON object with only a ProductType property.' + type: object + properties: + ProductType: ProductType + ProductType: description: 'This class represents a product type.' type: object @@ -3132,47 +4308,68 @@ ProductType: AttributeAssignmentList: type: AttributeAssignment[] +ProductTypeUsageWrapper: + description: 'JSON object with only a ProductTypeUsage property.' + type: object + properties: + ProductTypeUsage: ProductTypeUsage + ProductTypeUsage: description: 'This class represents a product type usage.' - type: object + type: BaseObject properties: - isUsed: + is_used: type: boolean +ProductTypeCreateWrapper: + description: 'JSON object with only a ProductTypeCreate property.' + type: object + properties: + ProductTypeCreate: ProductTypeCreate + ProductTypeCreate: description: 'This class is used to create a product type.' type: object properties: ContentTypeCreateStruct: - type: object + type: ContentTypeCreateStruct main_language_code: type: string assigned_attributes: - type: object - properties: - identifier: - type: string - is_required: - type: boolean - is_discriminator: - type: boolean + type: array + items: ProductTypeAssignedAttribute + +ProductTypeUpdateWrapper: + description: 'JSON object with only a ProductTypeUpdate property.' + type: object + properties: + ProductTypeUpdate: ProductTypeUpdate ProductTypeUpdate: description: 'This class is used to update a product type.' type: object properties: ContentTypeUpdateStruct: - type: object + type: ContentTypeUpdateStruct assigned_attributes: - type: object - properties: - identifier: - type: string - is_required: - type: boolean - is_discriminator: - type: boolean + type: array + items: ProductTypeAssignedAttribute + +ProductTypeAssignedAttribute: + type: object + properties: + identifier: + type: string + is_required: + type: boolean + is_discriminator: + type: boolean +ProductTypeViewInputWrapper: + description: 'JSON object with only a ViewInput property.' + type: object + properties: + ViewInput: ProductTypeViewInput ProductTypeViewInput: description: 'This class represents a product type view input.' @@ -3180,6 +4377,14 @@ ProductTypeViewInput: properties: ProductTypeQuery: type: object + xml: + name: ViewInput + +ProductTypeViewWrapper: + description: 'JSON object with only a ProductTypeView property.' + type: object + properties: + ProductTypeView: ProductTypeView ProductTypeView: description: 'This class represents a product type view.' @@ -3192,14 +4397,22 @@ ProductTypeView: Result: type: object +ProductWrapper: + description: 'JSON object with only a Product property.' + type: object + properties: + Product: Product + Product: description: 'This class represents a product.' type: object properties: isVariant: type: boolean + required: false isBaseProduct: type: boolean + required: false code: type: string name: @@ -3208,22 +4421,38 @@ Product: type: ProductType Content: type: Content + required: false Thumbnail: type: Thumbnail + required: false created_at: - type: datetime + type: UnixTimestamp + required: false updated_at: - type: datetime + type: UnixTimestamp + required: false AttributesList: - type: AttributesList + type: Attribute[] + +ProductListWrapper: + description: 'JSON object with only a ProductList property.' + type: object + properties: + ProductList: ProductList ProductList: description: 'This class represents a product list.' type: object properties: - Products: + Product: type: Product[] +ProductListGetWrapper: + description: 'JSON object with only a ProductListGet property.' + type: object + properties: + ProductListGet: ProductListGet + ProductListGet: description: 'This class represents a product list GET.' type: object @@ -3235,6 +4464,12 @@ ProductListGet: languages: type: string[] +ProductGetWrapper: + description: 'JSON object with only a ProductGet property.' + type: object + properties: + ProductGet: ProductGet + ProductGet: description: 'This class represents a product GET.' type: object @@ -3242,6 +4477,12 @@ ProductGet: languages: type: string[] +ProductCreateWrapper: + description: 'JSON object with only a ProductCreate property.' + type: object + properties: + ProductCreate: ProductCreate + ProductCreate: description: 'This class is used to create a product.' type: object @@ -3251,20 +4492,45 @@ ProductCreate: code: type: string attributes: - type: array - items: object + type: object + +ProductUpdateWrapper: + description: 'JSON object with only a ProductUpdate property.' + type: object + properties: + ProductUpdate: ProductUpdate ProductUpdate: description: 'This class is used to update a product.' type: object properties: ContentUpdate: - type: ContentUpdate + type: ProductContentUpdate code: type: string attributes: type: array items: object + required: false + +ProductContentUpdate: + type: object + properties: + __url: + type: string + xml: + attribute: true + name: url + fields: + properties: + field: + type: Field[] + +ProductViewInputWrapper: + description: 'JSON object with only a ViewInput property.' + type: object + properties: + ViewInput: ProductViewInput ProductViewInput: description: 'This class represents a product view input.' @@ -3272,6 +4538,32 @@ ProductViewInput: properties: ProductQuery: type: object + xml: + name: ViewInput + +CatalogViewWrapper: + description: 'JSON object with only a CatalogView property.' + type: object + properties: + CatalogView: CatalogView + +CatalogView: + type: BaseObject + properties: + identifier: string + CatalogQuery: Ref + Result: CatalogListViewResult + +CatalogListViewResult: + type: BaseObject + properties: + CatalogList: CatalogList + +ProductViewWrapper: + description: 'JSON object with only a ProductView property.' + type: object + properties: + ProductView: ProductView ProductView: description: 'This class represents a product view.' @@ -3284,6 +4576,12 @@ ProductView: Result: type: object +ProductVariantWrapper: + description: 'JSON object with only a ProductVariant property.' + type: object + properties: + ProductVariant: ProductVariant + ProductVariant: description: 'This class represents a product variant.' type: object @@ -3297,6 +4595,12 @@ ProductVariant: DiscriminatorAttributesList: type: Attribute[] +ProductVariantCreateWrapper: + description: 'JSON object with only a ProductVariantCreate property.' + type: object + properties: + ProductVariantCreate: ProductVariantCreate + ProductVariantCreate: description: 'This class is used to create a product variant.' type: object @@ -3305,8 +4609,13 @@ ProductVariantCreate: type: string attributes: description: 'array' - type: array - items: any + type: object + +ProductVariantGenerateWrapper: + description: 'JSON object with only a ProductVariantGenerate property.' + type: object + properties: + ProductVariantGenerate: ProductVariantGenerate ProductVariantGenerate: description: 'This class is used to generate a product variant.' @@ -3314,8 +4623,13 @@ ProductVariantGenerate: properties: attributes: description: 'array' - type: array - items: any + type: object + +ProductVariantUpdateWrapper: + description: 'JSON object with only a ProductVariantUpdate property.' + type: object + properties: + ProductVariantUpdate: ProductVariantUpdate ProductVariantUpdate: description: 'This class is used to update a product variant.' @@ -3325,8 +4639,13 @@ ProductVariantUpdate: type: string attributes: description: 'array' - type: array - items: any + type: object + +ProductVariantViewInputWrapper: + description: 'JSON object with only a ViewInput property.' + type: object + properties: + ViewInput: ProductVariantViewInput ProductVariantViewInput: description: 'This class represents a product variant view input.' @@ -3335,6 +4654,12 @@ ProductVariantViewInput: ProductVariantQuery: type: object +ProductVariantViewWrapper: + description: 'JSON object with only a ProductVariantView property.' + type: object + properties: + ProductVariantView: ProductVariantView + ProductVariantView: description: 'This class represents a product variant view.' type: object @@ -3346,12 +4671,26 @@ ProductVariantView: Result: type: object +RegionViewInputWrapper: + description: 'JSON object with only a ViewInput property.' + type: object + properties: + ViewInput: RegionViewInput + RegionViewInput: description: 'This class represents a region view input.' type: object properties: RegionQuery: type: object + xml: + name: ViewInput + +RegionViewWrapper: + description: 'JSON object with only a RegionView property.' + type: object + properties: + RegionView: RegionView RegionView: description: 'This class represents a region view.' @@ -3364,13 +4703,25 @@ RegionView: Result: type: object +ProductTypeListWrapper: + description: 'JSON object with only a ProductTypeList property.' + type: object + properties: + ProductTypeList: ProductTypeList + ProductTypeList: description: 'This class represents a product type list.' type: object properties: - ProductTypes: + ProductType: type: ProductType[] +ProductTypeListGetWrapper: + description: 'JSON object with only a ProductTypeListGet property.' + type: object + properties: + ProductTypeListGet: ProductTypeListGet + ProductTypeListGet: description: 'This class represents a product type list query.' type: object @@ -3378,7 +4729,15 @@ ProductTypeListGet: name_prefix: string offset: integer limit: integer - languages: string[] + languages: + type: string[] + required: false + +TaxonomyEntryWrapper: + description: 'JSON object with only a TaxonomyEntry property.' + type: object + properties: + TaxonomyEntry: TaxonomyEntry TaxonomyEntry: description: 'This class represents a taxonomy entry.' @@ -3390,19 +4749,16 @@ TaxonomyEntry: type: string name: type: string - mainLanguageCode: - type: string - names: - type: array - items: any - Parent: - type: TaxonomyEntry - Content: - type: Content + content: + type: Ref taxonomy: type: string - level: - type: integer + +TaxonomyEntryAssignmentWrapper: + description: 'JSON object with only a TaxonomyEntryAssignment property.' + type: object + properties: + TaxonomyEntryAssignment: TaxonomyEntryAssignment TaxonomyEntryAssignment: description: 'This class represents a taxonomy entry assignment.' @@ -3410,17 +4766,32 @@ TaxonomyEntryAssignment: properties: id: type: integer - Content: - type: Content - Entry: - type: TaxonomyEntry + content: + type: BaseObject + properties: + Content: + type: Content + entry: + type: BaseObject + properties: + TaxonomyEntry: + type: TaxonomyEntry + +EntryAssignmentCollectionWrapper: + description: 'JSON object with only a EntryAssignmentCollection property.' + type: object + properties: + EntryAssignmentCollection: EntryAssignmentCollection EntryAssignmentCollection: description: 'This class represents a taxonomy assignment collection.' - type: object + type: BaseObject properties: - Content: - type: Content + content: + type: BaseObject + properties: + Content: + type: Content assignments: type: TaxonomyEntryAssignment[] @@ -3457,12 +4828,18 @@ TaxonomyEntryUpdateStruct: Content: type: Content +TaxonomyEntryBulkRemoveWrapper: + description: 'JSON object with only a TaxonomyEntryBulkRemove property.' + type: object + properties: + TaxonomyEntryBulkRemove: TaxonomyEntryBulkRemove + TaxonomyEntryBulkRemove: description: 'This class is used to bulk remove taxonomy entries.' type: object properties: entries: - type: TaxonomyEntry[] + type: integer[] TaxonomyEntryMove: type: object @@ -3474,6 +4851,12 @@ TaxonomyEntryMove: position: type: string +TaxonomyEntryBulkMoveWrapper: + description: 'JSON object with only a TaxonomyEntryBulkMove property.' + type: object + properties: + TaxonomyEntryBulkMove: TaxonomyEntryBulkMove + TaxonomyEntryBulkMove: description: 'This class is used to bulk move taxonomy entries.' type: object @@ -3481,6 +4864,12 @@ TaxonomyEntryBulkMove: entries: type: TaxonomyEntryMove[] +TaxonomyEntryAssignToContentWrapper: + description: 'JSON object with only a TaxonomyEntryAssignToContent property.' + type: object + properties: + TaxonomyEntryAssignToContent: TaxonomyEntryAssignToContent + TaxonomyEntryAssignToContent: description: 'This class is used to assign taxonomy entry to content.' type: object @@ -3488,7 +4877,13 @@ TaxonomyEntryAssignToContent: content: type: integer entries: - type: TaxonomyEntry[] + type: integer[] + +TaxonomyEntryUnassignFromContentWrapper: + description: 'JSON object with only a TaxonomyEntryUnassignFromContent property.' + type: object + properties: + TaxonomyEntryUnassignFromContent: TaxonomyEntryUnassignFromContent TaxonomyEntryUnassignFromContent: description: 'This class is used to unassign taxonomy entry from content.' @@ -3497,15 +4892,27 @@ TaxonomyEntryUnassignFromContent: content: type: integer entries: - type: TaxonomyEntry[] + type: integer[] + +VatCategoryListWrapper: + description: 'JSON object with only a VatCategoryList property.' + type: object + properties: + VatCategoryList: VatCategoryList VatCategoryList: description: 'This class represents a VAT category list.' type: object properties: - VatCategories: + VatCategory: type: VatCategory[] +VatCategoryWrapper: + description: 'JSON object with only a VatCategory property.' + type: object + properties: + VatCategory: VatCategory + VatCategory: description: 'This class represents a VAT category.' type: object @@ -3515,7 +4922,7 @@ VatCategory: region: type: string vatValue: - type: number + type: number | nil ContentUpdate: description: 'This class is used to update a Content.' @@ -3556,17 +4963,7 @@ ContentMetadataUpdate: type: string SummaryEntryNames: - type: object - properties: - value: - type: array - items: - type: object - properties: - _languageCode: - type: string - '#text': - type: string + type: ValueObject SummaryEntry: type: object @@ -3580,13 +4977,13 @@ SummaryEntry: quantity: type: integer Price: - type: RestPrice + type: RestPriceWrapper PriceInclVat: - type: RestPrice + type: RestPriceWrapper SubtotalPrice: - type: RestPrice + type: RestPriceWrapper SubtotalPriceInclVat: - type: RestPrice + type: RestPriceWrapper VatCategory: type: VatCategory Product: @@ -3597,28 +4994,43 @@ SummaryEntryCollection: type: object properties: count: - type: integer + type: string SummaryEntry: type: SummaryEntry[] +PriceWrapper: + description: 'JSON object with only a Price property.' + type: object + properties: + Price: Price + Price: description: 'This class represents a price.' - type: object + type: BaseObject properties: amount: type: string base_amount: type: string + required: false Currency: type: Currency money: - type: object + type: string + required: false base_money: - type: object + type: string + required: false + +CustomPriceWrapper: + description: 'JSON object with only a CustomPrice property.' + type: object + properties: + CustomPrice: CustomPrice CustomPrice: description: 'This class represents a custom price.' - type: object + type: BaseObject properties: amount: type: string @@ -3627,15 +5039,22 @@ CustomPrice: Currency: type: Currency money: - type: object + type: string base_money: - type: object + type: string custom_money: - type: object + type: string custom_amount: type: string custom_rule: - type: string + type: string | nil + required: false + +RestPriceWrapper: + description: 'JSON object with only a RestPrice property.' + type: BaseObject + properties: + RestPrice: RestPrice RestPrice: type: object @@ -3645,6 +5064,12 @@ RestPrice: formatted: type: string +PriceListWrapper: + description: 'JSON object with only a PriceList property.' + type: object + properties: + PriceList: PriceList + PriceList: description: 'This class represents a price list.' type: object @@ -3652,56 +5077,80 @@ PriceList: prices: type: Price[] +PriceCreateStructWrapper: + description: 'JSON object with only a PriceCreateStruct property.' + type: object + properties: + PriceCreateStruct: PriceCreateStruct + PriceCreateStruct: description: 'This class represents a price creation structure.' type: object properties: amount: - type: string + type: integer currency: type: string +CustomPriceCreateStructWrapper: + description: 'JSON object with only a CustomPriceCreateStruct property.' + type: object + properties: + CustomPriceCreateStruct: CustomPriceCreateStruct + CustomPriceCreateStruct: description: 'This class represents a custom price creation structure.' type: object properties: amount: - type: string + type: integer currency: type: string - custom_amount: + customAmount: + type: integer + customerGroup: type: string - customerGroups: - type: CustomerGroup[] + +PriceUpdateStructWrapper: + description: 'JSON object with only a PriceUpdateStruct property.' + type: object + properties: + PriceUpdateStruct: PriceUpdateStruct PriceUpdateStruct: description: 'This class represents a price updating structure.' type: object properties: amount: - type: string + type: integer currency: type: string +CustomPriceUpdateStructWrapper: + description: 'JSON object with only a CustomPriceUpdateStruct property.' + type: object + properties: + CustomPriceUpdateStruct: CustomPriceUpdateStruct + CustomPriceUpdateStruct: description: 'This class represents a custom price updating structure.' type: object properties: amount: - type: string + type: integer currency: type: string customAmount: - type: string + type: integer VatCategorySummary: description: 'This class represents a VAT category summary.' - type: object + type: BaseObject properties: - subtotal: - type: Price - vatCategory: + VatCategory: type: VatCategory + RestPrice: + type: RestPrice Thumbnail: description: 'This class represents a thumbnail that can be a target URL or a Base64 data.' @@ -3710,9 +5159,9 @@ Thumbnail: resource: type: string width: - type: integer + type: integer | nil height: - type: integer + type: integer | nil mimeType: type: string @@ -3723,13 +5172,25 @@ AttributesList: Attributes: type: Attribute[] +OrderListWrapper: + description: 'JSON object with only a OrderList property.' + type: object + properties: + OrderList: OrderList + OrderList: description: 'This class represents an orders list.' type: object properties: - Orders: + Order: type: Order[] +OrderWrapper: + description: 'JSON object with only a Order property.' + type: object + properties: + Order: Order + Order: description: 'This class represents order.' type: object @@ -3737,15 +5198,16 @@ Order: id: type: integer identifier: - type: integer + type: string created: - type: datetime + type: TimezoneDate modified: - type: datetime + type: TimezoneDate status: type: string source: type: string + required: false OrderUser: type: OrderUser OrderCurrency: @@ -3754,6 +5216,7 @@ Order: type: OrderValue OrderCompany: type: OrderCompany + required: false OrderItemsList: type: OrderItem[] context: @@ -3764,7 +5227,7 @@ OrderUser: type: object properties: id: - type: integer + type: integer | nil name: type: string email: @@ -3784,11 +5247,11 @@ OrderValue: type: object properties: vat: - type: string + type: string | OrderPrice total_gross: - type: string + type: string | OrderPrice total_net: - type: string + type: string | OrderPrice OrderCompany: description: 'This class represents order company.' @@ -3799,6 +5262,12 @@ OrderCompany: name: type: string +OrderCreateWrapper: + description: 'JSON object with only a OrderCreate property.' + type: object + properties: + OrderCreate: OrderCreate + OrderCreate: description: 'This class is used to create order.' type: object @@ -3814,7 +5283,13 @@ OrderCreate: OrderCompany: type: OrderCompany items: - type: OrderItem[] + type: OrderItemWrapper[] + +OrderUpdateWrapper: + description: 'JSON object with only a OrderUpdate property.' + type: object + properties: + OrderUpdate: OrderUpdate OrderUpdate: description: 'This class is used to update order.' @@ -3825,12 +5300,11 @@ OrderUpdate: transition: type: string -OrderItemsList: - description: 'This class represents an order items list.' +OrderItemWrapper: + description: 'JSON object with only a OrderItem property.' type: object properties: - OrderItems: - type: OrderItem[] + OrderItem: OrderItem OrderItem: description: 'This class represents order item.' @@ -3842,23 +5316,33 @@ OrderItem: type: OrderItemProduct quantity: type: integer + required: false context: type: object + required: false + +OrderPrice: + type: object + properties: + amount: + type: string + currency: + type: string OrderItemValue: description: 'This class represents order item value.' type: object properties: unit_price_gross: - type: string + type: string | OrderPrice unit_price_net: - type: string + type: string | OrderPrice vat_rate: type: string subtotal_price_gross: - type: string + type: string | OrderPrice subtotal_price_net: - type: string + type: string | OrderPrice OrderItemProduct: description: 'This class represents order item product.' @@ -3871,20 +5355,37 @@ OrderItemProduct: name: type: string +CorporateAccountRootWrapper: + description: 'JSON object with only a CorporateAccountRoot property.' + type: object + properties: + CorporateAccountRoot: CorporateAccountRoot + CorporateAccountRoot: description: 'This class represents Corporate Account Root resource information.' type: object properties: - link: + links: type: Link[] + xml: + wrapped: false Link: description: 'This class represents REST resource information.' type: BaseObject properties: - rel: + _rel: description: 'Unique identifier of a resource.' type: string + xml: + attribute: true + name: rel + +CompanyWrapper: + description: 'JSON object with only a Company property.' + type: object + properties: + Company: Company Company: description: 'This class represents a company.' @@ -3897,20 +5398,20 @@ Company: Content: type: Content billingAddress: - type: string + type: BillingAddress contactId: - type: integer + type: integer | nil salesRepresentativeId: type: integer defaultAddressId: - type: integer + type: integer | nil addressBookId: description: 'Address book Folder Content ID.' type: integer membersId: description: 'Members Folder Content ID.' type: integer - MembersList: + MemberList: description: 'Reference to Members List resource.' type: BaseObject Location: @@ -3922,36 +5423,64 @@ Company: isActive: type: boolean +BillingAddress: + type: object + properties: + name: string | nil + country: string | nil + fields: object | array + +CompanyCreateWrapper: + description: 'JSON object with only a CompanyCreate property.' + type: object + properties: + CompanyCreate: CompanyCreate + CompanyCreate: description: 'This class is used to create a company.' type: object properties: - remoteId: - type: string - modificationDate: - type: string - User: - description: 'User value.' - type: User fields: - description: 'Fields of a Company content item.' - type: Field[] + properties: + field: + description: 'Fields of a Company content item.' + type: Field[] + +CompanyUpdateWrapper: + description: 'JSON object with only a CompanyUpdate property.' + type: object + properties: + CompanyUpdate: CompanyUpdate CompanyUpdate: description: 'This class is used to update a Company.' type: object properties: fields: - description: 'Fields of a Company content item.' - type: Field[] + properties: + field: + description: 'Fields of a Company content item.' + type: Field[] + +CompanyListWrapper: + description: 'JSON object with only a CompanyList property.' + type: object + properties: + CompanyList: CompanyList CompanyList: description: 'This class represents a list of companies.' type: object properties: - Company: + companies: type: Company[] +MemberWrapper: + description: 'JSON object with only a Member property.' + type: object + properties: + Member: Member + Member: description: 'This class represents a company member.' type: object @@ -3969,13 +5498,25 @@ Member: description: 'Reference to the member role in a Company resource.' type: BaseObject +MemberListWrapper: + description: 'JSON object with only a MemberList property.' + type: object + properties: + MemberList: MemberList + MemberList: description: 'This class represents a list of company members.' type: object properties: - Member: + members: type: Member[] +MemberCreateWrapper: + description: 'JSON object with only a MemberCreate property.' + type: object + properties: + MemberCreate: MemberCreate + MemberCreate: description: 'This class is used to create a member.' type: object @@ -3990,8 +5531,16 @@ MemberCreate: description: 'Reference to a Role resource company member should be given.' type: BaseObject fields: - description: 'Fields of a Member content item.' - type: Field[] + properties: + field: + description: 'Fields of a Member content item.' + type: Field[] + +MemberUpdateWrapper: + description: 'JSON object with only a MemberUpdate property.' + type: object + properties: + MemberUpdate: MemberUpdate MemberUpdate: description: 'This class is used to update a member.' @@ -4010,8 +5559,10 @@ MemberUpdate: description: 'Reference to a Role resource company member should be given.' type: BaseObject fields: - description: 'Fields of a Member content item.' - type: Field[] + properties: + field: + description: 'Fields of a Member content item.' + type: Field[] ErrorMessage: description: 'Represents an error response. Might contain additional properties depending on an error type.' @@ -4024,6 +5575,12 @@ ErrorMessage: errorDescription: type: string +PaymentMethodWrapper: + description: 'JSON object with only a PaymentMethod property.' + type: object + properties: + PaymentMethod: PaymentMethod + PaymentMethod: type: object properties: @@ -4043,6 +5600,12 @@ PaymentMethod: type: string required: true +PaymentMethodCreateStructWrapper: + description: 'JSON object with only a PaymentMethodCreateStruct property.' + type: object + properties: + PaymentMethodCreateStruct: PaymentMethodCreateStruct + PaymentMethodCreateStruct: type: object properties: @@ -4054,31 +5617,51 @@ PaymentMethodCreateStruct: required: true names: description: 'If set this array of names with languageCode keys replace the complete name collection.' - type: string[] + type: object descriptions: description: 'An array of descriptions with languageCode keys.' type: string[] + required: false enabled: type: boolean + required: false options: type: object + required: false + +PaymentMethodUpdateStructWrapper: + description: 'JSON object with only a PaymentMethodUpdateStruct property.' + type: object + properties: + PaymentMethodUpdateStruct: PaymentMethodUpdateStruct PaymentMethodUpdateStruct: type: object properties: identifier: type: string + required: false names: description: 'If set this array of names with languageCode keys replace the complete name collection.' - type: string[] + type: object + required: false descriptions: description: 'An array of descriptions with languageCode keys.' type: string[] + required: false enabled: type: boolean + required: false options: type: array items: any + required: false + +PaymentMethodViewWrapper: + description: 'JSON object with only a PaymentMethodView property.' + type: object + properties: + PaymentMethodView: PaymentMethodView PaymentMethodView: type: object @@ -4100,6 +5683,12 @@ PaymentMethodList: type: PaymentMethod[] required: true +PaymentMethodViewInputWrapper: + description: 'JSON object with only a PaymentMethodViewInput property.' + type: object + properties: + PaymentMethodViewInput: PaymentMethodViewInput + PaymentMethodViewInput: type: object properties: @@ -4110,6 +5699,12 @@ PaymentMethodViewInput: type: object required: true +ShipmentWrapper: + description: 'JSON object with only a Shipment property.' + type: object + properties: + Shipment: Shipment + Shipment: description: 'This class represents a single shipment.' type: object @@ -4127,12 +5722,12 @@ Shipment: description: 'Next steps available in the shipment workflow for the current status' type: string[] Order: - type: Order + type: Ref Amount: type: object properties: value: - type: integer + type: string currency: type: string createdAt: @@ -4140,16 +5735,28 @@ Shipment: updatedAt: type: datetime Owner: - type: User + type: Ref Method: - type: ShippingMethod + type: Ref + +ShipmentRefListWrapper: + description: 'JSON object with only a ShipmentRefList property.' + type: object + properties: + ShipmentRefList: ShipmentRefList ShipmentRefList: description: 'This class represents a list of Shipments' type: object properties: shipmentRefList: - type: Shipment[] + type: Ref[] + +ShipmentCreateWrapper: + description: 'JSON object with only a ShipmentCreate property.' + type: object + properties: + ShipmentCreate: ShipmentCreate ShipmentCreate: description: 'This class represents the creation of a shipment.' @@ -4158,12 +5765,18 @@ ShipmentCreate: identifier: type: string ShippingMethod: - type: ShippingMethod + type: Ref Owner: - type: User + type: Ref Context: type: object +ShipmentUpdateWrapper: + description: 'JSON object with only a ShipmentUpdate property.' + type: object + properties: + ShipmentUpdate: ShipmentUpdate + ShipmentUpdate: description: 'This class represents the update of a shipment.' type: object @@ -4173,10 +5786,16 @@ ShipmentUpdate: transition: type: string Owner: - type: User + type: Ref Context: type: object +ShippingMethodWrapper: + description: 'JSON object with only a ShippingMethod property.' + type: object + properties: + ShippingMethod: ShippingMethod + ShippingMethod: description: 'This class represents a shipping method.' type: object @@ -4202,12 +5821,15 @@ ShippingMethod: options: type: object properties: - value: + option: type: KeyValue[] regions: - type: Region[] + type: object + properties: + RegionRefList: + type: Ref[] type: - type: ShippingMethodType[] + type: Ref MultilingualValue: description: 'Object that represents a multilingual (translated) value.' @@ -4218,7 +5840,7 @@ MultilingualValue: type: string '#text': description: 'Translation contents.' - type: string + type: string | nil KeyValue: description: 'Key-value structure' @@ -4227,14 +5849,26 @@ KeyValue: _key: type: string '#text': - type: string + type: string | nil + +ShippingMethodRefListWrapper: + description: 'JSON object with only a ShippingMethodRefList property.' + type: object + properties: + ShippingMethodRefList: ShippingMethodRefList ShippingMethodRefList: description: 'This class represents a list of shipping methods' type: object properties: ShippingMethodRefs: - type: ShippingMethod[] + type: Ref[] + +ShippingMethodTypeWrapper: + description: 'JSON object with only a ShippingMethodType property.' + type: object + properties: + ShippingMethodType: ShippingMethodType ShippingMethodType: description: 'This class represents a shipping method type.' @@ -4245,6 +5879,12 @@ ShippingMethodType: name: type: string +ShippingMethodTypesListWrapper: + description: 'JSON object with only a ShippingMethodTypesList property.' + type: object + properties: + ShippingMethodTypesList: ShippingMethodTypesList + ShippingMethodTypesList: description: 'This class represents a list of shipping method types.' type: object @@ -4252,33 +5892,54 @@ ShippingMethodTypesList: ShippingMethodTypes: type: ShippingMethodType[] +SalesRepresentativesListWrapper: + description: 'JSON object with only a SalesRepresentativesList property.' + type: object + properties: + SalesRepresentativesList: SalesRepresentativesList + SalesRepresentativesList: description: 'This class represents a list of sales representatives.' - type: object + type: BaseObject properties: - Users: + users: type: User[] +ActivityLogGroupListInputWrapper: + description: 'JSON object with only a ActivityLogGroupListInput property.' + type: object + properties: + ActivityLogGroupListInput: ActivityLogGroupListInput + ActivityLogGroupListInput: description: "This class represents the activity log group search query's criteria and sort clauses." type: object +ActivityLogGroupListWrapper: + description: 'JSON object with only a ActivityLogGroupList property.' + type: object + properties: + ActivityLogGroupList: ActivityLogGroupList + ActivityLogGroupList: description: "This class represents activity log context groups" type: object properties: ActivityLogGroups: - type: object - properties: - user_id: - type: integer - description: "The ID of the user performing the logged actions" - logged_at: - type: integer - description: "Timestamp representing when the group has been logged" - ActivityLogEntries: - type: ActivityLog[] - description: "Log entries from the group" + type: ActivityLogGroup[] + +ActivityLogGroup: + type: object + properties: + user_id: + type: integer + description: "The ID of the user performing the logged actions" + logged_at: + type: integer + description: "Timestamp representing when the group has been logged" + ActivityLogEntries: + type: ActivityLog[] + description: "Log entries from the group" ActivityLog: description: 'This class represents an activity log entry.' diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-user-current.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-user-current.raml index b4da5d615f..64af42a368 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-user-current.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-user-current.raml @@ -15,7 +15,7 @@ get: type: UserList example: !include examples/user/users/user_id/GET/User.xml.example application/vnd.ibexa.api.User+json: - type: UserList + type: UserListWrapper 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/ibexa-user-groups.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-user-groups.raml index 4dc5ffc8a8..5cd5fb5e09 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-user-groups.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-user-groups.raml @@ -23,12 +23,12 @@ get: type: UserGroupList example: !include examples/user/groups/GET/UserGroupList.xml.example application/vnd.ibexa.api.UserGroupList+json: - type: UserGroupList + type: UserGroupListWrapper example: !include examples/user/groups/GET/UserGroupList.json.example application/vnd.ibexa.api.UserGroupRefList+xml: type: UserGroupRefList application/vnd.ibexa.api.UserGroupRefList+json: - type: UserGroupRefList + type: UserGroupRefListWrapper 401: description: Error - the user has no permission to read User Groups. /root: @@ -59,7 +59,7 @@ get: type: UserGroupCreate example: !include examples/user/groups/path/subgroups/POST/UserGroupCreate.xml.example application/vnd.ibexa.api.UserGroupCreate+json: - type: UserGroupCreate + type: UserGroupCreateWrapper example: !include examples/user/groups/path/subgroups/POST/UserGroupCreate.json.example responses: 201: @@ -69,7 +69,7 @@ get: type: UserGroup example: !include examples/user/groups/path/subgroups/POST/UserGroup.xml.example application/vnd.ibexa.api.UserGroup+json: - type: UserGroup + type: UserGroupWrapper example: !include examples/user/groups/path/subgroups/POST/UserGroup.json.example 400: description: Error - the input does not match the input schema definition. @@ -95,7 +95,7 @@ get: type: UserGroup example: !include examples/user/groups/path/GET/UserGroup.xml.example application/vnd.ibexa.api.UserGroup+json: - type: UserGroup + type: UserGroupWrapper example: !include examples/user/groups/path/GET/UserGroup.json.example 401: description: Error - the user has no permission to read User Groups. @@ -123,7 +123,7 @@ get: type: UserGroupUpdate example: !include examples/user/groups/path/PATCH/UserGroupUpdate.xml.example application/vnd.ibexa.api.UserGroupUpdate+json: - type: UserGroupUpdate + type: UserGroupUpdateWrapper example: !include examples/user/groups/path/PATCH/UserGroupUpdate.json.example responses: 200: @@ -133,7 +133,7 @@ get: type: UserGroup example: !include examples/user/groups/path/PATCH/UserGroup.xml.example application/vnd.ibexa.api.UserGroup+json: - type: UserGroup + type: UserGroupWrapper example: !include examples/user/groups/path/PATCH/UserGroup.json.example 400: description: Error - the input does not match the input schema definition. @@ -195,7 +195,7 @@ get: type: UserRefList example: !include examples/user/groups/id/users/GET/UserRefList.xml.example application/vnd.ibexa.api.UserRefList+json: - type: UserRefList + type: UserRefListWrapper example: !include examples/user/groups/id/users/GET/UserRefList.json.example 401: description: Error - the user has no permission to read User Groups. @@ -220,7 +220,7 @@ get: type: UserCreate example: !include examples/user/groups/path/users/POST/UserCreate.xml.example application/vnd.ibexa.api.UserCreate+json: - type: UserCreate + type: UserCreateWrapper example: !include examples/user/groups/path/users/POST/UserCreate.json.example responses: 201: @@ -229,7 +229,7 @@ get: type: User example: !include examples/user/groups/path/users/POST/User.xml.example application/vnd.ibexa.api.User+json: - type: User + type: UserWrapper example: !include examples/user/groups/path/users/POST/User.json.example 400: description: Error - the input does not match the input schema definition. @@ -263,12 +263,12 @@ get: application/vnd.ibexa.api.UserGroupList+xml: type: UserGroupList application/vnd.ibexa.api.UserGroupList+json: - type: UserGroupList + type: UserGroupListWrapper application/vnd.ibexa.api.UserGroupRefList+xml: type: UserGroupRefList example: !include examples/user/groups/id/subgroups/GET/UserGroupRefList.xml.example application/vnd.ibexa.api.UserGroupRefList+json: - type: UserGroupRefList + type: UserGroupRefListWrapper example: !include examples/user/groups/id/subgroups/GET/UserGroupRefList.json.example 401: description: Error - the user has no permission to read User Groups. @@ -293,7 +293,7 @@ get: type: UserGroupCreate example: !include examples/user/groups/path/subgroups/POST/UserGroupCreate.xml.example application/vnd.ibexa.api.UserGroupCreate+json: - type: UserGroupCreate + type: UserGroupCreateWrapper example: !include examples/user/groups/path/subgroups/POST/UserGroupCreate.json.example responses: 201: @@ -302,7 +302,7 @@ get: type: UserGroup example: !include examples/user/groups/path/subgroups/POST/UserGroup.xml.example application/vnd.ibexa.api.UserGroup+json: - type: UserGroup + type: UserGroupWrapper example: !include examples/user/groups/path/subgroups/POST/UserGroup.json.example 400: description: Error - the input does not match the input schema definition. @@ -325,7 +325,7 @@ get: type: RoleAssignmentList example: !include examples/user/groups/path/roles/GET/RoleAssignmentList.xml.example application/vnd.ibexa.api.RoleAssignmentList+json: - type: RoleAssignmentList + type: RoleAssignmentListWrapper #example: !include examples/user/groups/path/roles/GET/RoleAssignmentList.json.example 400: description: Error - the user has no permission to read Roles. @@ -348,7 +348,7 @@ get: type: RoleAssignInput example: !include examples/user/groups/path/roles/POST/RoleAssignInput.xml.example application/vnd.ibexa.api.RoleAssignInput+json: - type: RoleAssignInput + type: RoleAssignInputWrapper example: !include examples/user/groups/path/roles/POST/RoleAssignInput.json.example responses: 200: @@ -357,7 +357,7 @@ get: type: RoleAssignmentList example: !include examples/user/groups/path/roles/POST/RoleAssignmentList.xml.example application/vnd.ibexa.api.RoleAssignmentList+json: - type: RoleAssignmentList + type: RoleAssignmentListWrapper example: !include examples/user/groups/path/roles/POST/RoleAssignmentList.json.example 400: description: Error - validation of limitation in RoleAssignInput fails. @@ -381,9 +381,8 @@ get: type: RoleAssignment example: !include examples/user/groups/path/roles/role_id/GET/RoleAssignment.xml.example application/vnd.ibexa.api.RoleAssignment+json: - type: RoleAssignment + type: RoleAssignmentWrapper example: !include examples/user/groups/path/roles/role_id/GET/RoleAssignment.json.example - 401: description: Error - the user has no permission to read Roles. delete: @@ -402,7 +401,7 @@ get: type: RoleAssignmentList example: !include examples/user/groups/path/roles/role_id/DELETE/RoleAssignmentList.xml.example application/vnd.ibexa.api.RoleAssignmentList+json: - type: RoleAssignmentList + type: RoleAssignmentListWrapper example: !include examples/user/groups/path/roles/role_id/DELETE/RoleAssignmentList.json.example 401: description: Error - the user is not authorized to delete this Role assignment. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-user-policies.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-user-policies.raml index 06712572cb..686c107ff9 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-user-policies.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-user-policies.raml @@ -18,7 +18,7 @@ get: type: PolicyList example: !include examples/user/policies/GET/PolicyList.xml.example application/vnd.ibexa.api.PolicyList+json: - type: PolicyList + type: PolicyListWrapper example: !include examples/user/policies/GET/PolicyList.json.example 401: description: Error - the user has no permission to read Roles. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-user-roles.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-user-roles.raml index d3a5330d34..f8da41075c 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-user-roles.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-user-roles.raml @@ -24,7 +24,7 @@ get: type: RoleList example: !include examples/user/roles/GET/RoleList.xml.example application/vnd.ibexa.api.RoleList+json: - type: RoleList + type: RoleListWrapper example: !include examples/user/roles/GET/RoleList.json.example 401: description: Error - the user has no permission to read Roles. @@ -54,7 +54,7 @@ post: type: RoleInput example: !include examples/user/roles/POST/RoleInput.xml.example application/vnd.ibexa.api.RoleInput+json: - type: RoleInput + type: RoleInputWrapper example: !include examples/user/roles/POST/RoleInput.json.example responses: 201: @@ -63,7 +63,7 @@ post: type: Role example: !include examples/user/roles/POST/Role.xml.example application/vnd.ibexa.api.Role+json: - type: Role + type: RoleWrapper example: !include examples/user/roles/POST/Role.json.example 400: description: Error - the input does not match the input schema definition. @@ -89,7 +89,7 @@ post: type: Role example: !include examples/user/roles/id/GET/Role.xml.example application/vnd.ibexa.api.Role+json: - type: Role + type: RoleWrapper example: !include examples/user/roles/id/GET/Role.json.example 401: description: Error - the user has no permission to read Roles. @@ -116,7 +116,7 @@ post: type: RoleDraft example: !include examples/user/roles/id/POST/RoleDraft.xml.example application/vnd.ibexa.api.RoleDraft+json: - type: RoleDraft + type: RoleDraftWrapper example: !include examples/user/roles/id/POST/RoleDraft.json.example 401: description: Error - the user is not authorized to create a Role or a Role draft @@ -141,7 +141,7 @@ post: type: RoleInput example: !include examples/user/roles/id/PATCH/RoleInput.xml.example application/vnd.ibexa.api.RoleInput+json: - type: RoleInput + type: RoleInputWrapper example: !include examples/user/roles/id/PATCH/RoleInput.json.example responses: 200: @@ -151,7 +151,7 @@ post: type: Role example: !include examples/user/roles/id/PATCH/Role.xml.example application/vnd.ibexa.api.Role+json: - type: Role + type: RoleWrapper example: !include examples/user/roles/id/PATCH/Role.json.example 400: description: Error - the input does not match the input schema definition. @@ -187,8 +187,8 @@ post: type: Role example: !include examples/user/roles/id/draft/GET/Role.xml.example application/vnd.ibexa.api.Role+json: - type: Role - example: !include examples/user/roles/id/draft/GET/Role.json.example + type: RoleWrapper + example: !include examples/user/roles/id/draft/GET/Role.json.example 401: description: Error - the user has no permission to read Roles. 404: @@ -214,7 +214,7 @@ post: type: RoleInput example: !include examples/user/roles/id/draft/PATCH/RoleInput.xml.example application/vnd.ibexa.api.RoleInput+json: - type: RoleInput + type: RoleInputWrapper example: !include examples/user/roles/id/draft/PATCH/RoleInput.json.example responses: 200: @@ -224,7 +224,7 @@ post: type: Role example: !include examples/user/roles/id/draft/PATCH/Role.xml.example application/vnd.ibexa.api.Role+json: - type: Role + type: RoleWrapper example: !include examples/user/roles/id/draft/PATCH/Role.json.example 400: description: Error - the input does not match the input schema definition. @@ -271,7 +271,7 @@ post: type: PolicyList example: !include examples/user/roles/id/policies/GET/PolicyList.xml.example application/vnd.ibexa.api.PolicyList+json: - type: PolicyList + type: PolicyListWrapper example: !include examples/user/roles/id/policies/GET/PolicyList.json.example 401: description: Error - the user has no permission to read Roles. @@ -305,7 +305,7 @@ post: type: PolicyCreate example: !include examples/user/roles/id/policies/POST/PolicyCreate.xml.example application/vnd.ibexa.api.PolicyCreate+json: - type: PolicyCreate + type: PolicyCreateWrapper responses: 201: body: @@ -313,7 +313,7 @@ post: type: Policy example: !include examples/user/roles/id/policies/POST/Policy.xml.example application/vnd.ibexa.api.Policy+json: - type: Policy + type: PolicyWrapper 400: description: Error - the input does not match the input schema definition or validation of limitation in PolicyCreate fails. 401: @@ -344,7 +344,7 @@ post: type: PolicyUpdate example: !include examples/user/roles/id/policies/id/PATCH/PolicyUpdate.xml.example application/vnd.ibexa.api.PolicyUpdate+json: - type: PolicyUpdate + type: PolicyUpdateWrapper responses: 200: body: @@ -352,7 +352,7 @@ post: type: Policy example: !include examples/user/roles/id/policies/id/PATCH/Policy.xml.example application/vnd.ibexa.api.Policy+json: - type: Policy + type: PolicyWrapper 400: description: Error - the input does not match the input schema definition or validation of limitation in PolicyUpdate fails. 401: @@ -379,7 +379,7 @@ post: type: Policy example: !include examples/user/roles/id/policies/id/GET/Policy.xml.example application/vnd.ibexa.api.Policy+json: - type: Policy + type: PolicyWrapper example: !include examples/user/roles/id/policies/id/GET/Policy.json.example 401: description: Error - the user has no permission to read Roles. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-user-sessions.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-user-sessions.raml index 99345d927c..4d74ce7cab 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-user-sessions.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-user-sessions.raml @@ -21,7 +21,7 @@ post: type: SessionInput example: !include examples/user/sessions/POST/SessionInput.xml.example application/vnd.ibexa.api.SessionInput+json: - type: SessionInput + type: SessionInputWrapper example: !include examples/user/sessions/POST/SessionInput.json.example responses: 200: @@ -31,7 +31,7 @@ post: type: Session example: !include examples/user/sessions/POST/Session.xml.example application/vnd.ibexa.api.Session+json: - type: Session + type: SessionWrapper example: !include examples/user/sessions/POST/Session.json.example 201: description: Session is created. @@ -40,7 +40,7 @@ post: type: Session example: !include examples/user/sessions/POST/Session.xml.example application/vnd.ibexa.api.Session+json: - type: Session + type: SessionWrapper example: !include examples/user/sessions/POST/Session.json.example 400: description: Error - the input does not match the input schema definition. @@ -68,7 +68,7 @@ post: type: Session example: !include examples/user/sessions/POST/Session.xml.example application/vnd.ibexa.api.Session+json: - type: Session + type: SessionWrapper example: !include examples/user/sessions/POST/Session.json.example 404: description: User does not have a valid session, or it has expired. @@ -107,7 +107,7 @@ post: type: Session example: !include examples/user/sessions/session_id/refresh/POST/Session.xml.example application/vnd.ibexa.api.Session+json: - type: Session + type: SessionWrapper example: !include examples/user/sessions/session_id/refresh/POST/Session.json.example 404: description: Error - the session does not exist. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-user-token.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-user-token.raml index 0954cf6f71..1fffad9268 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-user-token.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-user-token.raml @@ -18,7 +18,7 @@ type: JWTInput example: !include examples/user/token/jwt/POST/JWTInput.xml.example application/vnd.ibexa.api.JWTInput+json: - type: JWTInput + type: JWTInputWrapper example: !include examples/user/token/jwt/POST/JWTInput.json.example responses: 200: @@ -27,9 +27,7 @@ type: JWT example: !include examples/user/token/jwt/POST/JWT.xml.example application/vnd.ibexa.api.JWT+json: - type: JWT + type: JWTWrapper example: !include examples/user/token/jwt/POST/JWT.json.example 401: description: Error - Unauthorized - - diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-user-users.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-user-users.raml index b07ab524d2..674b939dd3 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-user-users.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-user-users.raml @@ -25,13 +25,13 @@ get: application/vnd.ibexa.api.UserList+xml: type: UserList application/vnd.ibexa.api.UserList+json: - type: UserList + type: UserListWrapper example: !include examples/user/users/GET/UserList.json.example application/vnd.ibexa.api.UserRefList+xml: type: UserRefList example: !include examples/user/users/GET/UserRefList.xml.example application/vnd.ibexa.api.UserRefList+json: - type: UserRefList + type: UserRefListWrapper 404: description: If there are no visibile Users matching the filter. head: @@ -89,7 +89,7 @@ head: type: UserList example: !include examples/user/users/user_id/GET/User.xml.example application/vnd.ibexa.api.User+json: - type: UserList + type: UserListWrapper example: !include examples/user/users/user_id/GET/User.json.example 401: description: Error - the user has no permission to read Users. @@ -117,7 +117,7 @@ head: type: UserUpdate example: !include examples/user/users/user_id/PATCH/UserUpdate.xml.example application/vnd.ibexa.api.UserUpdate+json: - type: UserUpdate + type: UserUpdateWrapper example: !include examples/user/users/user_id/PATCH/UserUpdate.json.example responses: 200: @@ -127,7 +127,7 @@ head: type: User example: !include examples/user/users/user_id/PATCH/User.xml.example application/vnd.ibexa.api.User+json: - type: User + type: UserWrapper example: !include examples/user/users/user_id/PATCH/User.json.example 400: description: Error - the input does not match the input schema definition. @@ -173,7 +173,7 @@ head: type: UserGroupRefList example: !include examples/user/users/user_id/groups/GET/UserGroupRefList.xml.example application/vnd.ibexa.api.UserGroupRefList+json: - type: UserGroupRefList + type: UserGroupRefListWrapper #example: !include examples/user/users/user_id/groups/GET/UserGroupRefList.json.example 401: description: Error - the user has no permission to read User Groups. @@ -198,7 +198,7 @@ head: type: UserGroupRefList example: !include examples/user/users/user_id/groups/POST/UserGroupRefList.xml.example application/vnd.ibexa.api.UserGroupRefList+json: - type: UserGroupRefList + type: UserGroupRefListWrapper example: !include examples/user/users/user_id/groups/POST/UserGroupRefList.json.example 401: description: Error - the user is not authorized to assign User Groups. @@ -223,7 +223,7 @@ head: type: UserGroupRefList example: !include examples/user/users/user_id/groups/group_id/DELETE/UserGroupRefList.xml.example application/vnd.ibexa.api.UserGroupRefList+json: - type: UserGroupRefList + type: UserGroupRefListWrapper 401: description: Error - the user is not authorized to unassign User Groups. 403: @@ -247,7 +247,7 @@ head: type: RoleAssignmentList example: !include examples/user/users/user_id/roles/GET/RoleAssignmentList.xml.example application/vnd.ibexa.api.RoleAssignmentList+json: - type: RoleAssignmentList + type: RoleAssignmentListWrapper example: !include examples/user/users/user_id/roles/GET/RoleAssignmentList.json.example 400: description: Error - the user has no permission to read Roles. @@ -270,7 +270,7 @@ head: type: RoleAssignInput example: !include examples/user/users/user_id/roles/POST/RoleAssignInput.xml.example application/vnd.ibexa.api.RoleAssignInput+json: - type: RoleAssignInput + type: RoleAssignInputWrapper example: !include examples/user/users/user_id/roles/POST/RoleAssignInput.json.example responses: 200: @@ -279,7 +279,7 @@ head: type: RoleAssignmentList example: !include examples/user/users/user_id/roles/POST/RoleAssignmentList.xml.example application/vnd.ibexa.api.RoleAssignmentList+json: - type: RoleAssignmentList + type: RoleAssignmentListWrapper example: !include examples/user/users/user_id/roles/POST/RoleAssignmentList.json.example 400: description: Error - validation of limitation in RoleAssignInput fails. @@ -303,7 +303,7 @@ head: type: RoleAssignment example: !include examples/user/users/user_id/roles/role_id/GET/RoleAssignment.xml.example application/vnd.ibexa.api.RoleAssignment+json: - type: RoleAssignment + type: RoleAssignmentWrapper example: !include examples/user/users/user_id/roles/role_id/GET/RoleAssignment.json.example 401: description: Error - the user has no permission to read Roles. @@ -323,7 +323,7 @@ head: type: RoleAssignmentList example: !include examples/user/users/user_id/roles/role_id/DELETE/RoleAssignmentList.xml.example application/vnd.ibexa.api.RoleAssignmentList+json: - type: RoleAssignmentList + type: RoleAssignmentListWrapper 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. @@ -367,6 +367,6 @@ head: application/vnd.ibexa.api.VersionList+xml: type: VersionList application/vnd.ibexa.api.VersionList+json: - type: VersionList + type: VersionListWrapper 401: description: Error - the current user is not authorized to list the drafts of the given user. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-views.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-views.raml index b3078ab7c0..0a8c49b00d 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-views.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-views.raml @@ -27,7 +27,7 @@ post: type: ViewInput example: !include examples/views/POST/ViewInput.xml.example application/vnd.ibexa.api.ViewInput+json: - type: ViewInput + type: ViewInputWrapper example: !include examples/views/POST/ViewInput.json.example responses: 200: 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 e0c194f25f..697d84f8a2 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 @@ -176,6 +176,14 @@
Types
This class represents a root. + + + + + RootWrapper + + + JSON object with only a Root property. @@ -694,6 +702,14 @@
Types
List of bookmarked Locations. + + + + + BookmarkListWrapper + + + JSON object with only a BookmarkList property. @@ -1726,6 +1742,14 @@
Types
This class is used for creating a new content item. + + + + + ContentCreateWrapper + + + JSON object with only a ContentCreate property. @@ -1737,11 +1761,19 @@
Types
- - ContentInfo + + ContentWrapper - This class provides all version independent information of the content item. + JSON object with only a Content property. + + + + + ContentInfoWrapper + + + JSON object with only a ContentInfo property. @@ -1866,11 +1898,11 @@
Types
"fieldDefinitionIdentifier": "intro", "languageCode": "eng-GB", "fieldTypeIdentifier": "ezrichtext", - "fieldValue": + "fieldValue": { "xml": "<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"><p>draft draft</p></section>" } - + View more @@ -2024,7 +2056,7 @@
Types
"fieldDefinitionIdentifier": "intro", "languageCode": "eng-GB", "fieldTypeIdentifier": "ezrichtext", - "fieldValue": + "fieldValue": { "xml": "<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"><p>draft draft</p></section>" } @@ -2899,6 +2931,14 @@
Types
Content ID matcher class. + + + + + ContentWrapper + + + JSON object with only a Content property. @@ -2907,6 +2947,14 @@
Types
This class provides all version independent information of the content item. + + + + + ContentInfoWrapper + + + JSON object with only a ContentInfo property. @@ -3565,6 +3613,14 @@
Types
This class provides all version independent information of the content item. + + + + + ContentInfoWrapper + + + JSON object with only a ContentInfo property. @@ -4203,6 +4259,14 @@
Types
Returns the VersionInfo for this version. + + + + + VersionWrapper + + + JSON object with only a Version property. @@ -4716,6 +4780,14 @@
Types
Returns the VersionInfo for this version. + + + + + VersionWrapper + + + JSON object with only a Version property. @@ -5229,6 +5301,14 @@
Types
List of all versions of the content. + + + + + VersionListWrapper + + + JSON object with only a VersionList property. @@ -5915,6 +5995,14 @@
Types
Returns the VersionInfo for this version. + + + + + VersionWrapper + + + JSON object with only a Version property. @@ -6544,6 +6632,14 @@
Types
This class is used to update a content version. + + + + + VersionUpdateWrapper + + + JSON object with only a VersionUpdate property. @@ -6552,6 +6648,14 @@
Types
Returns the VersionInfo for this version. + + + + + VersionWrapper + + + JSON object with only a Version property. @@ -7009,6 +7113,14 @@
Types
Returns the VersionInfo for this version. + + + + + VersionWrapper + + + JSON object with only a Version property. @@ -7850,6 +7962,14 @@
Types
Class representing a list of relations between content. + + + + + RelationListWrapper + + + JSON object with only a Relations property. @@ -8221,12 +8341,36 @@
Types
+ + + RelationCreate + + + + + + + + RelationCreateWrapper + + + JSON object with only a RelationCreate property. + + Relation Class representing a relation between content. + + + + + RelationWrapper + + + JSON object with only a Relation property. @@ -8768,6 +8912,14 @@
Types
Class representing a relation between content. + + + + + RelationWrapper + + + JSON object with only a Relation property. @@ -8795,16 +8947,6 @@
Types
aria-selected="true"> xml - -
  • - - json -
    • @@ -8834,23 +8976,6 @@
    Types
    - View more - -
    -
    -

    - file_copy - -

    - 
    -                                examples/content/objects/content_id/versions/version_no/relations/relation_id/GET/Relation.json.example
-
    -
    View more
    @@ -8887,19 +9012,6 @@
    Types
  • -
    • -
  • - - json - -
    • -
  • -
    • @@ -8929,23 +9041,6 @@
    Types
    </Relation> -
    - -
    -
    -

    - file_copy - -

    - 
    -                                            examples/content/objects/content_id/versions/version_no/relations/relation_id/GET/Relation.json.example
-
    @@ -9304,6 +9399,14 @@
    Types
    + + + + + LocationCreateWrapper + + + JSON object with only a LocationCreate property. @@ -9312,6 +9415,14 @@
    Types
    This class represents a Location in the Repository. + + + + + LocationWrapper + + + JSON object with only a Location property. @@ -9394,11 +9505,10 @@
    Types
    "ParentLocation": { "_href": "/api/ibexa/v2/content/locations/1/59" }, - "priority": "0", - "hidden": false, - "sortField": "PATH", - "sortOrder": "ASC" - + "priority": "0", + "hidden": false, + "sortField": "PATH", + "sortOrder": "ASC" } } @@ -9501,11 +9611,10 @@
    Types
    "ParentLocation": { "_href": "/api/ibexa/v2/content/locations/1/59" }, - "priority": "0", - "hidden": false, - "sortField": "PATH", - "sortOrder": "ASC" - + "priority": "0", + "hidden": false, + "sortField": "PATH", + "sortOrder": "ASC" } } @@ -9997,6 +10106,14 @@
    Types
    This class represents a queried Location list holding a totalCount and a partial list of Locations (by offset/limit parameters and permission filters). + + + + + LocationListWrapper + + + JSON object with only a LocationList property. @@ -10369,6 +10486,14 @@
    Types
    Represents a list of object states. + + + + + ContentObjectStatesWrapper + + + JSON object with only a ContentObjectStates property. @@ -10808,6 +10933,14 @@
    Types
    Represents a list of object states. + + + + + ContentObjectStatesWrapper + + + JSON object with only a ContentObjectStates property. @@ -11528,6 +11661,14 @@
    Types
    List of Object state groups. + + + + + ObjectStateGroupListWrapper + + + JSON object with only a ObjectStateGroupList property. @@ -12046,6 +12187,14 @@
    Types
    This class represents a value for creating Object state groups. + + + + + ObjectStateGroupCreateWrapper + + + JSON object with only a ObjectStateGroupCreate property. @@ -12054,6 +12203,14 @@
    Types
    This class represents an Object state group value. + + + + + ObjectStateGroupWrapper + + + JSON object with only a ObjectStateGroup property. @@ -12718,6 +12875,14 @@
    Types
    This class represents an Object state group value. + + + + + ObjectStateGroupWrapper + + + JSON object with only a ObjectStateGroup property. @@ -13185,6 +13350,14 @@
    Types
    This class represents a value for updating Object state groups. + + + + + ObjectStateGroupUpdateWrapper + + + JSON object with only a ObjectStateGroupUpdate property. @@ -13193,6 +13366,14 @@
    Types
    This class represents an Object state group value. + + + + + ObjectStateGroupWrapper + + + JSON object with only a ObjectStateGroup property. @@ -13246,11 +13427,11 @@
    Types

                                     <?xml version="1.0" encoding="UTF-8"?>
-<ObjectStateGroup>
+<ObjectStateGroupUpdate>
     <names>
         <value languageCode="eng-GB">New Custom State name</value>
     </names>
-</ObjectStateGroup>
+</ObjectStateGroupUpdate>
    @@ -13269,7 +13450,7 @@
    Types

                                     {
-    "ObjectStateGroup": {
+    "ObjectStateGroupUpdate": {
         "names": {
             "value": [
                 {
@@ -13350,11 +13531,11 @@ 
    Types
    
                                         
    
                                         
                                                 <?xml version="1.0" encoding="UTF-8"?>
-<ObjectStateGroup>
+<ObjectStateGroupUpdate>
     <names>
         <value languageCode="eng-GB">New Custom State name</value>
     </names>
-</ObjectStateGroup>
+</ObjectStateGroupUpdate>
 
                                         
    
                                     
@@ -13373,7 +13554,7 @@ 
    Types
    
                                         
    
                                         
                                                 {
-    "ObjectStateGroup": {
+    "ObjectStateGroupUpdate": {
         "names": {
             "value": [
                 {
@@ -13881,6 +14062,14 @@ 
    Types
    
                             
                         
                         List of Object states.
+                    
+                                    
+                        
+                            
+                                ObjectStateListWrapper
+                            
+                        
+                        JSON object with only a ObjectStateList property.
                     
                                 
             
@@ -14359,6 +14548,14 @@ 
    Types
    
                             
                         
                         This class represents a value for creating Object states.
+                    
+                                    
+                        
+                            
+                                ObjectStateCreateWrapper
+                            
+                        
+                        JSON object with only a ObjectStateCreate property.
                     
                                     
                         
@@ -14367,6 +14564,14 @@ 
    Types
    
                             
                         
                         This class represents a Object state value.
+                    
+                                    
+                        
+                            
+                                ObjectStateWrapper
+                            
+                        
+                        JSON object with only a ObjectState property.
                     
                                 
             
@@ -15041,6 +15246,14 @@ 
    Types
    
                             
                         
                         This class represents a Object state value.
+                    
+                                    
+                        
+                            
+                                ObjectStateWrapper
+                            
+                        
+                        JSON object with only a ObjectState property.
                     
                                 
             
@@ -15512,6 +15725,14 @@ 
    Types
    
                             
                         
                         This class represents a value for updating Object states.
+                    
+                                    
+                        
+                            
+                                ObjectStateUpdateWrapper
+                            
+                        
+                        JSON object with only a ObjectStateUpdate property.
                     
                                     
                         
@@ -15520,6 +15741,14 @@ 
    Types
    
                             
                         
                         This class represents a Object state value.
+                    
+                                    
+                        
+                            
+                                ObjectStateWrapper
+                            
+                        
+                        JSON object with only a ObjectState property.
                     
                                 
             
@@ -15573,13 +15802,13 @@ 
    Types
    
                             
    
                             
                                     <?xml version="1.0" encoding="UTF-8"?>
-<ObjectStateCreate>
+<ObjectStateUpdate>
   <priority>3</priority>
   <defaultLanguageCode>eng-GB</defaultLanguageCode>
   <names>
     <value languageCode="eng-GB">New Object State name</value>
   </names>
-</ObjectStateCreate>
+</ObjectStateUpdate>
 
                             
    
                         
@@ -15598,7 +15827,7 @@ 
    Types
    
                             
    
                             
                                     {
-    "ObjectStateGroup": {
+    "ObjectStateUpdate": {
         "names": {
             "value": [
                 {
@@ -15679,13 +15908,13 @@ 
    Types
    
                                         
    
                                         
                                                 <?xml version="1.0" encoding="UTF-8"?>
-<ObjectStateCreate>
+<ObjectStateUpdate>
   <priority>3</priority>
   <defaultLanguageCode>eng-GB</defaultLanguageCode>
   <names>
     <value languageCode="eng-GB">New Object State name</value>
   </names>
-</ObjectStateCreate>
+</ObjectStateUpdate>
 
                                         
    
                                     
@@ -15704,7 +15933,7 @@ 
    Types
    
                                         
    
                                         
                                                 {
-    "ObjectStateGroup": {
+    "ObjectStateUpdate": {
         "names": {
             "value": [
                 {
@@ -16262,6 +16491,14 @@ 
    Types
    
                             
                         
                         This class represents a Location in the Repository.
+                    
+                                    
+                        
+                            
+                                LocationWrapper
+                            
+                        
+                        JSON object with only a Location property.
                     
                                 
             
@@ -16801,6 +17038,14 @@ 
    Types
    
                             
                         
                         This class represents a Location in the Repository.
+                    
+                                    
+                        
+                            
+                                LocationWrapper
+                            
+                        
+                        JSON object with only a Location property.
                     
                                 
             
@@ -17598,11 +17843,19 @@ 
    Types
    
                 
                                     
                         
-                            
-                                LocationUpdateStruct
+                            
+                                LocationUpdate
                             
                         
                         This class is used for updating Location meta data.
+                    
+                                    
+                        
+                            
+                                LocationUpdateWrapper
+                            
+                        
+                        JSON object with only a LocationUpdate property.
                     
                                     
                         
@@ -17611,6 +17864,14 @@ 
    Types
    
                             
                         
                         This class represents a Location in the Repository.
+                    
+                                    
+                        
+                            
+                                LocationWrapper
+                            
+                        
+                        JSON object with only a Location property.
                     
                                 
             
@@ -18734,6 +18995,14 @@ 
    Types
    
                             
                         
                         List of URL alias in the Repository.
+                    
+                                    
+                        
+                            
+                                UrlAliasRefListWrapper
+                            
+                        
+                        JSON object with only a UrlAliasRefList property.
                     
                                 
             
@@ -19189,6 +19458,14 @@ 
    Types
    
                             
                         
                         
+                    
+                                    
+                        
+                            
+                                SectionInputWrapper
+                            
+                        
+                        JSON object with only a SectionInput property.
                     
                                     
                         
@@ -19197,6 +19474,14 @@ 
    Types
    
                             
                         
                         This class represents a Section.
+                    
+                                    
+                        
+                            
+                                SectionWrapper
+                            
+                        
+                        JSON object with only a Section property.
                     
                                 
             
@@ -19757,6 +20042,14 @@ 
    Types
    
                             
                         
                         This class represents a Section list.
+                    
+                                    
+                        
+                            
+                                SectionListWrapper
+                            
+                        
+                        JSON object with only a SectionList property.
                     
                                 
             
@@ -20242,6 +20535,14 @@ 
    Types
    
                             
                         
                         This class represents a Section.
+                    
+                                    
+                        
+                            
+                                SectionWrapper
+                            
+                        
+                        JSON object with only a Section property.
                     
                                 
             
@@ -20651,6 +20952,14 @@ 
    Types
    
                             
                         
                         
+                    
+                                    
+                        
+                            
+                                SectionInputWrapper
+                            
+                        
+                        JSON object with only a SectionInput property.
                     
                                     
                         
@@ -20659,6 +20968,14 @@ 
    Types
    
                             
                         
                         This class represents a Section.
+                    
+                                    
+                        
+                            
+                                SectionWrapper
+                            
+                        
+                        JSON object with only a Section property.
                     
                                 
             
@@ -21302,6 +21619,14 @@ 
    Types
    
                             
                         
                         
+                    
+                                    
+                        
+                            
+                                TrashWrapper
+                            
+                        
+                        JSON object with only a Trash property.
                     
                                 
             
@@ -21910,6 +22235,14 @@ 
    Types
    
                             
                         
                         This class represents a trash item, which is actually a trashed Location.
+                    
+                                    
+                        
+                            
+                                TrashItemWrapper
+                            
+                        
+                        JSON object with only a TrashItem property.
                     
                                 
             
@@ -22550,6 +22883,14 @@ 
    Types
    
                             
                         
                         List of URL alias in the Repository.
+                    
+                                    
+                        
+                            
+                                UrlAliasRefListWrapper
+                            
+                        
+                        JSON object with only a UrlAliasRefList property.
                     
                                 
             
@@ -22925,6 +23266,14 @@ 
    Types
    
                             
                         
                         
+                    
+                                    
+                        
+                            
+                                UrlAliasCreateWrapper
+                            
+                        
+                        JSON object with only a UrlAliasCreate property.
                     
                                     
                         
@@ -22933,6 +23282,14 @@ 
    Types
    
                             
                         
                         This class represents a URL alias in the Repository.
+                    
+                                    
+                        
+                            
+                                UrlAliasWrapper
+                            
+                        
+                        JSON object with only a UrlAlias property.
                     
                                 
             
@@ -23494,6 +23851,14 @@ 
    Types
    
                             
                         
                         This class represents a URL alias in the Repository.
+                    
+                                    
+                        
+                            
+                                UrlAliasWrapper
+                            
+                        
+                        JSON object with only a UrlAlias property.
                     
                                 
             
@@ -23928,6 +24293,14 @@ 
    Types
    
                             
                         
                         List of URL alias in the Repository.
+                    
+                                    
+                        
+                            
+                                UrlWildcardListWrapper
+                            
+                        
+                        JSON object with only a UrlWildcardList property.
                     
                                 
             
@@ -24319,6 +24692,14 @@ 
    Types
    
                             
                         
                         Creates a new URL wildcard.
+                    
+                                    
+                        
+                            
+                                UrlWildcardCreateWrapper
+                            
+                        
+                        JSON object with only a URLWildcardCreate property.
                     
                                     
                         
@@ -24327,6 +24708,14 @@ 
    Types
    
                             
                         
                         This class represents a URL alias in the Repository.
+                    
+                                    
+                        
+                            
+                                UrlWildcardWrapper
+                            
+                        
+                        JSON object with only a UrlWildcard property.
                     
                                 
             
@@ -24403,7 +24792,7 @@ 
    Types
    
                             
    
                             
                                     {
-    "UrlWildCardCreate": {
+    "URLWildcardCreate": {
         "sourceUrl": "/api/ibexa/v2/content/location/2",
         "destinationUrl": "/api/ibexa/v2/content/location/59",
         "forward": true
@@ -24503,7 +24892,7 @@ 
    Types
    
                                         
    
                                         
                                                 {
-    "UrlWildCardCreate": {
+    "URLWildcardCreate": {
         "sourceUrl": "/api/ibexa/v2/content/location/2",
         "destinationUrl": "/api/ibexa/v2/content/location/59",
         "forward": true
@@ -24862,6 +25251,14 @@ 
    Types
    
                             
                         
                         This class represents a URL alias in the Repository.
+                    
+                                    
+                        
+                            
+                                UrlWildcardWrapper
+                            
+                        
+                        JSON object with only a UrlWildcard property.
                     
                                 
             
@@ -25328,6 +25725,14 @@ 
    Types
    
                             
                         
                         List of content type groups.
+                    
+                                    
+                        
+                            
+                                ContentTypeGroupListWrapper
+                            
+                        
+                        JSON object with only a ContentTypeGroupList property.
                     
                                 
             
@@ -25803,6 +26208,14 @@ 
    Types
    
                             
                         
                         
+                    
+                                    
+                        
+                            
+                                ContentTypeGroupInputWrapper
+                            
+                        
+                        JSON object with only a ContentTypeGroupInput property.
                     
                                     
                         
@@ -25811,6 +26224,14 @@ 
    Types
    
                             
                         
                         This class represents a content type group value.
+                    
+                                    
+                        
+                            
+                                ContentTypeGroupWrapper
+                            
+                        
+                        JSON object with only a ContentTypeGroup property.
                     
                                 
             
@@ -26398,11 +26819,19 @@ 
    Types
    
                 
                                     
                         
-                            
-                                ContentTypeGroup
+                            
+                                ContentTypeList
                             
                         
-                        This class represents a content type group value.
+                        List of content types.
+                    
+                                    
+                        
+                            
+                                ContentTypeListWrapper
+                            
+                        
+                        JSON object with only a ContentTypeList property.
                     
                                 
             
@@ -29455,6 +29884,14 @@ 
    Types
    
                             
                         
                         
+                    
+                                    
+                        
+                            
+                                ContentTypeGroupInputWrapper
+                            
+                        
+                        JSON object with only a ContentTypeGroupInput property.
                     
                                     
                         
@@ -29463,6 +29900,14 @@ 
    Types
    
                             
                         
                         This class represents a content type group value.
+                    
+                                    
+                        
+                            
+                                ContentTypeGroupWrapper
+                            
+                        
+                        JSON object with only a ContentTypeGroup property.
                     
                                 
             
@@ -30091,6 +30536,14 @@ 
    Types
    
                             
                         
                         List of content type information.
+                    
+                                    
+                        
+                            
+                                ContentTypeInfoListWrapper
+                            
+                        
+                        JSON object with only a ContentTypeInfoList property.
                     
                                     
                         
@@ -30099,6 +30552,14 @@ 
    Types
    
                             
                         
                         List of content types.
+                    
+                                    
+                        
+                            
+                                ContentTypeListWrapper
+                            
+                        
+                        JSON object with only a ContentTypeList property.
                     
                                 
             
@@ -32579,6 +33040,14 @@ 
    Types
    
                             
                         
                         This class is used to create a content type.
+                    
+                                    
+                        
+                            
+                                ContentTypeCreateWrapper
+                            
+                        
+                        JSON object with only a ContentTypeCreate property.
                     
                                     
                         
@@ -32587,6 +33056,14 @@ 
    Types
    
                             
                         
                         This class represents a content type.
+                    
+                                    
+                        
+                            
+                                ContentTypeWrapper
+                            
+                        
+                        JSON object with only a ContentType property.
                     
                                 
             
@@ -33398,6 +33875,14 @@ 
    Types
    
                             
                         
                         List of content type information.
+                    
+                                    
+                        
+                            
+                                ContentTypeInfoListWrapper
+                            
+                        
+                        JSON object with only a ContentTypeInfoList property.
                     
                                     
                         
@@ -33406,6 +33891,14 @@ 
    Types
    
                             
                         
                         List of content types.
+                    
+                                    
+                        
+                            
+                                ContentTypeListWrapper
+                            
+                        
+                        JSON object with only a ContentTypeList property.
                     
                                 
             
@@ -35021,6 +35514,14 @@ 
    Types
    
                             
                         
                         This class represents a content type.
+                    
+                                    
+                        
+                            
+                                ContentTypeWrapper
+                            
+                        
+                        JSON object with only a ContentType property.
                     
                                 
             
@@ -35959,6 +36460,14 @@ 
    Types
    
                             
                         
                         This class is used to update a content type.
+                    
+                                    
+                        
+                            
+                                ContentTypeUpdateWrapper
+                            
+                        
+                        JSON object with only a ContentTypeUpdate property.
                     
                                     
                         
@@ -35967,6 +36476,14 @@ 
    Types
    
                             
                         
                         This class stores content type information.
+                    
+                                    
+                        
+                            
+                                ContentTypeInfoWrapper
+                            
+                        
+                        JSON object with only a ContentTypeInfo property.
                     
                                 
             
@@ -36639,6 +37156,14 @@ 
    Types
    
                             
                         
                         
+                    
+                                    
+                        
+                            
+                                FieldDefinitionsWrapper
+                            
+                        
+                        JSON object with only a FieldDefinitions property.
                     
                                 
             
@@ -36795,6 +37320,14 @@ 
    Types
    
                             
                         
                         This class represents a Field definition.
+                    
+                                    
+                        
+                            
+                                FieldDefinitionWrapper
+                            
+                        
+                        JSON object with only a FieldDefinition property.
                     
                                 
             
@@ -37252,6 +37785,14 @@ 
    Types
    
                             
                         
                         This class represents a content type.
+                    
+                                    
+                        
+                            
+                                ContentTypeWrapper
+                            
+                        
+                        JSON object with only a ContentType property.
                     
                                 
             
@@ -37446,6 +37987,14 @@ 
    Types
    
                             
                         
                         This class is used to update a content type.
+                    
+                                    
+                        
+                            
+                                ContentTypeUpdateWrapper
+                            
+                        
+                        JSON object with only a ContentTypeUpdate property.
                     
                                     
                         
@@ -37454,6 +38003,14 @@ 
    Types
    
                             
                         
                         This class stores content type information.
+                    
+                                    
+                        
+                            
+                                ContentTypeInfoWrapper
+                            
+                        
+                        JSON object with only a ContentTypeInfo property.
                     
                                 
             
@@ -37535,16 +38092,20 @@ 
    Types
    
                                 {
   "ContentTypeUpdate": {
     "names": {
-      "value": [ { 
-        "_languageCode": "eng-GB",
-        "#text": "Updated content type name"
-       } ]
+      "value": [
+        {
+          "_languageCode": "eng-GB",
+          "#text": "Updated content type name"
+        }
+      ]
     },
     "descriptions": {
-      "value": [ {
-        "_languageCode": "eng-GB",
-        "#text": "This is an updated content type description"
-      } ]
+      "value": [
+        {
+          "_languageCode": "eng-GB",
+          "#text": "This is an updated content type description"
+        }
+      ]
     }
   }
 }
@@ -37646,16 +38207,20 @@ 
    Types
    
                                             {
   "ContentTypeUpdate": {
     "names": {
-      "value": [ { 
-        "_languageCode": "eng-GB",
-        "#text": "Updated content type name"
-       } ]
+      "value": [
+        {
+          "_languageCode": "eng-GB",
+          "#text": "Updated content type name"
+        }
+      ]
     },
     "descriptions": {
-      "value": [ {
-        "_languageCode": "eng-GB",
-        "#text": "This is an updated content type description"
-      } ]
+      "value": [
+        {
+          "_languageCode": "eng-GB",
+          "#text": "This is an updated content type description"
+        }
+      ]
     }
   }
 }
@@ -38438,6 +39003,14 @@ 
    Types
    
                             
                         
                         
+                    
+                                    
+                        
+                            
+                                FieldDefinitionsWrapper
+                            
+                        
+                        JSON object with only a FieldDefinitions property.
                     
                                 
             
@@ -38624,6 +39197,14 @@ 
    Types
    
                             
                         
                         
+                    
+                                    
+                        
+                            
+                                FieldDefinitionCreateWrapper
+                            
+                        
+                        JSON object with only a FieldDefinitionCreate property.
                     
                                     
                         
@@ -38632,6 +39213,14 @@ 
    Types
    
                             
                         
                         This class represents a Field definition.
+                    
+                                    
+                        
+                            
+                                FieldDefinitionWrapper
+                            
+                        
+                        JSON object with only a FieldDefinition property.
                     
                                 
             
@@ -39070,6 +39659,14 @@ 
    Types
    
                             
                         
                         This class represents a Field definition.
+                    
+                                    
+                        
+                            
+                                FieldDefinitionWrapper
+                            
+                        
+                        JSON object with only a FieldDefinition property.
                     
                                 
             
@@ -39536,6 +40133,14 @@ 
    Types
    
                             
                         
                         
+                    
+                                    
+                        
+                            
+                                FieldDefinitionUpdateWrapper
+                            
+                        
+                        JSON object with only a FieldDefinitionUpdate property.
                     
                                     
                         
@@ -39544,6 +40149,14 @@ 
    Types
    
                             
                         
                         This class represents a Field definition.
+                    
+                                    
+                        
+                            
+                                FieldDefinitionWrapper
+                            
+                        
+                        JSON object with only a FieldDefinition property.
                     
                                 
             
@@ -40028,6 +40641,14 @@ 
    Types
    
                             
                         
                         List of content type groups references.
+                    
+                                    
+                        
+                            
+                                ContentTypeGroupRefListWrapper
+                            
+                        
+                        JSON object with only a ContentTypeGroupRefList property.
                     
                                 
             
@@ -40401,6 +41022,14 @@ 
    Types
    
                             
                         
                         List of content type groups references.
+                    
+                                    
+                        
+                            
+                                ContentTypeGroupRefListWrapper
+                            
+                        
+                        JSON object with only a ContentTypeGroupRefList property.
                     
                                 
             
@@ -40684,11 +41313,19 @@ 
    Types
    
                 
                                     
                         
-                            
-                                ContentTypeGroup
+                            
+                                ContentTypeGroupRefList
                             
                         
-                        This class represents a content type group value.
+                        List of content type groups references.
+                    
+                                    
+                        
+                            
+                                ContentTypeGroupRefListWrapper
+                            
+                        
+                        JSON object with only a ContentTypeGroupRefList property.
                     
                                 
             
@@ -41108,6 +41745,14 @@ 
    Types
    
                             
                         
                         This class represents a View input.
+                    
+                                    
+                        
+                            
+                                ViewInputWrapper
+                            
+                        
+                        JSON object with only a ViewInput property.
                     
                                     
                         
@@ -41846,6 +42491,14 @@ 
    Types
    
                             
                         
                         List of calendar events.
+                    
+                                    
+                        
+                            
+                                EventListWrapper
+                            
+                        
+                        JSON object with only a EventList property.
                     
                                 
             
@@ -42291,6 +42944,14 @@ 
    Types
    
                             
                         
                         Grouped calendar event list.
+                    
+                                    
+                        
+                            
+                                EventGroupListWrapper
+                            
+                        
+                        JSON object with only a EventGroupList property.
                     
                                 
             
@@ -42969,11 +43630,11 @@ 
    Types
    
                 
                                     
                         
-                            
-                                UnscheduleAction
+                            
+                                UnscheduleActionWrapper
                             
                         
-                        This class represents events to unschedule
+                        JSON object with only a UnscheduleAction property.
                     
                                 
             
@@ -43237,6 +43898,14 @@ 
    Types
    
                             
                         
                         This class represents a list of users.
+                    
+                                    
+                        
+                            
+                                UserListWrapper
+                            
+                        
+                        JSON object with only a UserList property.
                     
                                 
             
@@ -43899,6 +44568,14 @@ 
    Types
    
                             
                         
                         This class represents a User Group list.
+                    
+                                    
+                        
+                            
+                                UserGroupListWrapper
+                            
+                        
+                        JSON object with only a UserGroupList property.
                     
                                     
                         
@@ -43907,6 +44584,14 @@ 
    Types
    
                             
                         
                         Returns a list of the sub groups.
+                    
+                                    
+                        
+                            
+                                UserGroupRefListWrapper
+                            
+                        
+                        JSON object with only a UserGroupRefList property.
                     
                                 
             
@@ -44603,6 +45288,14 @@ 
    Types
    
                             
                         
                         This class is used to create a User Group.
+                    
+                                    
+                        
+                            
+                                UserGroupCreateWrapper
+                            
+                        
+                        JSON object with only a UserGroupCreate property.
                     
                                     
                         
@@ -44610,7 +45303,15 @@ 
    Types
    
                                 UserGroup
                             
                         
-                        This class represents a User group.
+                        Content ID matcher class.
+                    
+                                    
+                        
+                            
+                                UserGroupWrapper
+                            
+                        
+                        JSON object with only a UserGroup property.
                     
                                 
             
@@ -45416,7 +46117,15 @@ 
    Types
    
                                 UserGroup
                             
                         
-                        This class represents a User group.
+                        Content ID matcher class.
+                    
+                                    
+                        
+                            
+                                UserGroupWrapper
+                            
+                        
+                        JSON object with only a UserGroup property.
                     
                                 
             
@@ -46010,6 +46719,14 @@ 
    Types
    
                             
                         
                         This class is used to update a User group in the Repository.
+                    
+                                    
+                        
+                            
+                                UserGroupUpdateWrapper
+                            
+                        
+                        JSON object with only a UserGroupUpdate property.
                     
                                     
                         
@@ -46017,7 +46734,15 @@ 
    Types
    
                                 UserGroup
                             
                         
-                        This class represents a User group.
+                        Content ID matcher class.
+                    
+                                    
+                        
+                            
+                                UserGroupWrapper
+                            
+                        
+                        JSON object with only a UserGroup property.
                     
                                 
             
@@ -46974,6 +47699,14 @@ 
    Types
    
                             
                         
                         Returns a list of the users.
+                    
+                                    
+                        
+                            
+                                UserRefListWrapper
+                            
+                        
+                        JSON object with only a UserRefList property.
                     
                                 
             
@@ -47367,6 +48100,14 @@ 
    Types
    
                             
                         
                         This class is used to create a User.
+                    
+                                    
+                        
+                            
+                                UserCreateWrapper
+                            
+                        
+                        JSON object with only a UserCreate property.
                     
                                     
                         
@@ -47375,6 +48116,14 @@ 
    Types
    
                             
                         
                         This class represents a User value.
+                    
+                                    
+                        
+                            
+                                UserWrapper
+                            
+                        
+                        JSON object with only a User property.
                     
                                 
             
@@ -48304,6 +49053,14 @@ 
    Types
    
                             
                         
                         This class represents a User Group list.
+                    
+                                    
+                        
+                            
+                                UserGroupListWrapper
+                            
+                        
+                        JSON object with only a UserGroupList property.
                     
                                     
                         
@@ -48312,6 +49069,14 @@ 
    Types
    
                             
                         
                         Returns a list of the sub groups.
+                    
+                                    
+                        
+                            
+                                UserGroupRefListWrapper
+                            
+                        
+                        JSON object with only a UserGroupRefList property.
                     
                                 
             
@@ -48679,6 +49444,14 @@ 
    Types
    
                             
                         
                         This class is used to create a User Group.
+                    
+                                    
+                        
+                            
+                                UserGroupCreateWrapper
+                            
+                        
+                        JSON object with only a UserGroupCreate property.
                     
                                     
                         
@@ -48686,7 +49459,15 @@ 
    Types
    
                                 UserGroup
                             
                         
-                        This class represents a User group.
+                        Content ID matcher class.
+                    
+                                    
+                        
+                            
+                                UserGroupWrapper
+                            
+                        
+                        JSON object with only a UserGroup property.
                     
                                 
             
@@ -49443,6 +50224,14 @@ 
    Types
    
                             
                         
                         This value object represents a list of assignments of a User or User group to a role including a limitation.
+                    
+                                    
+                        
+                            
+                                RoleAssignmentListWrapper
+                            
+                        
+                        JSON object with only a RoleAssignmentList property.
                     
                                 
             
@@ -49729,6 +50518,14 @@ 
    Types
    
                             
                         
                         This class represents a Role assign input.
+                    
+                                    
+                        
+                            
+                                RoleAssignInputWrapper
+                            
+                        
+                        JSON object with only a RoleAssignInput property.
                     
                                     
                         
@@ -49737,6 +50534,14 @@ 
    Types
    
                             
                         
                         This value object represents a list of assignments of a User or User group to a role including a limitation.
+                    
+                                    
+                        
+                            
+                                RoleAssignmentListWrapper
+                            
+                        
+                        JSON object with only a RoleAssignmentList property.
                     
                                 
             
@@ -49819,23 +50624,19 @@ 
    Types
    
                                 {
   "RoleAssignInput": {
     "Role": {
-      "_href": "/api/ibexa/v2/user/roles/2",
-      "media-type": "application/vnd.ibexa.api.RoleAssignInput+json",
-      "self-closing": "true"
+      "_href": "/api/ibexa/v2/user/roles/2"
     },
-    "Limitation": {
-      "identifier": "Section",
+    "limitation": {
+      "_identifier": "Section",
       "values": {
         "ref": [
           {
             "_href": "/api/ibexa/v2/content/sections/1",
-            "media-type": "application/vnd.ibexa.api.Section+json",
-            "self-closing": "true"
+            "_media-type": "application/vnd.ibexa.api.Section+json"
           },
           {
             "_href": "/api/ibexa/v2/content/sections/4",
-            "media-type": "application/vnd.ibexa.api.Section+json",
-            "self-closing": "true"
+            "_media-type": "application/vnd.ibexa.api.Section+json"
           }
         ]
       }
@@ -49942,23 +50743,19 @@ 
    Types
    
                                             {
   "RoleAssignInput": {
     "Role": {
-      "_href": "/api/ibexa/v2/user/roles/2",
-      "media-type": "application/vnd.ibexa.api.RoleAssignInput+json",
-      "self-closing": "true"
+      "_href": "/api/ibexa/v2/user/roles/2"
     },
-    "Limitation": {
-      "identifier": "Section",
+    "limitation": {
+      "_identifier": "Section",
       "values": {
         "ref": [
           {
             "_href": "/api/ibexa/v2/content/sections/1",
-            "media-type": "application/vnd.ibexa.api.Section+json",
-            "self-closing": "true"
+            "_media-type": "application/vnd.ibexa.api.Section+json"
           },
           {
             "_href": "/api/ibexa/v2/content/sections/4",
-            "media-type": "application/vnd.ibexa.api.Section+json",
-            "self-closing": "true"
+            "_media-type": "application/vnd.ibexa.api.Section+json"
           }
         ]
       }
@@ -50355,6 +51152,14 @@ 
    Types
    
                             
                         
                         This value object represents an assignment of a User or User group to a role including a limitation.
+                    
+                                    
+                        
+                            
+                                RoleAssignmentWrapper
+                            
+                        
+                        JSON object with only a RoleAssignment property.
                     
                                 
             
@@ -50674,6 +51479,14 @@ 
    Types
    
                             
                         
                         This value object represents a list of assignments of a User or User group to a role including a limitation.
+                    
+                                    
+                        
+                            
+                                RoleAssignmentListWrapper
+                            
+                        
+                        JSON object with only a RoleAssignmentList property.
                     
                                 
             
@@ -51155,6 +51968,14 @@ 
    Types
    
                             
                         
                         This class represents a list of users.
+                    
+                                    
+                        
+                            
+                                UserListWrapper
+                            
+                        
+                        JSON object with only a UserList property.
                     
                                     
                         
@@ -51163,6 +51984,14 @@ 
    Types
    
                             
                         
                         Returns a list of the users.
+                    
+                                    
+                        
+                            
+                                UserRefListWrapper
+                            
+                        
+                        JSON object with only a UserRefList property.
                     
                                 
             
@@ -51970,6 +52799,14 @@ 
    Types
    
                             
                         
                         This class represents a list of users.
+                    
+                                    
+                        
+                            
+                                UserListWrapper
+                            
+                        
+                        JSON object with only a UserList property.
                     
                                 
             
@@ -52637,6 +53474,14 @@ 
    Types
    
                             
                         
                         This class is used to update a User.
+                    
+                                    
+                        
+                            
+                                UserUpdateWrapper
+                            
+                        
+                        JSON object with only a UserUpdate property.
                     
                                     
                         
@@ -52645,6 +53490,14 @@ 
    Types
    
                             
                         
                         This class represents a User value.
+                    
+                                    
+                        
+                            
+                                UserWrapper
+                            
+                        
+                        JSON object with only a User property.
                     
                                 
             
@@ -53548,6 +54401,14 @@ 
    Types
    
                             
                         
                         Returns a list of the sub groups.
+                    
+                                    
+                        
+                            
+                                UserGroupRefListWrapper
+                            
+                        
+                        JSON object with only a UserGroupRefList property.
                     
                                 
             
@@ -53850,6 +54711,14 @@ 
    Types
    
                             
                         
                         Returns a list of the sub groups.
+                    
+                                    
+                        
+                            
+                                UserGroupRefListWrapper
+                            
+                        
+                        JSON object with only a UserGroupRefList property.
                     
                                 
             
@@ -54237,6 +55106,14 @@ 
    Types
    
                             
                         
                         Returns a list of the sub groups.
+                    
+                                    
+                        
+                            
+                                UserGroupRefListWrapper
+                            
+                        
+                        JSON object with only a UserGroupRefList property.
                     
                                 
             
@@ -54512,6 +55389,14 @@ 
    Types
    
                             
                         
                         This value object represents a list of assignments of a User or User group to a role including a limitation.
+                    
+                                    
+                        
+                            
+                                RoleAssignmentListWrapper
+                            
+                        
+                        JSON object with only a RoleAssignmentList property.
                     
                                 
             
@@ -54923,6 +55808,14 @@ 
    Types
    
                             
                         
                         This class represents a Role assign input.
+                    
+                                    
+                        
+                            
+                                RoleAssignInputWrapper
+                            
+                        
+                        JSON object with only a RoleAssignInput property.
                     
                                     
                         
@@ -54931,6 +55824,14 @@ 
    Types
    
                             
                         
                         This value object represents a list of assignments of a User or User group to a role including a limitation.
+                    
+                                    
+                        
+                            
+                                RoleAssignmentListWrapper
+                            
+                        
+                        JSON object with only a RoleAssignmentList property.
                     
                                 
             
@@ -55013,23 +55914,17 @@ 
    Types
    
                                 {
   "RoleAssignInput": {
     "Role": {
-      "_href": "/api/ibexa/v2/user/roles/2",
-      "_media-type": "application/vnd.ibexa.api.RoleAssignInput+xml",
-      "self-closing": "true"
+      "_href": "/api/ibexa/v2/user/roles/2"
     },
     "limitation": {
       "_identifier": "Section",
       "values": {
         "ref": [
           {
-            "_href": "/api/ibexa/v2/content/sections/1",
-            "media-type": "application/vnd.ibexa.api.Section+xml",
-            "self-closing": "true"
+            "_href": "/api/ibexa/v2/content/sections/1"
           },
           {
-            "_href": "/api/ibexa/v2/content/sections/2",
-            "_media-type": "application/vnd.ibexa.api.Section+xml",
-            "self-closing": "true"
+            "_href": "/api/ibexa/v2/content/sections/2"
           }
         ]
       }
@@ -55136,23 +56031,17 @@ 
    Types
    
                                             {
   "RoleAssignInput": {
     "Role": {
-      "_href": "/api/ibexa/v2/user/roles/2",
-      "_media-type": "application/vnd.ibexa.api.RoleAssignInput+xml",
-      "self-closing": "true"
+      "_href": "/api/ibexa/v2/user/roles/2"
     },
     "limitation": {
       "_identifier": "Section",
       "values": {
         "ref": [
           {
-            "_href": "/api/ibexa/v2/content/sections/1",
-            "media-type": "application/vnd.ibexa.api.Section+xml",
-            "self-closing": "true"
+            "_href": "/api/ibexa/v2/content/sections/1"
           },
           {
-            "_href": "/api/ibexa/v2/content/sections/2",
-            "_media-type": "application/vnd.ibexa.api.Section+xml",
-            "self-closing": "true"
+            "_href": "/api/ibexa/v2/content/sections/2"
           }
         ]
       }
@@ -55579,6 +56468,14 @@ 
    Types
    
                             
                         
                         This value object represents an assignment of a User or User group to a role including a limitation.
+                    
+                                    
+                        
+                            
+                                RoleAssignmentWrapper
+                            
+                        
+                        JSON object with only a RoleAssignment property.
                     
                                 
             
@@ -55930,6 +56827,14 @@ 
    Types
    
                             
                         
                         This value object represents a list of assignments of a User or User group to a role including a limitation.
+                    
+                                    
+                        
+                            
+                                RoleAssignmentListWrapper
+                            
+                        
+                        JSON object with only a RoleAssignmentList property.
                     
                                 
             
@@ -56514,6 +57419,14 @@ 
    Types
    
                             
                         
                         List of all versions of the content.
+                    
+                                    
+                        
+                            
+                                VersionListWrapper
+                            
+                        
+                        JSON object with only a VersionList property.
                     
                                 
             
@@ -56742,6 +57655,14 @@ 
    Types
    
                             
                         
                         This class represents a list roles.
+                    
+                                    
+                        
+                            
+                                RoleListWrapper
+                            
+                        
+                        JSON object with only a RoleList property.
                     
                                 
             
@@ -57253,6 +58174,14 @@ 
    Types
    
                             
                         
                         This class represents a Role input.
+                    
+                                    
+                        
+                            
+                                RoleInputWrapper
+                            
+                        
+                        JSON object with only a RoleInput property.
                     
                                     
                         
@@ -57261,6 +58190,14 @@ 
    Types
    
                             
                         
                         This class represents a role.
+                    
+                                    
+                        
+                            
+                                RoleWrapper
+                            
+                        
+                        JSON object with only a Role property.
                     
                                 
             
@@ -57826,6 +58763,14 @@ 
    Types
    
                             
                         
                         This class represents a role.
+                    
+                                    
+                        
+                            
+                                RoleWrapper
+                            
+                        
+                        JSON object with only a Role property.
                     
                                 
             
@@ -58185,6 +59130,14 @@ 
    Types
    
                             
                         
                         This class represents a draft of a role, extends Role.
+                    
+                                    
+                        
+                            
+                                RoleDraftWrapper
+                            
+                        
+                        JSON object with only a Role property.
                     
                                 
             
@@ -58588,6 +59541,14 @@ 
    Types
    
                             
                         
                         This class represents a Role input.
+                    
+                                    
+                        
+                            
+                                RoleInputWrapper
+                            
+                        
+                        JSON object with only a RoleInput property.
                     
                                     
                         
@@ -58596,6 +59557,14 @@ 
    Types
    
                             
                         
                         This class represents a role.
+                    
+                                    
+                        
+                            
+                                RoleWrapper
+                            
+                        
+                        JSON object with only a Role property.
                     
                                 
             
@@ -59224,6 +60193,14 @@ 
    Types
    
                             
                         
                         This class represents a role.
+                    
+                                    
+                        
+                            
+                                RoleWrapper
+                            
+                        
+                        JSON object with only a Role property.
                     
                                 
             
@@ -59635,6 +60612,14 @@ 
    Types
    
                             
                         
                         This class represents a Role input.
+                    
+                                    
+                        
+                            
+                                RoleInputWrapper
+                            
+                        
+                        JSON object with only a RoleInput property.
                     
                                     
                         
@@ -59643,6 +60628,14 @@ 
    Types
    
                             
                         
                         This class represents a role.
+                    
+                                    
+                        
+                            
+                                RoleWrapper
+                            
+                        
+                        JSON object with only a Role property.
                     
                                 
             
@@ -60313,6 +61306,14 @@ 
    Types
    
                             
                         
                         List of policies.
+                    
+                                    
+                        
+                            
+                                PolicyListWrapper
+                            
+                        
+                        JSON object with only a PolicyList property.
                     
                                 
             
@@ -60917,6 +61918,14 @@ 
    Types
    
                             
                         
                         This class is used to create a Policy.
+                    
+                                    
+                        
+                            
+                                PolicyCreateWrapper
+                            
+                        
+                        JSON object with only a PolicyCreate property.
                     
                                     
                         
@@ -60925,6 +61934,14 @@ 
    Types
    
                             
                         
                         This class represents a policy value.
+                    
+                                    
+                        
+                            
+                                PolicyWrapper
+                            
+                        
+                        JSON object with only a Policy property.
                     
                                 
             
@@ -61449,6 +62466,14 @@ 
    Types
    
                             
                         
                         This class is used to update a Policy.
+                    
+                                    
+                        
+                            
+                                PolicyUpdateWrapper
+                            
+                        
+                        JSON object with only a PolicyUpdate property.
                     
                                     
                         
@@ -61457,6 +62482,14 @@ 
    Types
    
                             
                         
                         This class represents a policy value.
+                    
+                                    
+                        
+                            
+                                PolicyWrapper
+                            
+                        
+                        JSON object with only a Policy property.
                     
                                 
             
@@ -61891,6 +62924,14 @@ 
    Types
    
                             
                         
                         This class represents a policy value.
+                    
+                                    
+                        
+                            
+                                PolicyWrapper
+                            
+                        
+                        JSON object with only a Policy property.
                     
                                 
             
@@ -62358,6 +63399,14 @@ 
    Types
    
                             
                         
                         List of policies.
+                    
+                                    
+                        
+                            
+                                PolicyListWrapper
+                            
+                        
+                        JSON object with only a PolicyList property.
                     
                                 
             
@@ -62986,6 +64035,14 @@ 
    Types
    
                             
                         
                         This class represents a session input.
+                    
+                                    
+                        
+                            
+                                SessionInputWrapper
+                            
+                        
+                        JSON object with only a SessionInput property.
                     
                                     
                         
@@ -62994,6 +64051,14 @@ 
    Types
    
                             
                         
                         Value for session.
+                    
+                                    
+                        
+                            
+                                SessionWrapper
+                            
+                        
+                        JSON object with only a Session property.
                     
                                 
             
@@ -63741,6 +64806,14 @@ 
    Types
    
                             
                         
                         Value for session.
+                    
+                                    
+                        
+                            
+                                SessionWrapper
+                            
+                        
+                        JSON object with only a Session property.
                     
                                 
             
@@ -64274,6 +65347,14 @@ 
    Types
    
                             
                         
                         Value for session.
+                    
+                                    
+                        
+                            
+                                SessionWrapper
+                            
+                        
+                        JSON object with only a Session property.
                     
                                 
             
@@ -64654,6 +65735,14 @@ 
    Types
    
                             
                         
                         This class represents the input for a JWT authentication token
+                    
+                                    
+                        
+                            
+                                JWTInputWrapper
+                            
+                        
+                        JSON object with only a JWTInput property.
                     
                                     
                         
@@ -64662,6 +65751,14 @@ 
    Types
    
                             
                         
                         This class represents the JWT authentication token
+                    
+                                    
+                        
+                            
+                                JWTWrapper
+                            
+                        
+                        JSON object with only a JWT property.
                     
                                 
             
@@ -65180,6 +66277,14 @@ 
    Types
    
                             
                         
                         This class represents a segment.
+                    
+                                    
+                        
+                            
+                                SegmentWrapper
+                            
+                        
+                        JSON object with only a Segment property.
                     
                                 
             
@@ -65337,6 +66442,14 @@ 
    Types
    
                             
                         
                         This class lists segment groups.
+                    
+                                    
+                        
+                            
+                                SegmentGroupListWrapper
+                            
+                        
+                        JSON object with only a SegmentGroupList property.
                     
                                     
                         
@@ -65708,6 +66821,14 @@ 
    Types
    
                             
                         
                         This class represents a segment group.
+                    
+                                    
+                        
+                            
+                                SegmentGroupWrapper
+                            
+                        
+                        JSON object with only a SegmentGroup property.
                     
                                 
             
@@ -66049,6 +67170,14 @@ 
    Types
    
                             
                         
                         This class lists segments.
+                    
+                                    
+                        
+                            
+                                SegmentListWrapper
+                            
+                        
+                        JSON object with only a SegmentList property.
                     
                                 
             
@@ -66368,6 +67497,14 @@ 
    Types
    
                             
                         
                         This class is representing an ISO-3166 formatted list of world countries.
+                    
+                                    
+                        
+                            
+                                CountryListWrapper
+                            
+                        
+                        JSON object with only a CountryList property.
                     
                                 
             
@@ -68120,6 +69257,14 @@ 
    Types
    
                             
                         
                         List of languages.
+                    
+                                    
+                        
+                            
+                                LanguageListWrapper
+                            
+                        
+                        JSON object with only a LanguageList property.
                     
                                 
             
@@ -68484,6 +69629,14 @@ 
    Types
    
                             
                         
                         This class represents a language in the Repository.
+                    
+                                    
+                        
+                            
+                                LanguageWrapper
+                            
+                        
+                        JSON object with only a Language property.
                     
                                 
             
@@ -68861,6 +70014,14 @@ 
    Types
    
                             
                         
                         This class represents a new Cart to create
+                    
+                                    
+                        
+                            
+                                CartCreateWrapper
+                            
+                        
+                        JSON object with only a CartCreate property.
                     
                                     
                         
@@ -68869,6 +70030,14 @@ 
    Types
    
                             
                         
                         This class represents a Cart
+                    
+                                    
+                        
+                            
+                                CartWrapper
+                            
+                        
+                        JSON object with only a Cart property.
                     
                                 
             
@@ -69310,6 +70479,14 @@ 
    Types
    
                             
                         
                         This class represents a cart view input.
+                    
+                                    
+                        
+                            
+                                CartViewInputWrapper
+                            
+                        
+                        JSON object with only a CartViewInput property.
                     
                                     
                         
@@ -69318,6 +70495,14 @@ 
    Types
    
                             
                         
                         This class represents a cart view.
+                    
+                                    
+                        
+                            
+                                CartViewWrapper
+                            
+                        
+                        JSON object with only a CartView property.
                     
                                 
             
@@ -69611,6 +70796,14 @@ 
    Types
    
                             
                         
                         This class represents a Cart
+                    
+                                    
+                        
+                            
+                                CartWrapper
+                            
+                        
+                        JSON object with only a Cart property.
                     
                                 
             
@@ -69883,6 +71076,14 @@ 
    Types
    
                             
                         
                         This class represents the update of cart metadata.
+                    
+                                    
+                        
+                            
+                                CartMetadataUpdateWrapper
+                            
+                        
+                        JSON object with only a CartMetadataUpdate property.
                     
                                 
             
@@ -69995,6 +71196,14 @@ 
    Types
    
                             
                         
                         This class represents a cart entry
+                    
+                                    
+                        
+                            
+                                CartEntryAddWrapper
+                            
+                        
+                        JSON object with only a CartEntryAdd property.
                     
                                 
             
@@ -70258,6 +71467,14 @@ 
    Types
    
                             
                         
                         
+                    
+                                    
+                        
+                            
+                                CartEntryUpdateWrapper
+                            
+                        
+                        JSON object with only a CartEntryUpdate property.
                     
                                 
             
@@ -70495,6 +71712,14 @@ 
    Types
    
                             
                         
                         This class represents a cart summary.
+                    
+                                    
+                        
+                            
+                                CartSummaryWrapper
+                            
+                        
+                        JSON object with only a CartSummary property.
                     
                                 
             
@@ -71146,11 +72371,11 @@ 
    Types
    
                 
                                     
                         
-                            
-                                BasketListResponse
+                            
+                                BasketListResponseWrapper
                             
                         
-                        Removed
+                        JSON object with only a BasketListResponse property.
                     
                                     
                         
@@ -71474,11 +72699,11 @@ 
    Types
    
                 
                                     
                         
-                            
-                                Basket
+                            
+                                BasketWrapper
                             
                         
-                        Removed
+                        JSON object with only a Basket property.
                     
                                 
             
@@ -71937,19 +73162,19 @@ 
    Types
    
                 
                                     
                         
-                            
-                                Basket
+                            
+                                BasketWrapper
                             
                         
-                        Removed
+                        JSON object with only a Basket property.
                     
                                     
                         
-                            
-                                ValidationResponse
+                            
+                                ValidationResponseWrapper
                             
                         
-                        Removed
+                        JSON object with only a ValidationResponse property.
                     
                                 
             
@@ -72615,27 +73840,27 @@ 
    Types
    
                 
                                     
                         
-                            
-                                PartyTypeInput
+                            
+                                PartyTypeInputWrapper
                             
                         
-                        Removed
+                        JSON object with only a PartyData property.
                     
                                     
                         
-                            
-                                Basket
+                            
+                                BasketWrapper
                             
                         
-                        Removed
+                        JSON object with only a Basket property.
                     
                                     
                         
-                            
-                                ValidationResponse
+                            
+                                ValidationResponseWrapper
                             
                         
-                        Removed
+                        JSON object with only a ValidationResponse property.
                     
                                 
             
@@ -73299,19 +74524,19 @@ 
    Types
    
                     
                                     
                         
-                            
-                                Basket
+                            
+                                BasketWrapper
                             
                         
-                        Removed
+                        JSON object with only a Basket property.
                     
                                     
                         
-                            
-                                ValidationResponse
+                            
+                                ValidationResponseWrapper
                             
                         
-                        Removed
+                        JSON object with only a ValidationResponse property.
                     
                                 
             
@@ -73885,27 +75110,27 @@ 
    Types
    
                 
                                     
                         
-                            
-                                PaymentMethodData
+                            
+                                PaymentMethodDataWrapper
                             
                         
-                        Removed
+                        JSON object with only a PaymentMethodData property.
                     
                                     
                         
-                            
-                                Basket
+                            
+                                BasketWrapper
                             
                         
-                        Removed
+                        JSON object with only a Basket property.
                     
                                     
                         
-                            
-                                ValidationResponse
+                            
+                                ValidationResponseWrapper
                             
                         
-                        Removed
+                        JSON object with only a ValidationResponse property.
                     
                                 
             
@@ -74479,27 +75704,27 @@ 
    Types
    
                 
                                     
                         
-                            
-                                VoucherData
+                            
+                                VoucherDataWrapper
                             
                         
-                        Removed
+                        JSON object with only a VoucherData property.
                     
                                     
                         
-                            
-                                Basket
+                            
+                                BasketWrapper
                             
                         
-                        Removed
+                        JSON object with only a Basket property.
                     
                                     
                         
-                            
-                                ValidationResponse
+                            
+                                ValidationResponseWrapper
                             
                         
-                        Removed
+                        JSON object with only a ValidationResponse property.
                     
                                 
             
@@ -75073,27 +76298,27 @@ 
    Types
    
                 
                                     
                         
-                            
-                                BasketLineData
+                            
+                                BasketLineDataWrapper
                             
                         
-                        Removed
+                        JSON object with only a BasketLineData property.
                     
                                     
                         
-                            
-                                Basket
+                            
+                                BasketWrapper
                             
                         
-                        Removed
+                        JSON object with only a Basket property.
                     
                                     
                         
-                            
-                                ValidationResponse
+                            
+                                ValidationResponseWrapper
                             
                         
-                        Removed
+                        JSON object with only a ValidationResponse property.
                     
                                 
             
@@ -75793,11 +77018,11 @@ 
    Types
    
                 
                                     
                         
-                            
-                                Basket
+                            
+                                BasketWrapper
                             
                         
-                        Removed
+                        JSON object with only a Basket property.
                     
                                 
             
@@ -76148,19 +77373,19 @@ 
    Types
    
                 
                                     
                         
-                            
-                                BasketHeaderData
+                            
+                                BasketHeaderDataWrapper
                             
                         
-                        Removed
+                        JSON object with only a BasketHeaderData property.
                     
                                     
                         
-                            
-                                Basket
+                            
+                                BasketWrapper
                             
                         
-                        Removed
+                        JSON object with only a Basket property.
                     
                                 
             
@@ -76718,19 +77943,19 @@ 
    Types
    
                 
                                     
                         
-                            
-                                BasketHeaderData
+                            
+                                BasketHeaderDataWrapper
                             
                         
-                        Removed
+                        JSON object with only a BasketHeaderData property.
                     
                                     
                         
-                            
-                                Basket
+                            
+                                BasketWrapper
                             
                         
-                        Removed
+                        JSON object with only a Basket property.
                     
                                 
             
@@ -77298,27 +78523,27 @@ 
    Types
    
                 
                                     
                         
-                            
-                                BasketLineData
+                            
+                                BasketLineDataWrapper
                             
                         
-                        Removed
+                        JSON object with only a BasketLineData property.
                     
                                     
                         
-                            
-                                Basket
+                            
+                                BasketWrapper
                             
                         
-                        Removed
+                        JSON object with only a Basket property.
                     
                                     
                         
-                            
-                                ValidationResponse
+                            
+                                ValidationResponseWrapper
                             
                         
-                        Removed
+                        JSON object with only a ValidationResponse property.
                     
                                 
             
@@ -78022,19 +79247,19 @@ 
    Types
    
                 
                                     
                         
-                            
-                                Basket
+                            
+                                BasketWrapper
                             
                         
-                        Removed
+                        JSON object with only a Basket property.
                     
                                     
                         
-                            
-                                ValidationResponse
+                            
+                                ValidationResponseWrapper
                             
                         
-                        Removed
+                        JSON object with only a ValidationResponse property.
                     
                                 
             
@@ -78616,19 +79841,19 @@ 
    Types
    
                 
                                     
                         
-                            
-                                Basket
+                            
+                                BasketWrapper
                             
                         
-                        Removed
+                        JSON object with only a Basket property.
                     
                                     
                         
-                            
-                                ValidationResponse
+                            
+                                ValidationResponseWrapper
                             
                         
-                        Removed
+                        JSON object with only a ValidationResponse property.
                     
                                 
             
@@ -79202,11 +80427,11 @@ 
    Types
    
                 
                                     
                         
-                            
-                                PaymentMethodDataResponse
+                            
+                                PaymentMethodDataResponseWrapper
                             
                         
-                        Removed
+                        JSON object with only a PaymentMethodDataResponse property.
                     
                                 
             
@@ -79421,11 +80646,11 @@ 
    Types
    
                 
                                     
                         
-                            
-                                ShippingMethodDataResponse
+                            
+                                ShippingMethodDataResponseWrapper
                             
                         
-                        Removed
+                        JSON object with only a ShippingMethodDataResponse property.
                     
                                 
             
@@ -79645,11 +80870,11 @@ 
    Types
    
                 
                                     
                         
-                            
-                                ShippingAddressesResponse
+                            
+                                ShippingAddressesResponseWrapper
                             
                         
-                        Removed
+                        JSON object with only a ShippingAddressesResponse property.
                     
                                 
             
@@ -79925,19 +81150,19 @@ 
    Types
    
                 
                                     
                         
-                            
-                                CustomerPriceData
+                            
+                                CustomerPriceDataWrapper
                             
                         
-                        Removed
+                        
                     
                                     
                         
-                            
-                                PriceResponse
+                            
+                                PriceResponseWrapper
                             
                         
-                        Removed
+                        JSON object with only a PriceResponse property.
                     
                                 
             
@@ -80314,11 +81539,11 @@ 
    Types
    
                 
                                     
                         
-                            
-                                CountrySelectionResponse
+                            
+                                CountrySelectionResponseWrapper
                             
                         
-                        Removed
+                        JSON object with only a CountrySelectionResponse property.
                     
                                 
             
@@ -80729,19 +81954,19 @@ 
    Types
    
                 
                                     
                         
-                            
-                                OrderCreate
+                            
+                                OrderCreateWrapper
                             
                         
-                        This class is used to create order.
+                        JSON object with only a OrderCreate property.
                     
                                     
                         
-                            
-                                Order
+                            
+                                OrderWrapper
                             
                         
-                        This class represents order.
+                        JSON object with only a Order property.
                     
                                 
             
@@ -81280,6 +82505,14 @@ 
    Types
    
                             
                         
                         This class represents an orders list.
+                    
+                                    
+                        
+                            
+                                OrderListWrapper
+                            
+                        
+                        JSON object with only a OrderList property.
                     
                                 
             
@@ -81746,6 +82979,14 @@ 
    Types
    
                             
                         
                         This class represents order.
+                    
+                                    
+                        
+                            
+                                OrderWrapper
+                            
+                        
+                        JSON object with only a Order property.
                     
                                 
             
@@ -82167,6 +83408,14 @@ 
    Types
    
                             
                         
                         This class represents a list of Shipments
+                    
+                                    
+                        
+                            
+                                ShipmentRefListWrapper
+                            
+                        
+                        JSON object with only a ShipmentRefList property.
                     
                                 
             
@@ -82548,6 +83797,14 @@ 
    Types
    
                             
                         
                         This class represents the creation of a shipment.
+                    
+                                    
+                        
+                            
+                                ShipmentCreateWrapper
+                            
+                        
+                        JSON object with only a ShipmentCreate property.
                     
                                     
                         
@@ -82556,6 +83813,14 @@ 
    Types
    
                             
                         
                         This class represents a single shipment.
+                    
+                                    
+                        
+                            
+                                ShipmentWrapper
+                            
+                        
+                        JSON object with only a Shipment property.
                     
                                 
             
@@ -82946,6 +84211,14 @@ 
    Types
    
                             
                         
                         This class represents order.
+                    
+                                    
+                        
+                            
+                                OrderWrapper
+                            
+                        
+                        JSON object with only a Order property.
                     
                                 
             
@@ -83391,11 +84664,19 @@ 
    Types
    
                 
                                     
                         
-                            
-                                OrderUpdate
+                            
+                                OrderUpdateWrapper
+                            
+                        
+                        JSON object with only a OrderUpdate property.
+                    
+                                    
+                        
+                            
+                                OrderWrapper
                             
                         
-                        This class is used to update order.
+                        JSON object with only a Order property.
                     
                                 
             
@@ -84062,6 +85343,14 @@ 
    Types
    
                             
                         
                         
+                    
+                                    
+                        
+                            
+                                PaymentMethodCreateStructWrapper
+                            
+                        
+                        JSON object with only a PaymentMethodCreateStruct property.
                     
                                     
                         
@@ -84070,6 +85359,14 @@ 
    Types
    
                             
                         
                         
+                    
+                                    
+                        
+                            
+                                PaymentMethodWrapper
+                            
+                        
+                        JSON object with only a PaymentMethod property.
                     
                                 
             
@@ -84562,6 +85859,14 @@ 
    Types
    
                             
                         
                         
+                    
+                                    
+                        
+                            
+                                PaymentMethodViewInputWrapper
+                            
+                        
+                        JSON object with only a PaymentMethodViewInput property.
                     
                                     
                         
@@ -84570,6 +85875,14 @@ 
    Types
    
                             
                         
                         
+                    
+                                    
+                        
+                            
+                                PaymentMethodViewWrapper
+                            
+                        
+                        JSON object with only a PaymentMethodView property.
                     
                                 
             
@@ -85012,11 +86325,11 @@ 
    Types
    
                 
                                     
                         
-                            
-                                PaymentMethod
+                            
+                                PaymentMethodWrapper
                             
                         
-                        
+                        JSON object with only a PaymentMethod property.
                     
                                 
             
@@ -85308,6 +86621,14 @@ 
    Types
    
                             
                         
                         
+                    
+                                    
+                        
+                            
+                                PaymentMethodWrapper
+                            
+                        
+                        JSON object with only a PaymentMethod property.
                     
                                 
             
@@ -85679,6 +87000,14 @@ 
    Types
    
                             
                         
                         
+                    
+                                    
+                        
+                            
+                                PaymentMethodUpdateStructWrapper
+                            
+                        
+                        JSON object with only a PaymentMethodUpdateStruct property.
                     
                                     
                         
@@ -85687,6 +87016,14 @@ 
    Types
    
                             
                         
                         
+                    
+                                    
+                        
+                            
+                                PaymentMethodWrapper
+                            
+                        
+                        JSON object with only a PaymentMethod property.
                     
                                 
             
@@ -85740,11 +87077,12 @@ 
    Types
    
                             
    
                             
                                     <?xml version="1.0" encoding="UTF-8"?>
-<PaymentMethodUpdateStructParser>
+<PaymentMethodUpdateStruct>
     <names>
         <eng-GB>Bank transfer (updated)</eng-GB>
     </names>
-</PaymentMethodUpdateStructParser>
+</PaymentMethodUpdateStruct>
+
                             
    
                         
                         View more
@@ -85762,7 +87100,7 @@ 
    Types
    
                             
    
                             
                                     {
-  "PaymentMethodUpdateStructParser": {
+  "PaymentMethodUpdateStruct": {
     "names": {
       "eng-GB": "Bank transfer (updated)"
     }
@@ -85839,11 +87177,12 @@ 
    Types
    
                                         
    
                                         
                                                 <?xml version="1.0" encoding="UTF-8"?>
-<PaymentMethodUpdateStructParser>
+<PaymentMethodUpdateStruct>
     <names>
         <eng-GB>Bank transfer (updated)</eng-GB>
     </names>
-</PaymentMethodUpdateStructParser>
+</PaymentMethodUpdateStruct>
+
                                         
    
                                     
                                                             
@@ -85861,7 +87200,7 @@ 
    Types
    
                                         
    
                                         
                                                 {
-  "PaymentMethodUpdateStructParser": {
+  "PaymentMethodUpdateStruct": {
     "names": {
       "eng-GB": "Bank transfer (updated)"
     }
@@ -86143,6 +87482,14 @@ 
    Types
    
                             
                         
                         This class represents a list of shipping methods
+                    
+                                    
+                        
+                            
+                                ShippingMethodRefListWrapper
+                            
+                        
+                        JSON object with only a ShippingMethodRefList property.
                     
                                 
             
@@ -86498,6 +87845,14 @@ 
    Types
    
                             
                         
                         This class represents a shipping method.
+                    
+                                    
+                        
+                            
+                                ShippingMethodWrapper
+                            
+                        
+                        JSON object with only a ShippingMethod property.
                     
                                 
             
@@ -86948,6 +88303,14 @@ 
    Types
    
                             
                         
                         This class represents a list of shipping method types.
+                    
+                                    
+                        
+                            
+                                ShippingMethodTypesListWrapper
+                            
+                        
+                        JSON object with only a ShippingMethodTypesList property.
                     
                                 
             
@@ -87323,6 +88686,14 @@ 
    Types
    
                             
                         
                         This class represents a shipping method type.
+                    
+                                    
+                        
+                            
+                                ShippingMethodTypeWrapper
+                            
+                        
+                        JSON object with only a ShippingMethodType property.
                     
                                 
             
@@ -87663,11 +89034,19 @@ 
    Types
    
                 
                                     
                         
-                            
-                                Shipment
+                            
+                                ShipmentRefList
                             
                         
-                        This class represents a single shipment.
+                        This class represents a list of Shipments
+                    
+                                    
+                        
+                            
+                                ShipmentRefListWrapper
+                            
+                        
+                        JSON object with only a ShipmentRefList property.
                     
                                 
             
@@ -88057,6 +89436,14 @@ 
    Types
    
                             
                         
                         This class represents a single shipment.
+                    
+                                    
+                        
+                            
+                                ShipmentWrapper
+                            
+                        
+                        JSON object with only a Shipment property.
                     
                                 
             
@@ -88512,6 +89899,14 @@ 
    Types
    
                             
                         
                         This class represents the update of a shipment.
+                    
+                                    
+                        
+                            
+                                ShipmentUpdateWrapper
+                            
+                        
+                        JSON object with only a ShipmentUpdate property.
                     
                                     
                         
@@ -88520,6 +89915,14 @@ 
    Types
    
                             
                         
                         This class represents a single shipment.
+                    
+                                    
+                        
+                            
+                                ShipmentWrapper
+                            
+                        
+                        JSON object with only a Shipment property.
                     
                                 
             
@@ -89201,6 +90604,14 @@ 
    Types
    
                             
                         
                         This class represents Corporate Account Root resource information.
+                    
+                                    
+                        
+                            
+                                CorporateAccountRootWrapper
+                            
+                        
+                        JSON object with only a CorporateAccountRoot property.
                     
                                 
             
@@ -89752,6 +91163,14 @@ 
    Types
    
                             
                         
                         This class represents a list of companies.
+                    
+                                    
+                        
+                            
+                                CompanyListWrapper
+                            
+                        
+                        JSON object with only a CompanyList property.
                     
                                     
                         
@@ -90967,6 +92386,14 @@ 
    Types
    
                             
                         
                         This class is used to create a company.
+                    
+                                    
+                        
+                            
+                                CompanyCreateWrapper
+                            
+                        
+                        JSON object with only a CompanyCreate property.
                     
                                     
                         
@@ -90975,6 +92402,14 @@ 
    Types
    
                             
                         
                         This class represents a company.
+                    
+                                    
+                        
+                            
+                                CompanyWrapper
+                            
+                        
+                        JSON object with only a Company property.
                     
                                 
             
@@ -92104,6 +93539,14 @@ 
    Types
    
                 
                 
                                     
+                        
+                            
+                                CompanyWrapper
+                            
+                        
+                        JSON object with only a Company property.
+                    
+                                    
                         
                             
                                 Company
@@ -93076,6 +94519,14 @@ 
    Types
    
                                 
                         
                         This class is used to update a Company.
+                    
+                                    
+                        
+                            
+                                CompanyUpdateWrapper
+                            
+                        
+                        JSON object with only a CompanyUpdate property.
                     
                                     
                         
@@ -93084,6 +94535,14 @@ 
    Types
    
                             
                         
                         This class represents a company.
+                    
+                                    
+                        
+                            
+                                CompanyWrapper
+                            
+                        
+                        JSON object with only a Company property.
                     
                                 
             
@@ -94193,6 +95652,14 @@ 
    Types
    
                             
                         
                         This class represents a list of company members.
+                    
+                                    
+                        
+                            
+                                MemberListWrapper
+                            
+                        
+                        JSON object with only a MemberList property.
                     
                                     
                         
@@ -95241,6 +96708,14 @@ 
    Types
    
                             
                         
                         This class is used to create a member.
+                    
+                                    
+                        
+                            
+                                MemberCreateWrapper
+                            
+                        
+                        JSON object with only a MemberCreate property.
                     
                                     
                         
@@ -95249,6 +96724,14 @@ 
    Types
    
                             
                         
                         This class represents a company member.
+                    
+                                    
+                        
+                            
+                                MemberWrapper
+                            
+                        
+                        JSON object with only a Member property.
                     
                                 
             
@@ -96558,6 +98041,14 @@ 
    Types
    
                             
                         
                         This class represents a company member.
+                    
+                                    
+                        
+                            
+                                MemberWrapper
+                            
+                        
+                        JSON object with only a Member property.
                     
                                 
             
@@ -97788,6 +99279,14 @@ 
    Types
    
                             
                         
                         This class is used to update a member.
+                    
+                                    
+                        
+                            
+                                MemberUpdateWrapper
+                            
+                        
+                        JSON object with only a MemberUpdate property.
                     
                                     
                         
@@ -97796,6 +99295,14 @@ 
    Types
    
                             
                         
                         This class represents a company member.
+                    
+                                    
+                        
+                            
+                                MemberWrapper
+                            
+                        
+                        JSON object with only a Member property.
                     
                                 
             
@@ -99147,6 +100654,14 @@ 
    Types
    
                             
                         
                         This class represents a list of sales representatives.
+                    
+                                    
+                        
+                            
+                                SalesRepresentativesListWrapper
+                            
+                        
+                        JSON object with only a SalesRepresentativesList property.
                     
                                     
                         
@@ -99809,19 +101324,19 @@ 
    Types
    
                 
                                     
                         
-                            
-                                CatalogCreate
+                            
+                                CatalogCreateWrapper
                             
                         
-                        This class is used to create a catalog.
+                        JSON object with only a CatalogCreate property.
                     
                                     
                         
-                            
-                                Catalog
+                            
+                                CatalogWrapper
                             
                         
-                        This class represents a catalog.
+                        JSON object with only a Catalog property.
                     
                                 
             
@@ -100414,6 +101929,14 @@ 
    Types
    
                             
                         
                         This class represents a catalog.
+                    
+                                    
+                        
+                            
+                                CatalogWrapper
+                            
+                        
+                        JSON object with only a Catalog property.
                     
                                 
             
@@ -100802,11 +102325,19 @@ 
    Types
    
                 
                                     
                         
-                            
-                                CatalogUpdate
+                            
+                                CatalogUpdateWrapper
+                            
+                        
+                        JSON object with only a CatalogUpdate property.
+                    
+                                    
+                        
+                            
+                                CatalogWrapper
                             
                         
-                        This class is used to update a catalog.
+                        JSON object with only a Catalog property.
                     
                                 
             
@@ -101319,11 +102850,19 @@ 
    Types
    
                 
                                     
                         
-                            
-                                CatalogCopy
+                            
+                                CatalogCopyWrapper
                             
                         
-                        This class is used to copy a catalog.
+                        JSON object with only a CatalogCopy property.
+                    
+                                    
+                        
+                            
+                                CatalogWrapper
+                            
+                        
+                        JSON object with only a Catalog property.
                     
                                 
             
@@ -101794,11 +103333,27 @@ 
    Types
    
                     
                                     
                         
-                            
-                                ProductView
+                            
+                                CatalogViewInputWrapper
                             
                         
-                        This class represents a product view.
+                        JSON object with only a ViewInput property.
+                    
+                                    
+                        
+                            
+                                CatalogView
+                            
+                        
+                        
+                    
+                                    
+                        
+                            
+                                CatalogViewWrapper
+                            
+                        
+                        JSON object with only a CatalogView property.
                     
                                 
             
@@ -102270,6 +103825,14 @@ 
    Types
    
                             
                         
                         This class represents a product view input.
+                    
+                                    
+                        
+                            
+                                ProductViewInputWrapper
+                            
+                        
+                        JSON object with only a ViewInput property.
                     
                                     
                         
@@ -102278,6 +103841,14 @@ 
    Types
    
                             
                         
                         This class represents a product view.
+                    
+                                    
+                        
+                            
+                                ProductViewWrapper
+                            
+                        
+                        JSON object with only a ProductView property.
                     
                                 
             
@@ -102847,6 +104418,14 @@ 
    Types
    
                             
                         
                         This class represents a product filter list.
+                    
+                                    
+                        
+                            
+                                ProductFilterListWrapper
+                            
+                        
+                        JSON object with only a ProductFilterList property.
                     
                                 
             
@@ -103167,6 +104746,14 @@ 
    Types
    
                             
                         
                         This class represents a product sort clause list.
+                    
+                                    
+                        
+                            
+                                ProductSortClauseListWrapper
+                            
+                        
+                        JSON object with only a ProductSortClauseList property.
                     
                                 
             
@@ -103516,11 +105103,19 @@ 
    Types
    
                 
                                     
                         
-                            
-                                CurrencyCreate
+                            
+                                CurrencyCreateWrapper
+                            
+                        
+                        JSON object with only a CurrencyCreate property.
+                    
+                                    
+                        
+                            
+                                CurrencyWrapper
                             
                         
-                        This class is used to create currency.
+                        JSON object with only a Currency property.
                     
                                 
             
@@ -103879,11 +105474,11 @@ 
    Types
    
                 
                                     
                         
-                            
-                                CurrencyList
+                            
+                                CurrencyListWrapper
                             
                         
-                        This class represents a currency list.
+                        JSON object with only a CurrencyList property.
                     
                                 
             
@@ -104228,11 +105823,11 @@ 
    Types
    
                 
                                     
                         
-                            
-                                Currency
+                            
+                                CurrencyWrapper
                             
                         
-                        This class represents currency.
+                        JSON object with only a Currency property.
                     
                                 
             
@@ -104538,19 +106133,19 @@ 
    Types
    
                 
                                     
                         
-                            
-                                CurrencyUpdate
+                            
+                                CurrencyUpdateWrapper
                             
                         
-                        This class is used to update currency.
+                        JSON object with only a CurrencyUpdate property.
                     
                                     
                         
-                            
-                                Currency
+                            
+                                CurrencyWrapper
                             
                         
-                        This class represents currency.
+                        JSON object with only a Currency property.
                     
                                 
             
@@ -105022,6 +106617,14 @@ 
    Types
    
                             
                         
                         This class represents a currency view input.
+                    
+                                    
+                        
+                            
+                                CurrencyViewInputWrapper
+                            
+                        
+                        JSON object with only a ViewInput property.
                     
                                     
                         
@@ -105030,6 +106633,14 @@ 
    Types
    
                             
                         
                         This class represents a currency view.
+                    
+                                    
+                        
+                            
+                                CurrencyViewWrapper
+                            
+                        
+                        JSON object with only a CurrencyView property.
                     
                                 
             
@@ -105512,6 +107123,14 @@ 
    Types
    
                             
                         
                         This class represents a region list.
+                    
+                                    
+                        
+                            
+                                RegionListWrapper
+                            
+                        
+                        JSON object with only a RegionList property.
                     
                                 
             
@@ -105812,6 +107431,14 @@ 
    Types
    
                             
                         
                         This class represents a region.
+                    
+                                    
+                        
+                            
+                                RegionWrapper
+                            
+                        
+                        JSON object with only a Region property.
                     
                                 
             
@@ -105996,6 +107623,14 @@ 
    Types
    
                             
                         
                         This class represents a region view input.
+                    
+                                    
+                        
+                            
+                                RegionViewInputWrapper
+                            
+                        
+                        JSON object with only a ViewInput property.
                     
                                     
                         
@@ -106004,6 +107639,14 @@ 
    Types
    
                             
                         
                         This class represents a region view.
+                    
+                                    
+                        
+                            
+                                RegionViewWrapper
+                            
+                        
+                        JSON object with only a RegionView property.
                     
                                 
             
@@ -106417,6 +108060,14 @@ 
    Types
    
                             
                         
                         This class represents an attribute type list.
+                    
+                                    
+                        
+                            
+                                AttributeTypeListWrapper
+                            
+                        
+                        JSON object with only a AttributeTypeList property.
                     
                                 
             
@@ -106565,6 +108216,14 @@ 
    Types
    
                             
                         
                         This class represents an attribute type.
+                    
+                                    
+                        
+                            
+                                AttributeTypeWrapper
+                            
+                        
+                        JSON object with only a AttributeType property.
                     
                                 
             
@@ -106754,11 +108413,11 @@ 
    Types
    
                 
                                     
                         
-                            
-                                AttributeGroupListGet
+                            
+                                AttributeGroupListGetWrapper
                             
                         
-                        This class represents an attribute group list request.
+                        JSON object with only a AttributeGroupListGet property.
                     
                                     
                         
@@ -106767,6 +108426,14 @@ 
    Types
    
                             
                         
                         This class represents an attribute group list.
+                    
+                                    
+                        
+                            
+                                AttributeGroupListWrapper
+                            
+                        
+                        JSON object with only a AttributeGroupList property.
                     
                                 
             
@@ -107198,19 +108865,19 @@ 
    Types
    
                 
                                     
                         
-                            
-                                AttributeGroupCreate
+                            
+                                AttributeGroupCreateWrapper
                             
                         
-                        This class is used to create an attribute group.
+                        JSON object with only a AttributeGroupCreate property.
                     
                                     
                         
-                            
-                                AttributeGroup
+                            
+                                AttributeGroupWrapper
                             
                         
-                        This class represents an attribute group.
+                        JSON object with only a AttributeGroup property.
                     
                                 
             
@@ -107257,7 +108924,7 @@ 
    Types
    
     "AttributeGroupCreate": {
         "identifier": "attr_group_test",
         "names": {
-            "eng-GB": "Attribute Group Test" 
+            "eng-GB": "Attribute Group Test"
         },
         "position": 0
     }
@@ -107322,7 +108989,7 @@ 
    Types
    
     "AttributeGroupCreate": {
         "identifier": "attr_group_test",
         "names": {
-            "eng-GB": "Attribute Group Test" 
+            "eng-GB": "Attribute Group Test"
         },
         "position": 0
     }
@@ -107639,6 +109306,14 @@ 
    Types
    
                             
                         
                         This class represents an attribute group query.
+                    
+                                    
+                        
+                            
+                                AttributeGroupGetWrapper
+                            
+                        
+                        JSON object with only a AttributeGroupGet property.
                     
                                     
                         
@@ -107647,6 +109322,14 @@ 
    Types
    
                             
                         
                         This class represents an attribute group.
+                    
+                                    
+                        
+                            
+                                AttributeGroupWrapper
+                            
+                        
+                        JSON object with only a AttributeGroup property.
                     
                                 
             
@@ -108067,6 +109750,14 @@ 
    Types
    
                             
                         
                         This class is used to update an attribute group.
+                    
+                                    
+                        
+                            
+                                AttributeGroupUpdateWrapper
+                            
+                        
+                        JSON object with only a AttributeGroupUpdate property.
                     
                                     
                         
@@ -108075,6 +109766,14 @@ 
    Types
    
                             
                         
                         This class represents an attribute group.
+                    
+                                    
+                        
+                            
+                                AttributeGroupWrapper
+                            
+                        
+                        JSON object with only a AttributeGroup property.
                     
                                 
             
@@ -108625,6 +110324,14 @@ 
    Types
    
                             
                         
                         This class represents an attribute group view input.
+                    
+                                    
+                        
+                            
+                                AttributeGroupViewInputWrapper
+                            
+                        
+                        JSON object with only a ViewInput property.
                     
                                     
                         
@@ -108633,6 +110340,14 @@ 
    Types
    
                             
                         
                         This class represents an attribute group view.
+                    
+                                    
+                        
+                            
+                                AttributeGroupViewWrapper
+                            
+                        
+                        JSON object with only a AttributeGroupView property.
                     
                                 
             
@@ -109104,19 +110819,19 @@ 
    Types
    
                 
                                     
                         
-                            
-                                AttributeCreate
+                            
+                                AttributeCreateWrapper
                             
                         
-                        This class is used to create an attribute.
+                        JSON object with only a AttributeCreate property.
                     
                                     
                         
-                            
-                                Attribute
+                            
+                                AttributeWrapper
                             
                         
-                        This class represents an attribute.
+                        JSON object with only a Attribute property.
                     
                                 
             
@@ -109165,10 +110880,10 @@ 
    Types
    
         "type": "checkbox",
         "group": "attr_group_test",
         "names": {
-            "eng-GB": "Attribute" 
+            "eng-GB": "Attribute"
         },
         "descriptions": {
-            "eng-GB": "description" 
+            "eng-GB": "description"
         },
         "position": 0,
         "options": {
@@ -109239,10 +110954,10 @@ 
    Types
    
         "type": "checkbox",
         "group": "attr_group_test",
         "names": {
-            "eng-GB": "Attribute" 
+            "eng-GB": "Attribute"
         },
         "descriptions": {
-            "eng-GB": "description" 
+            "eng-GB": "description"
         },
         "position": 0,
         "options": {
@@ -109513,6 +111228,14 @@ 
    Types
    
                             
                         
                         This class represents an attribute list.
+                    
+                                    
+                        
+                            
+                                AttributeListWrapper
+                            
+                        
+                        JSON object with only a AttributeList property.
                     
                                 
             
@@ -109839,6 +111562,14 @@ 
    Types
    
                             
                         
                         This class represents an attribute.
+                    
+                                    
+                        
+                            
+                                AttributeWrapper
+                            
+                        
+                        JSON object with only a Attribute property.
                     
                                 
             
@@ -110229,19 +111960,19 @@ 
    Types
    
                 
                                     
                         
-                            
-                                AttributeUpdate
+                            
+                                AttributeUpdateWrapper
                             
                         
-                        This class is used to update an attribute.
+                        JSON object with only a AttributeUpdate property.
                     
                                     
                         
-                            
-                                Attribute
+                            
+                                AttributeWrapper
                             
                         
-                        This class represents an attribute.
+                        JSON object with only a Attribute property.
                     
                                 
             
@@ -110287,15 +112018,17 @@ 
    Types
    
                                 {
     "AttributeUpdate": {
         "identifier": "attr_group",
+        "names": {
             "eng-GB": "Attribute Group"
         },
         "descriptions": {
-            "eng-GB": "description" 
+            "eng-GB": "description"
         },
-        "position": 0, 
-        "options": { 
+        "position": 0,
+        "options": {
             "foo": "bar"
         }
+    }
 }
 
                             
    
@@ -110357,15 +112090,17 @@ 
    Types
    
                                             {
     "AttributeUpdate": {
         "identifier": "attr_group",
+        "names": {
             "eng-GB": "Attribute Group"
         },
         "descriptions": {
-            "eng-GB": "description" 
+            "eng-GB": "description"
         },
-        "position": 0, 
-        "options": { 
+        "position": 0,
+        "options": {
             "foo": "bar"
         }
+    }
 }
 
                                         
    
@@ -110755,6 +112490,14 @@ 
    Types
    
                             
                         
                         This class represents an attribute view input.
+                    
+                                    
+                        
+                            
+                                AttributeViewInputWrapper
+                            
+                        
+                        JSON object with only a ViewInput property.
                     
                                     
                         
@@ -110763,6 +112506,14 @@ 
    Types
    
                             
                         
                         This class represents an attribute view.
+                    
+                                    
+                        
+                            
+                                AttributeViewWrapper
+                            
+                        
+                        JSON object with only a AttributeView property.
                     
                                 
             
@@ -111204,11 +112955,11 @@ 
    Types
    
                 
                                     
                         
-                            
-                                CustomerGroupList
+                            
+                                CustomerGroupListWrapper
                             
                         
-                        This class represents a customer group list.
+                        JSON object with only a CustomerGroupList property.
                     
                                 
             
@@ -111538,19 +113289,19 @@ 
    Types
    
                 
                                     
                         
-                            
-                                CustomerGroupCreate
+                            
+                                CustomerGroupCreateWrapper
                             
                         
-                        This class is used to create a customer group.
+                        JSON object with only a CustomerGroupCreate property.
                     
                                     
                         
-                            
-                                CustomerGroup
+                            
+                                CustomerGroupWrapper
                             
                         
-                        This class represents a customer group.
+                        JSON object with only a CustomerGroup property.
                     
                                 
             
@@ -111599,7 +113350,7 @@ 
    Types
    
         "names": {
             "eng-GB": "Customer Group"
         },
-    "descriptions:": {
+        "descriptions": {
             "eng-GB": "Customer Group description"
         },
         "global_price_rate": "1"
@@ -111667,7 +113418,7 @@ 
    Types
    
         "names": {
             "eng-GB": "Customer Group"
         },
-    "descriptions:": {
+        "descriptions": {
             "eng-GB": "Customer Group description"
         },
         "global_price_rate": "1"
@@ -111951,11 +113702,11 @@ 
    Types
    
                 
                                     
                         
-                            
-                                CustomerGroup
+                            
+                                CustomerGroupWrapper
                             
                         
-                        This class represents a customer group.
+                        JSON object with only a CustomerGroup property.
                     
                                 
             
@@ -112249,19 +114000,19 @@ 
    Types
    
                 
                                     
                         
-                            
-                                CustomerGroupUpdate
+                            
+                                CustomerGroupUpdateWrapper
                             
                         
-                        This class is used to update a customer group.
+                        JSON object with only a CustomerGroupUpdate property.
                     
                                     
                         
-                            
-                                CustomerGroup
+                            
+                                CustomerGroupWrapper
                             
                         
-                        This class represents a customer group.
+                        JSON object with only a CustomerGroup property.
                     
                                 
             
@@ -112747,6 +114498,14 @@ 
    Types
    
                             
                         
                         This class represents a customer group view input.
+                    
+                                    
+                        
+                            
+                                CustomerGroupViewInputWrapper
+                            
+                        
+                        JSON object with only a ViewInput property.
                     
                                     
                         
@@ -112755,6 +114514,14 @@ 
    Types
    
                             
                         
                         This class represents a customer group view.
+                    
+                                    
+                        
+                            
+                                CustomerGroupViewWrapper
+                            
+                        
+                        JSON object with only a CustomerGroupView property.
                     
                                 
             
@@ -113233,19 +115000,19 @@ 
    Types
    
                 
                                     
                         
-                            
-                                ProductTypeCreate
+                            
+                                ProductTypeCreateWrapper
                             
                         
-                        This class is used to create a product type.
+                        JSON object with only a ProductTypeCreate property.
                     
                                     
                         
-                            
-                                ProductType
+                            
+                                ProductTypeWrapper
                             
                         
-                        This class represents a product type.
+                        JSON object with only a ProductType property.
                     
                                 
             
@@ -113784,6 +115551,14 @@ 
    Types
    
                             
                         
                         This class represents a product type list query.
+                    
+                                    
+                        
+                            
+                                ProductTypeListGetWrapper
+                            
+                        
+                        JSON object with only a ProductTypeListGet property.
                     
                                     
                         
@@ -113792,6 +115567,14 @@ 
    Types
    
                             
                         
                         This class represents a product type list.
+                    
+                                    
+                        
+                            
+                                ProductTypeListWrapper
+                            
+                        
+                        JSON object with only a ProductTypeList property.
                     
                                 
             
@@ -114176,6 +115959,14 @@ 
    Types
    
                             
                         
                         This class represents a product type usage.
+                    
+                                    
+                        
+                            
+                                ProductTypeUsageWrapper
+                            
+                        
+                        JSON object with only a ProductTypeUsage property.
                     
                                 
             
@@ -114191,117 +115982,9 @@ 
    Types
    
                                                         
    
                     
    
                         
-                                                    
    
-                                Code: 200
-                            
    
-                                            
    
-                                                                
    
-    
    
-                                                    
    
-                                                                                            
    
-                                                        
    
-                                file_copy
-                                
-                            
    
-                            
    -                                <?xml version="1.0" encoding="UTF-8"?>
-<ProductTypeUsage media-type="application/vnd.ibexa.api.ProductTypeUsage+xml">
-    <is_used>1</is_used>
-</ProductTypeUsage>
-
-                            
    
-                        
    
-                        View more
-                                    
    
-                        
    
-
    
-                        
-                                    
    
+                                                        
                                     
                                     
     
@@ -114446,6 +116129,14 @@ 
    Types
    
                             
                         
                         This class represents a product type.
+                    
+                                    
+                        
+                            
+                                ProductTypeWrapper
+                            
+                        
+                        JSON object with only a ProductType property.
                     
                                 
             
@@ -114739,11 +116430,19 @@ 
    Types
    
                 
                                     
                         
-                            
-                                ProductTypeUpdate
+                            
+                                ProductTypeUpdateWrapper
                             
                         
-                        This class is used to update a product type.
+                        JSON object with only a ProductTypeUpdate property.
+                    
+                                    
+                        
+                            
+                                ProductTypeWrapper
+                            
+                        
+                        JSON object with only a ProductType property.
                     
                                 
             
@@ -115299,6 +116998,14 @@ 
    Types
    
                             
                         
                         This class represents a product type view input.
+                    
+                                    
+                        
+                            
+                                ProductTypeViewInputWrapper
+                            
+                        
+                        JSON object with only a ViewInput property.
                     
                                     
                         
@@ -115307,6 +117014,14 @@ 
    Types
    
                             
                         
                         This class represents a product type view.
+                    
+                                    
+                        
+                            
+                                ProductTypeViewWrapper
+                            
+                        
+                        JSON object with only a ProductTypeView property.
                     
                                 
             
@@ -115797,19 +117512,19 @@ 
    Types
    
                 
                                     
                         
-                            
-                                ProductListGet
+                            
+                                ProductListGetWrapper
                             
                         
-                        This class represents a product list GET.
+                        JSON object with only a ProductListGet property.
                     
                                     
                         
-                            
-                                ProductList
+                            
+                                ProductListWrapper
                             
                         
-                        This class represents a product list.
+                        JSON object with only a ProductList property.
                     
                                 
             
@@ -116431,19 +118146,19 @@ 
    Types
    
                 
                                     
                         
-                            
-                                ProductCreate
+                            
+                                ProductCreateWrapper
                             
                         
-                        This class is used to create a product.
+                        JSON object with only a ProductCreate property.
                     
                                     
                         
-                            
-                                Product
+                            
+                                ProductWrapper
                             
                         
-                        This class represents a product.
+                        JSON object with only a Product property.
                     
                                 
             
@@ -117190,19 +118905,19 @@ 
    Types
    
                 
                                     
                         
-                            
-                                ProductGet
+                            
+                                ProductGetWrapper
                             
                         
-                        This class represents a product GET.
+                        JSON object with only a ProductGet property.
                     
                                     
                         
-                            
-                                Product
+                            
+                                ProductWrapper
                             
                         
-                        This class represents a product.
+                        JSON object with only a Product property.
                     
                                 
             
@@ -117818,11 +119533,19 @@ 
    Types
    
                 
                                     
                         
-                            
-                                ProductUpdate
+                            
+                                ProductUpdateWrapper
+                            
+                        
+                        JSON object with only a ProductUpdate property.
+                    
+                                    
+                        
+                            
+                                ProductWrapper
                             
                         
-                        This class is used to update a product.
+                        JSON object with only a Product property.
                     
                                 
             
@@ -117867,7 +119590,7 @@ 
    Types
    
                             
                                     {
     "ProductUpdate": {
-        "ContentUpdate": { 
+        "ContentUpdate": {
               "__url": "/api/ibexa/v2/content/objects/67",
               "fields": {
                   "field": [
@@ -117941,7 +119664,7 @@ 
    Types
    
                                         
                                                 {
     "ProductUpdate": {
-        "ContentUpdate": { 
+        "ContentUpdate": {
               "__url": "/api/ibexa/v2/content/objects/67",
               "fields": {
                   "field": [
@@ -118431,11 +120154,11 @@ 
    Types
    
                 
                                     
                         
-                            
-                                PriceList
+                            
+                                PriceListWrapper
                             
                         
-                        This class represents a price list.
+                        JSON object with only a PriceList property.
                     
                                 
             
@@ -118775,19 +120498,35 @@ 
    Types
    
                 
                                     
                         
-                            
-                                PriceCreateStruct
+                            
+                                PriceCreateStructWrapper
                             
                         
-                        This class represents a price creation structure.
+                        JSON object with only a PriceCreateStruct property.
                     
                                     
                         
-                            
-                                CustomPriceCreateStruct
+                            
+                                CustomPriceCreateStructWrapper
                             
                         
-                        This class represents a custom price creation structure.
+                        JSON object with only a CustomPriceCreateStruct property.
+                    
+                                    
+                        
+                            
+                                PriceWrapper
+                            
+                        
+                        JSON object with only a Price property.
+                    
+                                    
+                        
+                            
+                                CustomPriceWrapper
+                            
+                        
+                        JSON object with only a CustomPrice property.
                     
                                 
             
@@ -119292,11 +121031,11 @@ 
    Types
    
                 
                                     
                         
-                            
-                                Price
+                            
+                                PriceWrapper
                             
                         
-                        This class represents a price.
+                        JSON object with only a Price property.
                     
                                 
             
@@ -119581,11 +121320,11 @@ 
    Types
    
                 
                                     
                         
-                            
-                                Price
+                            
+                                CustomPriceWrapper
                             
                         
-                        This class represents a price.
+                        JSON object with only a CustomPrice property.
                     
                                 
             
@@ -120056,35 +121795,35 @@ 
    Types
    
                 
                                     
                         
-                            
-                                PriceUpdateStruct
+                            
+                                PriceUpdateStructWrapper
                             
                         
-                        This class represents a price updating structure.
+                        JSON object with only a PriceUpdateStruct property.
                     
                                     
                         
-                            
-                                CustomPriceUpdateStruct
+                            
+                                CustomPriceUpdateStructWrapper
                             
                         
-                        This class represents a custom price updating structure.
+                        JSON object with only a CustomPriceUpdateStruct property.
                     
                                     
                         
-                            
-                                Price
+                            
+                                PriceWrapper
                             
                         
-                        This class represents a price.
+                        JSON object with only a Price property.
                     
                                     
                         
-                            
-                                CustomPrice
+                            
+                                CustomPriceWrapper
                             
                         
-                        This class represents a custom price.
+                        JSON object with only a CustomPrice property.
                     
                                 
             
@@ -120286,10 +122025,21 @@ 
    Types
    
                             
    
                             
                                     {
-  "PriceUpdateStruct": {
-    "amount": 3500,
-    "currency": "USD"
-  }
+    "Price": {
+        "_media-type": "application/vnd.ibexa.api.Price+json",
+        "id": 2,
+        "amount": "35.00",
+        "base_amount": "35.00",
+        "Currency": {
+            "_media-type": "application/vnd.ibexa.api.Currency+json",
+            "id": 5,
+            "code": "USD",
+            "subunits": 2,
+            "enabled": true
+        },
+        "money": "3500",
+        "base_money": "3500"
+    }
 }
 
                             
    
@@ -120306,11 +122056,24 @@ 
    Types
    
                             
    
                             
                                     {
-  "CustomPriceUpdateStruct": {
-    "amount": 2500,
-    "customAmount": 1700,
-    "currency": "USD"
-  }
+    "CustomPrice": {
+        "_media-type": "application/vnd.ibexa.api.CustomPrice+json",
+        "id": 3,
+        "amount": "17.00",
+        "base_amount": "35.00",
+        "Currency": {
+            "_media-type": "application/vnd.ibexa.api.Currency+json",
+            "id": 5,
+            "code": "USD",
+            "subunits": 2,
+            "enabled": true
+        },
+        "money": "1700",
+        "base_money": "3500",
+        "custom_money": "1700",
+        "custom_amount": "17.00",
+        "custom_rule": null
+    }
 }
 
                             
    
@@ -120373,10 +122136,21 @@ 
    Types
    
                                         
    
                                         
                                                 {
-  "PriceUpdateStruct": {
-    "amount": 3500,
-    "currency": "USD"
-  }
+    "Price": {
+        "_media-type": "application/vnd.ibexa.api.Price+json",
+        "id": 2,
+        "amount": "35.00",
+        "base_amount": "35.00",
+        "Currency": {
+            "_media-type": "application/vnd.ibexa.api.Currency+json",
+            "id": 5,
+            "code": "USD",
+            "subunits": 2,
+            "enabled": true
+        },
+        "money": "3500",
+        "base_money": "3500"
+    }
 }
 
                                         
    
@@ -120392,11 +122166,24 @@ 
    Types
    
                                         
    
                                         
                                                 {
-  "CustomPriceUpdateStruct": {
-    "amount": 2500,
-    "customAmount": 1700,
-    "currency": "USD"
-  }
+    "CustomPrice": {
+        "_media-type": "application/vnd.ibexa.api.CustomPrice+json",
+        "id": 3,
+        "amount": "17.00",
+        "base_amount": "35.00",
+        "Currency": {
+            "_media-type": "application/vnd.ibexa.api.Currency+json",
+            "id": 5,
+            "code": "USD",
+            "subunits": 2,
+            "enabled": true
+        },
+        "money": "1700",
+        "base_money": "3500",
+        "custom_money": "1700",
+        "custom_amount": "17.00",
+        "custom_rule": null
+    }
 }
 
                                         
    
@@ -120575,6 +122362,14 @@ 
    Types
    
                             
                         
                         This class represents a product view input.
+                    
+                                    
+                        
+                            
+                                ProductViewInputWrapper
+                            
+                        
+                        JSON object with only a ViewInput property.
                     
                                     
                         
@@ -120583,6 +122378,14 @@ 
    Types
    
                             
                         
                         This class represents a product view.
+                    
+                                    
+                        
+                            
+                                ProductViewWrapper
+                            
+                        
+                        JSON object with only a ProductView property.
                     
                                 
             
@@ -121683,11 +123486,11 @@ 
    Types
    
                 
                                     
                         
-                            
-                                ProductVariantCreate
+                            
+                                ProductVariantCreateWrapper
                             
                         
-                        This class is used to create a product variant.
+                        JSON object with only a ProductVariantCreate property.
                     
                                 
             
@@ -122000,11 +123803,11 @@ 
    Types
    
                 
                                     
                         
-                            
-                                ProductVariantGenerate
+                            
+                                ProductVariantGenerateWrapper
                             
                         
-                        This class is used to generate a product variant.
+                        JSON object with only a ProductVariantGenerate property.
                     
                                 
             
@@ -122392,19 +124195,19 @@ 
    Types
    
                 
                                     
                         
-                            
-                                ProductVariantUpdate
+                            
+                                ProductVariantUpdateWrapper
                             
                         
-                        This class is used to update a product variant.
+                        JSON object with only a ProductVariantUpdate property.
                     
                                     
                         
-                            
-                                ProductVariant
+                            
+                                ProductVariantWrapper
                             
                         
-                        This class represents a product variant.
+                        JSON object with only a ProductVariant property.
                     
                                 
             
@@ -123052,6 +124855,14 @@ 
    Types
    
                             
                         
                         This class represents a product variant view input.
+                    
+                                    
+                        
+                            
+                                ProductVariantViewInputWrapper
+                            
+                        
+                        JSON object with only a ViewInput property.
                     
                                     
                         
@@ -123060,6 +124871,14 @@ 
    Types
    
                             
                         
                         This class represents a product variant view.
+                    
+                                    
+                        
+                            
+                                ProductVariantViewWrapper
+                            
+                        
+                        JSON object with only a ProductVariantView property.
                     
                                 
             
@@ -123958,11 +125777,11 @@ 
    Types
    
                 
                                     
                         
-                            
-                                ProductVariant
+                            
+                                ProductVariantWrapper
                             
                         
-                        This class represents a product variant.
+                        JSON object with only a ProductVariant property.
                     
                                 
             
@@ -124484,11 +126303,11 @@ 
    Types
    
                 
                                     
                         
-                            
-                                VatCategoryList
+                            
+                                VatCategoryListWrapper
                             
                         
-                        This class represents a VAT category list.
+                        JSON object with only a VatCategoryList property.
                     
                                 
             
@@ -124789,11 +126608,11 @@ 
    Types
    
                 
                                     
                         
-                            
-                                VatCategory
+                            
+                                VatCategoryWrapper
                             
                         
-                        This class represents a VAT category.
+                        JSON object with only a VatCategory property.
                     
                                 
             
@@ -125072,6 +126891,14 @@ 
    Types
    
                             
                         
                         This class represents a taxonomy entry.
+                    
+                                    
+                        
+                            
+                                TaxonomyEntryWrapper
+                            
+                        
+                        JSON object with only a TaxonomyEntry property.
                     
                                 
             
@@ -125228,6 +127055,14 @@ 
    Types
    
                             
                         
                         This class represents a taxonomy entry.
+                    
+                                    
+                        
+                            
+                                TaxonomyEntryWrapper
+                            
+                        
+                        JSON object with only a TaxonomyEntry property.
                     
                                 
             
@@ -125384,6 +127219,14 @@ 
    Types
    
                             
                         
                         This class represents a taxonomy entry.
+                    
+                                    
+                        
+                            
+                                TaxonomyEntryWrapper
+                            
+                        
+                        JSON object with only a TaxonomyEntry property.
                     
                                 
             
@@ -125537,6 +127380,14 @@ 
    Types
    
                             
                         
                         This class is used to bulk remove taxonomy entries.
+                    
+                                    
+                        
+                            
+                                TaxonomyEntryBulkRemoveWrapper
+                            
+                        
+                        JSON object with only a TaxonomyEntryBulkRemove property.
                     
                                 
             
@@ -125802,6 +127653,14 @@ 
    Types
    
                             
                         
                         This class is used to bulk move taxonomy entries.
+                    
+                                    
+                        
+                            
+                                TaxonomyEntryBulkMoveWrapper
+                            
+                        
+                        JSON object with only a TaxonomyEntryBulkMove property.
                     
                                 
             
@@ -126076,6 +127935,14 @@ 
    Types
    
                             
                         
                         This class represents a taxonomy entry assignment.
+                    
+                                    
+                        
+                            
+                                TaxonomyEntryAssignmentWrapper
+                            
+                        
+                        JSON object with only a TaxonomyEntryAssignment property.
                     
                                 
             
@@ -126223,11 +128090,11 @@ 
    Types
    
                 
                                     
                         
-                            
-                                TaxonomyEntryAssignToContent
+                            
+                                TaxonomyEntryAssignToContentWrapper
                             
                         
-                        This class is used to assign taxonomy entry to content.
+                        JSON object with only a TaxonomyEntryAssignToContent property.
                     
                                 
             
@@ -126487,11 +128354,11 @@ 
    Types
    
                 
                                     
                         
-                            
-                                TaxonomyEntryUnassignFromContent
+                            
+                                TaxonomyEntryUnassignFromContentWrapper
                             
                         
-                        This class is used to unassign taxonomy entry from content.
+                        JSON object with only a TaxonomyEntryUnassignFromContent property.
                     
                                 
             
@@ -126750,6 +128617,14 @@ 
    Types
    
                             
                         
                         This class represents a taxonomy assignment collection.
+                    
+                                    
+                        
+                            
+                                EntryAssignmentCollectionWrapper
+                            
+                        
+                        JSON object with only a EntryAssignmentCollection property.
                     
                                 
             
@@ -127403,6 +129278,14 @@ 
    Types
    
                             
                         
                         This class represents activity log context groups
+                    
+                                    
+                        
+                            
+                                ActivityLogGroupListWrapper
+                            
+                        
+                        JSON object with only a ActivityLogGroupList property.
                     
                                 
             
@@ -127856,6 +129739,14 @@ 
    Types
    
                             
                         
                         This class represents the activity log group search query's criteria and sort clauses.
+                    
+                                    
+                        
+                            
+                                ActivityLogGroupListInputWrapper
+                            
+                        
+                        JSON object with only a ActivityLogGroupListInput property.
                     
                                     
                         
@@ -127864,6 +129755,14 @@ 
    Types
    
                             
                         
                         This class represents activity log context groups
+                    
+                                    
+                        
+                            
+                                ActivityLogGroupListWrapper
+                            
+                        
+                        JSON object with only a ActivityLogGroupList property.
                     
                                 
             
@@ -128393,7 +130292,176 @@ 
    Types
    
     
 
                         
-                                                                            
+                                            
+                        
+                                            
+                        
+                                            
+                                            
+                        
+                                            
+                        
+                                            
+                                            
+                                            
+                                            
+                                            
+                        
+                                            
+                        
+                                            
+                                            
+                            
+                        
+                                            
+                            
+                        
+                                            
+                                            
+                                
+                            
+                        
+                                            
+                        
+                                            
+                        
+                                            
+                                            
+                                            
+                                
+                            
+                        
+                                            
+                        
+                                            
+                                            
+                                            
+                            
+                        
+                                            
+                            
+                        
+                                            
@@ -134120,26 +137690,72 @@ 
    Types
    
 
     *
 
-(string[]
-    )
+(ValueObject)
  - 
 
     An array of names with languageCode keys. At least one name in the main language is required.
 
 
+    
    
+        
      
+                    
    
+    
    
                 
                             
  • 
                     descriptions
 
     *
 
-(string[]
-    )
+(ValueObject)
  - 
 
     An array of descriptions with languageCode keys.
 
 
+    
    
+        
      
+                    
    
+    
    
+                
    • 
+                    
+    
+                                    
+                                
+                            
+                        
+                                            
+                        
+                                            
+                        
+                                            
+                        
+                                            
+                            
+                        
+                                            
+                            
+                        
+                                            
+                        
+                                            
+                        
+                                            
+                                            
+                            
+                        
+                                            
                                 
                             
@@ -135406,6 +139537,46 @@ 
    Types
    
     Readable string identifier of a role.
 
 
+                
+                    
+    
+                                    
+                                
+                            
+                        
+                                            
+                        
+                                            
+                        
+                                            
+                        
+                                            
+                        
+                                            
+                                
+                            
+                        
+                                            
+                                    
+                                
+                            
+                        
+                                            
+                        
+                                            
+                        
+                                            
+                        
+                                            
+                        
+                                            
+                                            
+                                
+                            
+                        
+                                            
+                        
+                                            
+                                            
+                                
+                            
+                        
+                                            
+                        
+                                            
+                                            
+                                            
+                            
+                        
+                                            
+                            
+                        
+                                            
+                                            
+                                            
+                                
+                            
+                        
+                                            
+                                
+                            
+                        
+                                            
+                                            
+                                
+                            
+                        
+                                            
+                            
+                        
+                                            
+                                            
+                                            
+                        
+                                            
+