Skip to content

Commit 6813729

Browse files
adriendupuisadriendupuis
authored
Fix RAML syntax (#2042)
1 parent 82036ba commit 6813729

File tree

4 files changed

+155
-157
lines changed

4 files changed

+155
-157
lines changed

‎docs/api/rest_api/rest_api_reference/input/ez-calendar.raml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,6 @@ displayName: Calendar
8181
description: A calendar action that e.g. reschedules or unschedules calendar events. The event type should always be copied from an event.
8282
headers:
8383
Content-Type:
84-
description:
8584
example: |
8685
application/vnd.ibexa.api.calendar.future_publication.UnscheduleAction+json
8786
body:

‎docs/api/rest_api/rest_api_reference/input/ez-corporate.raml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,6 @@ get:
7373

7474
post:
7575
displayName: Create a company
76-
description:
7776
headers:
7877
Accept:
7978
description: If set, the new company is returned in XML or JSON format.

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

Lines changed: 47 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -559,10 +559,10 @@ ContentTypeUpdateStruct:
559559
type: datetime
560560
names:
561561
description: 'If set this array of names with languageCode keys replace the complete name collection.'
562-
type: array
562+
type: Value[]
563563
descriptions:
564564
description: 'If set this array of descriptions with languageCode keys replace the complete description collection.'
565-
type: array
565+
type: Value[]
566566

567567
ContentUpdateStruct:
568568
description: 'This class is used for updating the fields of a Content item draft.'
@@ -615,6 +615,7 @@ CreateStruct:
615615
data:
616616
description: 'Notification data.'
617617
type: array
618+
items: mixed
618619
Criterion:
619620
description: 'Criterion implementations.'
620621
type: object
@@ -625,6 +626,7 @@ Criterion:
625626
value:
626627
description: 'The value(s) matched by the Criteria.'
627628
type: array
629+
items: mixed
628630
target:
629631
description: 'The target used by the Criteria (field, metadata...).'
630632
type: string
@@ -813,10 +815,10 @@ FieldDefinitionCreateStruct:
813815
type: string
814816
names:
815817
description: 'An array of names with languageCode keys.'
816-
type: array
818+
type: Value[]
817819
descriptions:
818820
description: 'An array of descriptions with languageCode keys.'
819-
type: array
821+
type: Value[]
820822
fieldGroup:
821823
description: 'Field group name.'
822824
type: string
@@ -853,10 +855,10 @@ FieldDefinitionUpdateStruct:
853855
type: string
854856
names:
855857
description: 'If set this array of names with languageCode keys replace the complete name collection.'
856-
type: array
858+
type: Value[]
857859
descriptions:
858860
description: 'If set this array of descriptions with languageCode keys replace the complete description collection.'
859-
type: array
861+
type: Value[]
860862
fieldGroup:
861863
description: 'If set the field group is changed to this name.'
862864
type: string
@@ -905,9 +907,6 @@ Language:
905907
description: 'This class represents a language in the Repository.'
906908
type: BaseObject
907909
properties:
908-
ALL:
909-
description: "Constant for use in API's to specify that you want to load all languages."
910-
type: array
911910
id:
912911
description: 'The language ID (auto generated).'
913912
type: integer
@@ -1073,6 +1072,7 @@ Message:
10731072
values:
10741073
description: 'Translation value objects. May not contain any numbers, which might result in requiring plural forms. Use Plural for that.'
10751074
type: array
1075+
items: mixed
10761076
Notification:
10771077
description: 'This class represents a notification value.'
10781078
type: object
@@ -1095,6 +1095,7 @@ Notification:
10951095
data:
10961096
description: 'This class represents data.'
10971097
type: array
1098+
items: mixed
10981099
NotificationList:
10991100
description: 'This class represents a notifications list.'
11001101
type: object
@@ -1291,6 +1292,7 @@ Plural:
12911292
values:
12921293
description: 'Translation value objects. May not contain any numbers, which might result in requiring plural forms. Use MessagePlural for that.'
12931294
type: array
1295+
items: mixed
12941296
Policy:
12951297
description: 'This class represents a policy value.'
12961298
type: BaseObject
@@ -1720,7 +1722,7 @@ UrlAlias:
17201722
type: any
17211723
path:
17221724
description: 'The full path of the alias.'
1723-
type:
1725+
type: string
17241726
languageCodes:
17251727
description: 'The languageCodes for which this path is valid.'
17261728
type: string[]
@@ -2046,6 +2048,7 @@ ValueObject:
20462048
Properties:
20472049
description: 'Function where list of properties are returned.'
20482050
type: array
2051+
items: mixed
20492052
Version:
20502053
description: 'Returns the VersionInfo for this version.'
20512054
type: BaseObject
@@ -2175,9 +2178,9 @@ ContentTypeCreate:
21752178
defaultAlwaysAvailable:
21762179
type: boolean
21772180
names:
2178-
type: array
2181+
type: Value[]
21792182
descriptions:
2180-
type: array
2183+
type: Value[]
21812184
FieldDefinition:
21822185
type: FieldDefinition
21832186
creatorId:
@@ -2212,9 +2215,9 @@ ContentTypeUpdate:
22122215
defaultAlwaysAvailable:
22132216
type: boolean
22142217
names:
2215-
type: array
2218+
type: Value[]
22162219
descriptions:
2217-
type: array
2220+
type: Value[]
22182221
modifierId:
22192222
description: 'If set, this value overrides the current user as creator.'
22202223
type: any
@@ -2475,9 +2478,9 @@ CatalogCreate:
24752478
Criteria:
24762479
type: Criterion
24772480
names:
2478-
type: array
2481+
type: object
24792482
descriptions:
2480-
type: array
2483+
type: object
24812484
status:
24822485
type: string
24832486
creator_id:
@@ -2494,9 +2497,9 @@ CatalogUpdate:
24942497
Criteria:
24952498
type: Criterion
24962499
names:
2497-
type: array
2500+
type: object
24982501
descriptions:
2499-
type: array
2502+
type: object
25002503

25012504
CatalogCopy:
25022505
description: 'This class is used to copy a catalog.'
@@ -2610,11 +2613,9 @@ AttributeGroupCreate:
26102613
identifier:
26112614
type: string
26122615
names:
2613-
type: array
2616+
type: string[]
26142617
position:
26152618
type: integer
2616-
languages:
2617-
type: array
26182619

26192620
AttributeGroupUpdate:
26202621
description: 'This class is used to update an attribute group.'
@@ -2623,11 +2624,9 @@ AttributeGroupUpdate:
26232624
identifier:
26242625
type: string
26252626
names:
2626-
type: array
2627+
type: object
26272628
position:
26282629
type: integer
2629-
languages:
2630-
type: array
26312630

26322631
AttributeGroupList:
26332632
description: 'This class represents an attribute group list.'
@@ -2669,7 +2668,7 @@ Attribute:
26692668
position:
26702669
type: integer
26712670
options:
2672-
type: array
2671+
type: object
26732672

26742673
AttributeCreate:
26752674
description: 'This class is used to create an attribute.'
@@ -2682,13 +2681,14 @@ AttributeCreate:
26822681
group:
26832682
type: string
26842683
names:
2685-
type: array
2684+
type: object
26862685
descriptions:
2687-
type: array
2686+
type: object
26882687
positions:
26892688
type: integer
26902689
options:
26912690
type: array
2691+
items: mixed
26922692

26932693
AttributeUpdate:
26942694
description: 'This class is used to update an attribute.'
@@ -2697,13 +2697,14 @@ AttributeUpdate:
26972697
identifier:
26982698
type: string
26992699
names:
2700-
type: array
2700+
type: object
27012701
descriptions:
2702-
type: array
2702+
type: object
27032703
positions:
27042704
type: integer
27052705
options:
27062706
type: array
2707+
items: mixed
27072708

27082709
AttributeList:
27092710
description: 'This class represents an attribute list.'
@@ -2780,9 +2781,9 @@ CustomerGroupCreate:
27802781
identifier:
27812782
type: string
27822783
names:
2783-
type: array
2784+
type: object
27842785
descriptions:
2785-
type: array
2786+
type: object
27862787
global_price_rate:
27872788
description: 'numeric-string'
27882789
type: string
@@ -2792,13 +2793,11 @@ CustomerGroupUpdate:
27922793
type: object
27932794
properties:
27942795
names:
2795-
type: array
2796+
type: object
27962797
identifier:
27972798
type: string
27982799
position:
27992800
type: integer
2800-
languages:
2801-
type: array
28022801

28032802
CustomerGroupViewInput:
28042803
description: 'This class represents a customer group view input.'
@@ -2940,14 +2939,14 @@ ProductListGet:
29402939
limit:
29412940
type: integer
29422941
languages:
2943-
type: array
2942+
type: string[]
29442943

29452944
ProductGet:
29462945
description: 'This class represents a product GET.'
29472946
type: object
29482947
properties:
29492948
languages:
2950-
type: array
2949+
type: string[]
29512950

29522951
ProductCreate:
29532952
description: 'This class is used to create a product.'
@@ -2959,9 +2958,10 @@ ProductCreate:
29592958
type: string
29602959
attributes:
29612960
type: array
2961+
items: object
29622962

29632963
ProductUpdate:
2964-
description: 'This class is used to create a product.'
2964+
description: 'This class is used to update a product.'
29652965
type: object
29662966
properties:
29672967
ContentUpdate:
@@ -2970,6 +2970,7 @@ ProductUpdate:
29702970
type: string
29712971
attributes:
29722972
type: array
2973+
items: object
29732974

29742975
ProductViewInput:
29752976
description: 'This class represents a product view input.'
@@ -3000,7 +3001,7 @@ ProductVariant:
30003001
Product:
30013002
type: Product
30023003
DiscriminatorAttributesList:
3003-
type: array
3004+
type: Attribute[]
30043005

30053006
ProductVariantCreate:
30063007
description: 'This class is used to create a product variant.'
@@ -3011,6 +3012,7 @@ ProductVariantCreate:
30113012
attributes:
30123013
description: 'array<int|string,mixed>'
30133014
type: array
3015+
items: mixed
30143016

30153017
ProductVariantGenerate:
30163018
description: 'This class is used to generate a product variant.'
@@ -3019,6 +3021,7 @@ ProductVariantGenerate:
30193021
attributes:
30203022
description: 'array<int|string,mixed>'
30213023
type: array
3024+
items: mixed
30223025

30233026
ProductVariantUpdate:
30243027
description: 'This class is used to update a product variant.'
@@ -3029,6 +3032,7 @@ ProductVariantUpdate:
30293032
attributes:
30303033
description: 'array<int|string,mixed>'
30313034
type: array
3035+
items: mixed
30323036

30333037
ProductVariantViewInput:
30343038
description: 'This class represents a product variant view input.'
@@ -3087,6 +3091,7 @@ TaxonomyEntry:
30873091
type: string
30883092
names:
30893093
type: array
3094+
items: mixed
30903095
Parent:
30913096
type: TaxonomyEntry
30923097
Content:
@@ -3139,6 +3144,7 @@ TaxonomyEntryUpdateStruct:
31393144
type: string
31403145
names:
31413146
type: array
3147+
items: mixed
31423148
languageCode:
31433149
type: string
31443150
mainLanguageCode:
@@ -3326,7 +3332,7 @@ Order:
33263332
OrderItemsList:
33273333
type: OrderItem[]
33283334
context:
3329-
type: array
3335+
type: object
33303336

33313337
OrderUser:
33323338
description: 'This class represents order user.'
@@ -3412,7 +3418,7 @@ OrderItem:
34123418
quantity:
34133419
type: integer
34143420
context:
3415-
type: array
3421+
type: object
34163422

34173423
OrderItemValue:
34183424
description: 'This class represents order item value.'
@@ -3650,6 +3656,7 @@ PaymentMethodUpdateStruct:
36503656
type: boolean
36513657
options:
36523658
type: array
3659+
items: mixed
36533660

36543661
PaymentMethodView:
36553662
type: object

0 commit comments

Comments
 (0)