Skip to content

Commit c2b3051

Browse files
mnoconmnocon
committed
Self review fixes
1 parent 1bc7027 commit c2b3051

File tree

6 files changed

+995
-72
lines changed

6 files changed

+995
-72
lines changed

‎docs/api/rest_api/rest_api_reference/input/examples/content/trash/trash_itemid/POST/RestoreTrashItemInput.xml example‎ renamed to ‎docs/api/rest_api/rest_api_reference/input/examples/content/trash/trash_itemid/POST/RestoreTrashItemInput.xml.example‎

File renamed without changes.

‎docs/api/rest_api/rest_api_reference/input/ibexa-content-locations.raml‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -99,11 +99,11 @@ get:
9999
description: Error - the Location with the given ID does not exist.
100100
post:
101101
displayName: Swap Location / Copy subtree / Move subtree / Trash
102-
description: Swaps the Location of a content item with the given Location of another content item, or copies a subtree or moves a subtree, all depending on request method or Content-Type header. Request method can be POST, SWAP, COPY, MOVE, or TRASH.
102+
description: "Depending on request method or Content-Type header, one of the following: swaps the Location of a content item with the given Location of another content item, copies a subtree, moves a subtree, sends location to trash. Request method can be POST, SWAP, COPY, MOVE, or TRASH."
103103
headers:
104104
Content-Type:
105105
description: Required only when using POST request method. Indicates the format of the request body and the action.
106-
examples: |
106+
example: |
107107
application/vnd.ibexa.api.SwapLocationInput+json
108108
application/vnd.ibexa.api.SwapLocationInput+xml
109109
application/vnd.ibexa.api.CopyLocationInput+json
@@ -114,21 +114,21 @@ get:
114114
application/vnd.ibexa.api.TrashLocationInput+xml
115115
Destination:
116116
description: Required only when using SWAP, COPY, or MOVE request methods. A location resource to swap with, copy the subtree to, or move the subtree to, e.g. '/api/ibexa/v2/content/locations/1/63'.
117+
example: /api/ibexa/v2/content/locations/1/63
117118
body:
118119
description: Used together with POST request method. Indicates the location to swap with or the subtree to copy
119-
example: |
120-
application/vnd.ibexa.api.SwapLocationInput+json:
121-
type: SwapLocationInputWrapper
122-
example: !include examples/content/locations/path/POST/SwapLocationInput.json.example
123-
application/vnd.ibexa.api.SwapLocationInput+xml:
124-
type: SwapLocationInput
125-
example: !include examples/content/locations/path/POST/SwapLocationInput.xml.example
126-
application/vnd.ibexa.api.SwapLocationInput+json:
127-
type: CopyLocationInputWrapper
128-
example: !include examples/content/locations/path/POST/SwapLocationInput.json.example
129-
application/vnd.ibexa.api.SwapLocationInput+xml:
130-
type: CopyLocationInput
131-
example: !include examples/content/locations/path/POST/SwapLocationInput.json.example
120+
application/vnd.ibexa.api.SwapLocationInput+json:
121+
type: SwapLocationInputWrapper
122+
example: !include examples/content/locations/path/POST/SwapLocationInput.json.example
123+
application/vnd.ibexa.api.SwapLocationInput+xml:
124+
type: SwapLocationInput
125+
example: !include examples/content/locations/path/POST/SwapLocationInput.xml.example
126+
application/vnd.ibexa.api.CopyLocationInput+json:
127+
type: CopyLocationInputWrapper
128+
example: !include examples/content/locations/path/POST/CopyLocationInput.json.example
129+
application/vnd.ibexa.api.CopyLocationInput+xml:
130+
type: CopyLocationInput
131+
example: !include examples/content/locations/path/POST/CopyLocationInput.xml.example
132132
responses:
133133
201:
134134
description: Created. Copied or moved the subtree to a different parent, or sent the location to Trash.

