Skip to content

IBX-1430: Fix REST API reference #1615

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adriendupuis merged 20 commits into from
Jun 8, 2022
Merged

IBX-1430: Fix REST API reference #1615

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
570b67c
ez-content-location.raml: Fix /children and /urlaliases indentation
adriendupuis May 11, 2022
81c3b56
ez-user-users.raml: Fix HEAD /user/users queryParameters' descriptions
adriendupuis May 13, 2022
7a8c178
ez-content-location.raml: Merge /{path} and /{path}/{locationId}
adriendupuis May 13, 2022
c1b7e01
Format ContentCreate.xml.example
adriendupuis May 23, 2022
e6dffd8
ez-product-attributegroups.raml: Fix two 403 descriptions
adriendupuis May 23, 2022
f321b2b
ez-user-users.raml: Fix UserUpdate indentation
adriendupuis May 24, 2022
ddb5659
Regenerate rest_api_reference.html
adriendupuis May 31, 2022
00d3974
ez-product-attributes.raml: Fix missing colon
adriendupuis Jun 6, 2022
01037de
ez-content-views.raml: GET /content/views doesn't exist
adriendupuis Jun 7, 2022
0678240
ez-content-views.raml: /content/views/{identifier} doesn't exist
adriendupuis Jun 7, 2022
0b72cf0
ez-objectstategroups.raml: Fix …/{objectStateGroupId}/objectstates in…
adriendupuis Jun 7, 2022
5d4cd7b
ez-objectstategroups.raml: Fix …/{contenttypeid}/{fielddefinitionid} …
adriendupuis Jun 7, 2022
b328303
ez-objectstategroups.raml: Init missing GET for …/fieldDefinitions
adriendupuis Jun 7, 2022
fa1c92d
RAML: Fix calendar/calendar and assets/assets
adriendupuis Jun 7, 2022
0dd9251
ez-commerce.raml: Fix …/{basketId}/{basketId} indent
adriendupuis Jun 8, 2022
f26f9c5
Revert "ez-objectstategroups.raml: Init missing GET for …/fieldDefini…
adriendupuis Jun 8, 2022
acfef12
ez-product-attributes.raml: Add missing param to …/attributes/transla…
adriendupuis Jun 8, 2022
e0af064
ez-product-attributes.raml: {identifier} → {id}
adriendupuis Jun 8, 2022
45a1585
Update docs/api/rest_api_reference/input/ez-user-users.raml
adriendupuis Jun 8, 2022
8f914d7
Update docs/api/rest_api_reference/input/ez-user-users.raml
adriendupuis Jun 8, 2022
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
10 changes: 5 additions & 5 deletions docs/api/rest_api_reference/input/examples/content/objects/POST/ContentCreate.xml.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<ContentType href="/api/ibexa/v2/content/types/2"/>
<mainLanguageCode>eng-GB</mainLanguageCode>
<LocationCreate>
<ParentLocation href="/api/ibexa/v2/content/locations/1/2" />
<ParentLocation href="/api/ibexa/v2/content/locations/1/2"/>
<priority>0</priority>
<hidden>false</hidden>
<sortField>PATH</sortField>
Expand All @@ -22,15 +22,15 @@
<fieldDefinitionIdentifier>intro</fieldDefinitionIdentifier>
<languageCode>eng-GB</languageCode>
<fieldValue>
<value key="xml"><![CDATA[<section xmlns="http://ez.no/namespaces/ezpublish5/xhtml5/edit"><p>draft draft</p></section>]]></value>
</fieldValue>
<value key="xml"><![CDATA[<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>draft draft</p></section>]]></value>
</fieldValue>
</field>
<field>
<fieldDefinitionIdentifier>body</fieldDefinitionIdentifier>
<languageCode>eng-GB</languageCode>
<fieldValue>
<value key="xml"><![CDATA[<section xmlns="http://ez.no/namespaces/ezpublish5/xhtml5/edit"><p>draft draft draft </p></section>]]></value>
</fieldValue>
<value key="xml"><![CDATA[<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>draft draft draft</p></section>]]></value>
</fieldValue>
</field>
</fields>
</ContentCreate>
2 changes: 1 addition & 1 deletion docs/api/rest_api_reference/input/ez-calendar.raml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
displayName: Calendar
/calendar/event:
/event:
get:
displayName: Calendar list
description: Calendar event list.
Expand Down
67 changes: 33 additions & 34 deletions docs/api/rest_api_reference/input/ez-commerce.raml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,41 +199,40 @@ displayName: eCommerce API
type: Basket
example: !include examples/commerce/basket/Basket.json.example

