Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,6 @@ displayName: Calendar
description: A calendar action that e.g. reschedules or unschedules calendar events. The event type should always be copied from an event.
headers:
Content-Type:
description:
example: |
application/vnd.ibexa.api.calendar.future_publication.UnscheduleAction+json
body:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,6 @@ get:

post:
displayName: Create a company
description:
headers:
Accept:
description: If set, the new company is returned in XML or JSON format.
Expand Down
87 changes: 47 additions & 40 deletions docs/api/rest_api/rest_api_reference/input/ez-types.raml
Original file line number Diff line number Diff line change
Expand Up @@ -559,10 +559,10 @@ ContentTypeUpdateStruct:
type: datetime
names:
description: 'If set this array of names with languageCode keys replace the complete name collection.'
type: array
type: Value[]
descriptions:
description: 'If set this array of descriptions with languageCode keys replace the complete description collection.'
type: array
type: Value[]

ContentUpdateStruct:
description: 'This class is used for updating the fields of a Content item draft.'
Expand Down Expand Up @@ -615,6 +615,7 @@ CreateStruct:
data:
description: 'Notification data.'
type: array
items: mixed
Criterion:
description: 'Criterion implementations.'
type: object
Expand All @@ -625,6 +626,7 @@ Criterion:
value:
description: 'The value(s) matched by the Criteria.'
type: array
items: mixed
target:
description: 'The target used by the Criteria (field, metadata...).'
type: string
Expand Down Expand Up @@ -813,10 +815,10 @@ FieldDefinitionCreateStruct:
type: string
names:
description: 'An array of names with languageCode keys.'
type: array
type: Value[]
descriptions:
description: 'An array of descriptions with languageCode keys.'
type: array
type: Value[]
fieldGroup:
description: 'Field group name.'
type: string
Expand Down Expand Up @@ -853,10 +855,10 @@ FieldDefinitionUpdateStruct:
type: string
names:
description: 'If set this array of names with languageCode keys replace the complete name collection.'
type: array
type: Value[]
descriptions:
description: 'If set this array of descriptions with languageCode keys replace the complete description collection.'
type: array
type: Value[]
fieldGroup:
description: 'If set the field group is changed to this name.'
type: string
Expand Down Expand Up @@ -905,9 +907,6 @@ Language:
description: 'This class represents a language in the Repository.'
type: BaseObject
properties:
ALL:
description: "Constant for use in API's to specify that you want to load all languages."
type: array
id:
description: 'The language ID (auto generated).'
type: integer
Expand Down Expand Up @@ -1073,6 +1072,7 @@ Message:
values:
description: 'Translation value objects. May not contain any numbers, which might result in requiring plural forms. Use Plural for that.'
type: array
items: mixed
Notification:
description: 'This class represents a notification value.'
type: object
Expand All @@ -1095,6 +1095,7 @@ Notification:
data:
description: 'This class represents data.'
type: array
items: mixed
NotificationList:
description: 'This class represents a notifications list.'
type: object
Expand Down Expand Up @@ -1291,6 +1292,7 @@ Plural:
values:
description: 'Translation value objects. May not contain any numbers, which might result in requiring plural forms. Use MessagePlural for that.'
type: array
items: mixed
Policy:
description: 'This class represents a policy value.'
type: BaseObject
Expand Down Expand Up @@ -1720,7 +1722,7 @@ UrlAlias:
type: any
path:
description: 'The full path of the alias.'
type:
type: string
languageCodes:
description: 'The languageCodes for which this path is valid.'
type: string[]
Expand Down Expand Up @@ -2046,6 +2048,7 @@ ValueObject:
Properties:
description: 'Function where list of properties are returned.'
type: array
items: mixed
Version:
description: 'Returns the VersionInfo for this version.'
type: BaseObject
Expand Down Expand Up @@ -2175,9 +2178,9 @@ ContentTypeCreate:
defaultAlwaysAvailable:
type: boolean
names:
type: array
type: Value[]
descriptions:
type: array
type: Value[]
FieldDefinition:
type: FieldDefinition
creatorId:
Expand Down Expand Up @@ -2212,9 +2215,9 @@ ContentTypeUpdate:
defaultAlwaysAvailable:
type: boolean
names:
type: array
type: Value[]
descriptions:
type: array
type: Value[]
modifierId:
description: 'If set, this value overrides the current user as creator.'
type: any
Expand Down Expand Up @@ -2475,9 +2478,9 @@ CatalogCreate:
Criteria:
type: Criterion
names:
type: array
type: object
descriptions:
type: array
type: object
status:
type: string
creator_id:
Expand All @@ -2494,9 +2497,9 @@ CatalogUpdate:
Criteria:
type: Criterion
names:
type: array
type: object
descriptions:
type: array
type: object