‎docs/api/rest_api/rest_api_reference/input/ibexa-content-trash.raml‎

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -68,19 +68,18 @@ delete:
6868
description: Used together with MOVE request method. If the destination Location URI (e.g. /api/ibexa/v2/content/locations/1/2) is provided, the item from Trash is restored under this Location, otherwise it is restored under its original parent Location.
6969
body:
7070
description: Used together with POST request method. Omit the "destination" property to restore under original location.
71-
example: |
72-
application/vnd.ibexa.api.RestoreTrashItemInput+json:
73-
type: RestoreTrashItemInputWrapper
74-
example: !include examples/content/trash/trash_itemid/POST/RestoreTrashItemInput.json.example
75-
application/vnd.ibexa.api.RestoreTrashItemInput+xml:
76-
type: RestoreTrashItemInput
77-
example: !include examples/content/trash/trash_itemid/POST/RestoreTrashItemInput.xml.example
78-
application/vnd.ibexa.api.RestoreTrashItemInput+json:
79-
type: RestoreTrashItemInputWrapper
80-
example: !include examples/content/trash/trash_itemid/POST/RestoreTrashItemInputOriginal.json.example
81-
application/vnd.ibexa.api.RestoreTrashItemInput+xml:
82-
type: RestoreTrashItemInput
83-
example: !include examples/content/trash/trash_itemid/POST/RestoreTrashItemInputOriginal.xml.example
71+
application/vnd.ibexa.api.RestoreTrashItemInput+json:
72+
type: RestoreTrashItemInputWrapper
73+
example: !include examples/content/trash/trash_itemid/POST/RestoreTrashItemInput.json.example
74+
application/vnd.ibexa.api.RestoreTrashItemInput+xml:
75+
type: RestoreTrashItemInput
76+
example: !include examples/content/trash/trash_itemid/POST/RestoreTrashItemInput.xml.example
77+
application/vnd.ibexa.api.RestoreTrashItemInputOriginalLocation+json:
78+
type: RestoreTrashItemInputWrapper
79+
example: !include examples/content/trash/trash_itemid/POST/RestoreTrashItemInputOriginal.json.example
80+
application/vnd.ibexa.api.RestoreTrashItemInputOriginalLocation+xml:
81+
type: RestoreTrashItemInput
82+
example: !include examples/content/trash/trash_itemid/POST/RestoreTrashItemInputOriginal.xml.example
8483
responses:
8584
201:
8685
description: Item restored.

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

Lines changed: 32 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6279,38 +6279,50 @@ SwapLocationInputWrapper:
62796279
type: object
62806280
properties:
62816281
SwapLocationInput:
6282-
type: object
6283-
properties:
6284-
destination:
6285-
type: string
6286-
description: The location path to swap with.
6282+
type: SwapLocationInput
6283+
6284+
SwapLocationInput:
6285+
type: object
6286+
properties:
6287+
destination:
6288+
type: string
6289+
description: The location path to swap with.
62876290

62886291
MoveUserGroupInputWrapper:
62896292
type: object
62906293
properties:
62916294
MoveUserGroupInput:
6292-
type: object
6293-
properties:
6294-
destination:
6295-
type: string
6296-
description: The path string of the new parent location.
6295+
type: MoveUserGroupInput
6296+
6297+
MoveUserGroupInput:
6298+
type: object
6299+
properties:
6300+
destination:
6301+
type: string
6302+
description: The path string of the new parent location.
62976303

62986304
CopyLocationInputWrapper:
62996305
type: object
63006306
properties:
63016307
CopyLocationInput:
6302-
type: object
6303-
properties:
6304-
destination:
6305-
type: string
6306-
description: The location path the subtree will be copied to.
6308+
type: CopyLocationInput
6309+
6310+
CopyLocationInput:
6311+
type: object
6312+
properties:
6313+
destination:
6314+
type: string
6315+
description: The location path the subtree will be copied to.
63076316

63086317
RestoreTrashItemInputWrapper:
63096318
type: object
63106319
properties:
63116320
RestoreTrashItemInput:
6312-
type: object
6313-
properties:
6314-
destination:
6315-
type: string
6316-
description: The path string under which the item should be restored.
6321+
type: RestoreTrashItemInput
6322+
6323+
RestoreTrashItemInput:
6324+
type: object
6325+
properties:
6326+
destination:
6327+
type: string
6328+
description: The path string under which the item should be restored.

‎docs/api/rest_api/rest_api_reference/input/ibexa-user-groups.raml‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -157,20 +157,20 @@ get:
157157
headers:
158158
Content-Type:
159159
description: Required only when using POST request method. Indicates the format of the request body.
160-
examples: |
160+
example: |
161161
application/vnd.ibexa.api.MoveUserGroupInput+json
162162
application/vnd.ibexa.api.MoveUserGroupInput+xml
163163
Destination:
164164
description: Required only when using MOVE request method. A parent group resource to which the Location is moved.
165+
example: /api/ibexa/v2/content/locations/1/63
165166
body:
166167
description: Required only when using POST request method. A parent group resource to which the Location is moved.
167-
example: |
168-
application/vnd.ibexa.api.MoveUserGroupInputWrapper+json:
169-
type: MoveUserGroupInputWrapper
170-
example: !include examples/user/groups/path/POST/MoveUserGroupInput.json.example
171-
application/vnd.ibexa.api.MoveUserGroupInput+xml:
172-
type: MoveUserGroupInput
173-
example: !include examples/user/groups/path/POST/MoveUserGroupInput.xml.example
168+
application/vnd.ibexa.api.MoveUserGroupInputWrapper+json:
169+
type: MoveUserGroupInputWrapper
170+
example: !include examples/user/groups/path/POST/MoveUserGroupInput.json.example
171+
application/vnd.ibexa.api.MoveUserGroupInput+xml:
172+
type: MoveUserGroupInput
173+
example: !include examples/user/groups/path/POST/MoveUserGroupInput.xml.example
174174
responses:
175175
201:
176176
description: Created - moves the User Group to another parent.

0 commit comments

Comments
 (0)