/{basketId}:
/line:
post:
displayName: Add products to stored basket
description: Adds products to the stored basket.
body:
application/vnd.ibexa.api.BasketLineData+json:
type: BasketLineData
example: !include examples/commerce/basket/current/lines/POST/BasketLineData.json.example
responses:
200:
body:
application/vnd.ibexa.api.Basket+json:
type: Basket
example: !include examples/commerce/basket/Basket.json.example
400:
body:
application/vnd.ibexa.api.ValidationResponse+json:
type: ValidationResponse
example: !include examples/commerce/basket/current/lines/POST/ValidationResponse.json.example
/line:
post:
displayName: Add products to stored basket
description: Adds products to the stored basket.
body:
application/vnd.ibexa.api.BasketLineData+json:
type: BasketLineData
example: !include examples/commerce/basket/current/lines/POST/BasketLineData.json.example
responses:
200:
body:
application/vnd.ibexa.api.Basket+json:
type: Basket
example: !include examples/commerce/basket/Basket.json.example
400:
body:
application/vnd.ibexa.api.ValidationResponse+json:
type: ValidationResponse
example: !include examples/commerce/basket/current/lines/POST/ValidationResponse.json.example

/line/{lineId}:
delete:
displayName: Delete a line from a stored basket
responses:
200:
body:
application/vnd.ibexa.api.Basket+json:
type: Basket
example: !include examples/commerce/basket/Basket.json.example
400:
body:
application/vnd.ibexa.api.ValidationResponse+json:
type: ValidationResponse
example: !include examples/commerce/basket/_id_/line/_line_id_/DELETE/ValidationResponse.json.example
/line/{lineId}:
delete:
displayName: Delete a line from a stored basket
responses:
200:
body:
application/vnd.ibexa.api.Basket+json:
type: Basket
example: !include examples/commerce/basket/Basket.json.example
400:
body:
application/vnd.ibexa.api.ValidationResponse+json:
type: ValidationResponse
example: !include examples/commerce/basket/_id_/line/_line_id_/DELETE/ValidationResponse.json.example