CatalogCopy:
description: 'This class is used to copy a catalog.'
Expand Down Expand Up @@ -2610,11 +2613,9 @@ AttributeGroupCreate:
identifier:
type: string
names:
type: array
type: string[]
position:
type: integer
languages:
type: array

AttributeGroupUpdate:
description: 'This class is used to update an attribute group.'
Expand All @@ -2623,11 +2624,9 @@ AttributeGroupUpdate:
identifier:
type: string
names:
type: array
type: object
position:
type: integer
languages:
type: array

AttributeGroupList:
description: 'This class represents an attribute group list.'
Expand Down Expand Up @@ -2669,7 +2668,7 @@ Attribute:
position:
type: integer
options:
type: array
type: object

AttributeCreate:
description: 'This class is used to create an attribute.'
Expand All @@ -2682,13 +2681,14 @@ AttributeCreate:
group:
type: string
names:
type: array
type: object
descriptions:
type: array
type: object
positions:
type: integer
options:
type: array
items: mixed

AttributeUpdate:
description: 'This class is used to update an attribute.'
Expand All @@ -2697,13 +2697,14 @@ AttributeUpdate:
identifier:
type: string
names:
type: array
type: object
descriptions:
type: array
type: object
positions:
type: integer
options:
type: array
items: mixed

AttributeList:
description: 'This class represents an attribute list.'
Expand Down Expand Up @@ -2780,9 +2781,9 @@ CustomerGroupCreate:
identifier:
type: string
names:
type: array
type: object
descriptions:
type: array
type: object
global_price_rate:
description: 'numeric-string'
type: string
Expand All @@ -2792,13 +2793,11 @@ CustomerGroupUpdate:
type: object
properties:
names:
type: array
type: object
identifier:
type: string
position:
type: integer
languages:
type: array

CustomerGroupViewInput:
description: 'This class represents a customer group view input.'
Expand Down Expand Up @@ -2940,14 +2939,14 @@ ProductListGet:
limit:
type: integer
languages:
type: array
type: string[]

ProductGet:
description: 'This class represents a product GET.'
type: object
properties:
languages:
type: array
type: string[]

ProductCreate:
description: 'This class is used to create a product.'
Expand All @@ -2959,9 +2958,10 @@ ProductCreate:
type: string
attributes:
type: array
items: object

ProductUpdate:
description: 'This class is used to create a product.'
description: 'This class is used to update a product.'
type: object
properties:
ContentUpdate:
Expand All @@ -2970,6 +2970,7 @@ ProductUpdate:
type: string
attributes:
type: array
items: object

ProductViewInput:
description: 'This class represents a product view input.'
Expand Down Expand Up @@ -3000,7 +3001,7 @@ ProductVariant:
Product:
type: Product
DiscriminatorAttributesList:
type: array
type: Attribute[]

ProductVariantCreate:
description: 'This class is used to create a product variant.'
Expand All @@ -3011,6 +3012,7 @@ ProductVariantCreate:
attributes:
description: 'array<int|string,mixed>'
type: array
items: mixed

ProductVariantGenerate:
description: 'This class is used to generate a product variant.'
Expand All @@ -3019,6 +3021,7 @@ ProductVariantGenerate:
attributes:
description: 'array<int|string,mixed>'
type: array
items: mixed

ProductVariantUpdate:
description: 'This class is used to update a product variant.'
Expand All @@ -3029,6 +3032,7 @@ ProductVariantUpdate:
attributes:
description: 'array<int|string,mixed>'
type: array
items: mixed

ProductVariantViewInput:
description: 'This class represents a product variant view input.'
Expand Down Expand Up @@ -3087,6 +3091,7 @@ TaxonomyEntry:
type: string
names:
type: array
items: mixed
Parent:
type: TaxonomyEntry
Content:
Expand Down Expand Up @@ -3139,6 +3144,7 @@ TaxonomyEntryUpdateStruct:
type: string
names:
type: array
items: mixed
languageCode:
type: string
mainLanguageCode:
Expand Down Expand Up @@ -3326,7 +3332,7 @@ Order:
OrderItemsList:
type: OrderItem[]
context:
type: array
type: object

OrderUser:
description: 'This class represents order user.'
Expand Down Expand Up @@ -3412,7 +3418,7 @@ OrderItem:
quantity:
type: integer
context:
type: array
type: object

OrderItemValue:
description: 'This class represents order item value.'
Expand Down Expand Up @@ -3650,6 +3656,7 @@ PaymentMethodUpdateStruct:
type: boolean
options:
type: array
items: mixed

PaymentMethodView:
type: object
Expand Down
Loading