/{basketName}:
post:
Expand Down
2 changes: 1 addition & 1 deletion docs/api/rest_api_reference/input/ez-content-assets.raml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
displayName: content/assets/images
/assets/images/{assetId}/{assetSource}:
/images/{assetId}/{assetSource}:
get:
displayName: Fetch image asset value
description: Fetches the image asset value object. Depending on the provider, the asset metadata object can contain different parameters.
Expand Down
181 changes: 90 additions & 91 deletions docs/api/rest_api_reference/input/ez-content-location.raml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,105 +84,104 @@ get:
description: Error - the user is not authorized to delete this subtree.
404:
description: Error - the Location with the given ID does not exist.
/children:
get:
displayName: Get child Locations.
description: Loads all child Locations for the given parent Location.
queryParameters:
offset:
description: The offset of the result set.
type: integer
limit:
description: The number of Locations returned.
type: integer
headers:
Accept:
description: If set, the new Location list is returned in XML or JSON format.
example: |
application/vnd.ibexa.api.LocationList+xml
application/vnd.ibexa.api.LocationList+json
responses:
200:
body:
application/vnd.ibexa.api.LocationList+xml:
type: LocationList
example: !include examples/content/locations/path/children/GET/LocationList.xml.example
401:
description: Error - the user is not authorized to read this Content item.
404:
description: Error - the Content item with the given ID does not exist.
/urlaliases:
get:
displayName: List URL aliases for Location
description: Returns the list of URL aliases for a Location.
queryParameters:
custom:
description: Indicates whether autogenerated (false) or manual URL aliases (true) should be returned (default true).
type: boolean
headers:
Accept:
description: If set, the URL alias list contains only references and is returned in XML or JSON format.
example: |
application/vnd.ibexa.api.UrlAliasRefList+xml
application/vnd.ibexa.api.UrlAliasRefList+json
responses:
200:
description: OK - returns the list of URL aliases.
body:
application/vnd.ibexa.api.UrlAliasRefList+xml:
type: UrlAliasRefList
exammple: examples/content/locations/path/urlaliases/GET/UrlAliasRefList.xml.example
400:
description: Error - The user has no permission to read URL aliases.
401:
description: Error - The Location was not found.
/{locationId}:
patch:
displayName: Update Location
description: Updates the Location. This method can also be used to hide/reveal a Location via the hidden field in the LocationUpdate. PATCH or POST with header X-HTTP-Method-Override PATCH.
patch:
displayName: Update Location
description: Updates the Location. This method can also be used to hide/reveal a Location via the hidden field in the LocationUpdate. PATCH or POST with header X-HTTP-Method-Override PATCH.
headers:
Accept:
description: If set, the Location is returned in XML or JSON format.
example: |
application/vnd.ibexa.api.Location+xml
application/vnd.ibexa.api.Location+json
Content-Type:
description: The LocationUpdate schema encoded in XML or JSON format.
example: |
application/vnd.ibexa.api.LocationUpdate+xml
application/vnd.ibexa.api.LocationUpdate+json
If-Match:
description: ETag
body:
application/vnd.ibexa.api.LocationUpdate+xml:
type: LocationUpdateStruct
example: !include examples/content/locations/location_id/PATCH/LocationUpdate.xml.example
application/vnd.ibexa.api.LocationUpdate+json:
type: LocationUpdateStruct
example: !include examples/content/locations/location_id/PATCH/LocationUpdate.json.example
responses:
200:
body:
application/vnd.ibexa.api.Location+xml:
type: Location
example: !include examples/content/locations/location_id/PATCH/Location.xml.example
application/vnd.ibexa.api.Location+json:
type: Location
example: !include examples/content/locations/location_id/PATCH/Location.json.example
401:
description: Error - the user is not authorized to update this Location.
404:
description: Error - the Location with the given ID does not exist.
swap:
displayName: Swap Location
description: Swaps the Location of a Content item with the given Location of another Content item. SWAP or POST with header X-HTTP-Method-Override SWAP.
headers:
Destination:
description: A parent Location resource to which the Location is moved e.g. '/api/ibexa/v2/content/locations/1/63'.
responses:
204:
description: No Content. Swapped the Location of a Content item with the given Location of another Content item.
401:
description: Error - the user is not authorized to swap this Location.
404:
description: Error - the Location with the given ID does not exist.
/children:
get:
displayName: Get child Locations.
description: Loads all child Locations for the given parent Location.
queryParameters:
offset:
description: The offset of the result set.
type: integer
limit:
description: The number of Locations returned.
type: integer
headers:
Accept:
description: If set, the Location is returned in XML or JSON format.
example: |
application/vnd.ibexa.api.Location+xml
application/vnd.ibexa.api.Location+json
Content-Type:
description: The LocationUpdate schema encoded in XML or JSON format.
description: If set, the new Location list is returned in XML or JSON format.
example: |
application/vnd.ibexa.api.LocationUpdate+xml
application/vnd.ibexa.api.LocationUpdate+json
If-Match:
description: ETag
body:
application/vnd.ibexa.api.LocationUpdate+xml:
type: LocationUpdateStruct
example: !include examples/content/locations/location_id/PATCH/LocationUpdate.xml.example
application/vnd.ibexa.api.LocationUpdate+json:
type: LocationUpdateStruct
example: !include examples/content/locations/location_id/PATCH/LocationUpdate.json.example
application/vnd.ibexa.api.LocationList+xml
application/vnd.ibexa.api.LocationList+json
responses:
200:
body:
application/vnd.ibexa.api.Location+xml:
type: Location
example: !include examples/content/locations/location_id/PATCH/Location.xml.example
application/vnd.ibexa.api.Location+json:
type: Location
example: !include examples/content/locations/location_id/PATCH/Location.json.example
application/vnd.ibexa.api.LocationList+xml:
type: LocationList
example: !include examples/content/locations/path/children/GET/LocationList.xml.example
401:
description: Error - the user is not authorized to update this Location.
description: Error - the user is not authorized to read this Content item.
404:
description: Error - the Location with the given ID does not exist.
swap:
displayName: Swap Location
description: Swaps the Location of a Content item with the given Location of another Content item. SWAP or POST with header X-HTTP-Method-Override SWAP.
description: Error - the Content item with the given ID does not exist.
/urlaliases:
get:
displayName: List URL aliases for Location
description: Returns the list of URL aliases for a Location.
queryParameters:
custom:
description: Indicates whether autogenerated (false) or manual URL aliases (true) should be returned (default true).
type: boolean
headers:
Destination:
description: A parent Location resource to which the Location is moved e.g. '/api/ibexa/v2/content/locations/1/63'.
Accept:
description: If set, the URL alias list contains only references and is returned in XML or JSON format.
example: |
application/vnd.ibexa.api.UrlAliasRefList+xml
application/vnd.ibexa.api.UrlAliasRefList+json
responses:
204:
description: No Content. Swapped the Location of a Content item with the given Location of another Content item.
200:
description: OK - returns the list of URL aliases.
body:
application/vnd.ibexa.api.UrlAliasRefList+xml:
type: UrlAliasRefList
exammple: examples/content/locations/path/urlaliases/GET/UrlAliasRefList.xml.example
400:
description: Error - The user has no permission to read URL aliases.
401:
description: Error - the user is not authorized to swap this Location.
404:
description: Error - the Location with the given ID does not exist.
description: Error - The Location was not found.
49 changes: 25 additions & 24 deletions docs/api/rest_api_reference/input/ez-content-types.raml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,30 +118,31 @@ get:
description: Error - There are object instances of this Content Type.
404:
description: Error - The Content Type does not exist.
/{fieldDefinitionId}:
get:
displayName: Get Field definition
description: Returns the Field definition by the given ID.
headers:
Accept:
description: If set, the Field definition is returned in XML or JSON format.
example: |
application/vnd.ibexa.api.FieldDefinition+xml
application/vnd.ibexa.api.FieldDefinition+json
responses:
200:
description: OK - returns the Field definition.
body:
application/vnd.ibexa.api.FieldDefinition+xml:
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
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.
404:
description: Error - The Content Type does not exist.
/fieldDefinitions:
/{fieldDefinitionId}:
get:
displayName: Get Field definition
description: Returns the Field definition by the given ID.
headers:
Accept:
description: If set, the Field definition is returned in XML or JSON format.
example: |
application/vnd.ibexa.api.FieldDefinition+xml
application/vnd.ibexa.api.FieldDefinition+json
responses:
200:
description: OK - returns the Field definition.
body:
application/vnd.ibexa.api.FieldDefinition+xml:
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
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.
404:
description: Error - The Content Type does not exist.
/draft:
patch:
displayName: Update Content Type draft
Expand Down
Loading