Skip to content

5.0: Update REST API Ref links #2835

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.

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
merged 10 commits into from
Jul 21, 2025
2 changes: 1 addition & 1 deletion docs/administration/recent_activity/recent_activity.md
Original file line number Diff line number Diff line change
Expand Up @@ -262,4 +262,4 @@ Thanks to the previous subscriber, the related object is available at display ti
## REST API

You can browse activity logs with REST API.
For more information, see the [REST API reference](../../api/rest_api/rest_api_reference/rest_api_reference.html#monitoring-activity).
For more information, see the [REST API reference](/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Activity-Log).
2 changes: 1 addition & 1 deletion docs/api/rest_api/rest_api_usage/rest_requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ This script:

- receives an image path and optionally a name as command-line arguments,
- uses the [HTTP basic authentication](rest_api_authentication.md#http-basic-authentication), if it's enabled,
- creates a draft in the /Media/Images folder by posting (`POST`) data to [`/content/objects`](../rest_api_reference/rest_api_reference.html#managing-content-create-content-item),
- creates a draft in the /Media/Images folder by posting (`POST`) data to [`/content/objects`](/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Objects/operation/api_contentobjects_post),
- and, publishes (`PUBLISH`) the draft through [`/content/objects/{contentId}/versions/{versionNo}`](../rest_api_reference/rest_api_reference.html#managing-content-publish-a-content-version).

=== "XML"
Expand Down
2 changes: 1 addition & 1 deletion docs/api/rest_api/rest_api_usage/rest_responses.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Those example `Accept-Path` headers above indicate that the content could be mod

### Location header

For example, [creating content](../rest_api_reference/rest_api_reference.html#managing-content-create-content-type) and [getting a content item's current version](../rest_api_reference/rest_api_reference.html#managing-content-get-current-version)
For example, [creating content](../rest_api_reference/rest_api_reference.html#managing-content-create-content-type) and [getting a content item's current version](/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Objects/operation/api_contentobjects_contentIdcurrentversion_get)
both send a `Location` header to provide you with the requested resource's ID.

Those particular headers generally match a specific list of HTTP response codes.
Expand Down
2 changes: 1 addition & 1 deletion docs/commerce/cart/cart.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ It covers actions related to the creation and handling of a list of products tha
The component exposes the following:

- [PHP API](cart_api.md) that allows for managing carts and cart entries, or checking cart validity
- [REST API](../../api/rest_api/rest_api_reference/rest_api_reference.html#managing-commerce-carts) that helps get cart and products information over HTTP
- [REST API](/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Cart) that helps get cart and products information over HTTP
- [Twig functions](cart_twig_functions.md) that enable checking whether product can be added to cart and formatting the price

There is no specific configuration related to the cart component.
Expand Down
2 changes: 1 addition & 1 deletion docs/commerce/cart/cart_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ edition: commerce

!!! tip "Cart REST API"

To learn how to manage carts with the REST API, see the [REST API reference](../../api/rest_api/rest_api_reference/rest_api_reference.html#managing-commerce-carts).
To learn how to manage carts with the REST API, see the [REST API reference](/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Cart).

To get carts and work with them, use the `Ibexa\Contracts\Cart\CartServiceInterface` interface.

Expand Down
2 changes: 1 addition & 1 deletion docs/commerce/order_management/order_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ From the development perspective, the component enables customization of the ord
The component exposes the following:

- [PHP API](order_management_api.md) that allows for managing orders
- [REST API](../../api/rest_api/rest_api_reference/rest_api_reference.html#orders) that helps get order information over HTTP
- [REST API](/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Orders) that helps get order information over HTTP

### Order management service

Expand Down
2 changes: 1 addition & 1 deletion docs/commerce/order_management/order_management_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ month_change: false

!!! tip "Order management REST API"

To learn how to manage orders with the REST API, see the [REST API reference](../../api/rest_api/rest_api_reference/rest_api_reference.html#orders).
To learn how to manage orders with the REST API, see the [REST API reference](/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Orders).

To get orders and manage them, use the [`Ibexa\Contracts\OrderManagement\OrderServiceInterface`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-OrderManagement-OrderServiceInterface.html) interface.

Expand Down
4 changes: 2 additions & 2 deletions docs/commerce/payment/payment.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ From the development perspective, the component enables [customization of the pa
The component exposes the following APIs:

- [Payment method PHP API](payment_method_api.md) that allows for managing payment methods
- [Payment method REST API](../../api/rest_api/rest_api_reference/rest_api_reference.html#payment-methods) that helps manage payment methods over HTTP
- [Payment method REST API](/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Payments) that helps manage payment methods over HTTP
- [Payment PHP API](payment_api.md) that allows for managing payments

### Services

The Payment package provides the following services, which are entry points for calling backend APIs:

- `Ibexa\Contracts\Payment\PaymentMethodServiceInterface`
- `Ibexa\Contracts\Payment\PaymentServiceInterface`
- `Ibexa\Contracts\Payment\PaymentServiceInterface`
2 changes: 1 addition & 1 deletion docs/commerce/payment/payment_method_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ edition: commerce

!!! tip "Order management REST API"

To learn how to manage payment methods with the REST API, see the [REST API reference](../../api/rest_api/rest_api_reference/rest_api_reference.html#payment-methods).
To learn how to manage payment methods with the REST API, see the [REST API reference](/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Payments).

To get payment methods and manage them, use the `Ibexa\Contracts\Payment\PaymentMethodServiceInterface` interface.

Expand Down
2 changes: 1 addition & 1 deletion docs/content_management/content_api/browsing_content.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The service should be [injected into the constructor of your command or controll

!!! tip "Content REST API"

To learn how to load content items using the REST API, see [REST API reference](../../api/rest_api/rest_api_reference/rest_api_reference.html#managing-content-load-content).
To learn how to load content items using the REST API, see [REST API reference](/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Objects/operation/api_contentobjects_contentId_get).

!!! tip "Console commands"

Expand Down
2 changes: 1 addition & 1 deletion docs/content_management/content_api/creating_content.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ description: Create, publish, update and translate content items by using the PH

!!! tip "Content REST API"

To learn how to create content items using the REST API, see [REST API reference](../../api/rest_api/rest_api_reference/rest_api_reference.html#managing-content-create-content-item).
To learn how to create content items using the REST API, see [REST API reference](/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Objects/operation/api_contentobjects_post).

## Creating content item draft

Expand Down
8 changes: 4 additions & 4 deletions docs/content_management/content_api/managing_content.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ You can manage [locations](locations.md) that hold content using [`LocationServi

!!! tip "Location REST API"

To learn how to manage locations using the REST API, see [REST API reference](../../api/rest_api/rest_api_reference/rest_api_reference.html#managing-content-create-new-location-for-content-item).
To learn how to manage locations using the REST API, see [REST API reference](/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Objects/operation/api_contentobjects_contentIdlocations_post).

### Adding a new location to a content item

Expand Down Expand Up @@ -99,7 +99,7 @@ You can move a location with its whole subtree using [`LocationService::moveSubt

!!! tip "Trash REST API"

To learn how to manage Trash using the REST API, see [REST API reference](../../api/rest_api/rest_api_reference/rest_api_reference.html#managing-content-list-trash-items).
To learn how to manage Trash using the REST API, see [REST API reference](/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Trash).

To empty the Trash (remove all locations in Trash), use [`TrashService::emptyTrash`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-TrashService.html#method_emptyTrash), which takes no arguments.

Expand All @@ -126,7 +126,7 @@ For more information, see [Searching in trash](search_api.md#searching-in-trash)

!!! tip "Content type REST API"

To learn how to manage content types using the REST API, see [REST API reference](../../api/rest_api/rest_api_reference/rest_api_reference.html#managing-content-get-content-type-groups).
To learn how to manage content types using the REST API, see REST API reference for [content types](/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Type) and [content type groups](/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Type-Groups).

### Adding content types

Expand Down Expand Up @@ -169,7 +169,7 @@ You can handle the calendar using `CalendarServiceInterface` (`Ibexa\Contracts\C

!!! tip "Calendar REST API"

To learn how to manage the Calendar using the REST API, see [REST API reference](../../api/rest_api/rest_api_reference/rest_api_reference.html#calendar).
To learn how to manage the Calendar using the REST API, see [REST API reference](/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Calendar).

### Getting events

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: You can use the PHP API to view the bookmark list, and add or remov

!!! tip "Bookmark REST API"

To learn how to manage bookmarks using the REST API, see [REST API reference](../../api/rest_api/rest_api_reference/rest_api_reference.html#managing-bookmarks).
To learn how to manage bookmarks using the REST API, see [REST API reference](/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Bookmark).

To view a list of all bookmarks, use [`BookmarkService::loadBookmarks`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-BookmarkService.html#method_loadBookmarks):

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ You can manage Object states by using the PHP API by using `ObjectStateService`.

!!! tip "Object state REST API"

To learn how to manage object states using the REST API, see [REST API reference](../../api/rest_api/rest_api_reference/rest_api_reference.html#managing-content-get-object-states-of-content-item).
To learn how to manage object states using the REST API, see [REST API reference](/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Objects/operation/api_contentobjects_contentIdobjectstates_get).

## Getting object state information

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ You can manage sections by using the PHP API by using `SectionService`.

!!! tip "Section REST API"

To learn how to manage sections using the REST API, see [REST API reference](../../api/rest_api/rest_api_reference/rest_api_reference.html#managing-content-get-sections).
To learn how to manage sections using the REST API, see [REST API reference](/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Section).

## Creating sections

Expand Down
4 changes: 2 additions & 2 deletions docs/customer_management/customer_portal_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ Finally, you can customize the registration site itself.

### REST API

Customer Portal comes with [REST API](https://doc.ibexa.co/en/latest/api/rest_api/rest_api_reference/rest_api_reference.html#corporate-account) for interacting with corporate accounts from the context of the [[= product_name_connect =]] app.
Customer Portal comes with [REST API](/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Corporate-Account) for interacting with corporate accounts from the context of the [[= product_name_connect =]] app.

## Capabilities

Expand Down Expand Up @@ -181,4 +181,4 @@ Thus, reducing the need to allocate resources to extend working hours or hire mo

### Localization and personalization

The use of Page Builder in the Customer Portal creation process enables you to create unique experiences for each business customer based on their location, business type, company, or market they operate on.
The use of Page Builder in the Customer Portal creation process enables you to create unique experiences for each business customer based on their location, business type, company, or market they operate on.
2 changes: 1 addition & 1 deletion docs/pim/product_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ month_change: false

!!! tip "Product REST API"

To learn how to load products using the REST API, see [REST API reference](../api/rest_api/rest_api_reference/rest_api_reference.html#product-catalog-create-product-type).
To learn how to load products using the REST API, see [REST API reference](/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Product/operation/api_productcatalogproductsview_post).

### Getting product information

Expand Down
12 changes: 6 additions & 6 deletions docs/release_notes/ibexa_dxp_v4.6.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ month_change: true

#### REST API

- Discounts can now be [managed through the REST API](/api/rest_api/rest_api_reference/rest_api_reference.html#discounts)
- Discounts can now be [managed through the REST API](https://doc.ibexa.co/en/4.6/api/rest_api/rest_api_reference/rest_api_reference.html#discounts)

#### PHP API

Expand Down Expand Up @@ -135,7 +135,7 @@ To learn more, see the [published security advisory IBEXA-SA-2025-002](https://d

#### Features

- The [CartSummary endpoint](https://doc.ibexa.co/en/latest/api/rest_api/rest_api_reference/rest_api_reference.html#managing-commerce-carts-cart-summary) now supports a new `Accept` header: `application/vnd.ibexa.api.ShortCartSummary`, returning only the essential data about products in the cart
- The [CartSummary endpoint](https://doc.ibexa.co/en/4.6/api/rest_api/rest_api_reference/rest_api_reference.html#managing-commerce-carts-cart-summary) now supports a new `Accept` header: `application/vnd.ibexa.api.ShortCartSummary`, returning only the essential data about products in the cart
- Added a new repository setting: [grace period for archived versions](https://doc.ibexa.co/en/latest/administration/configuration/repository_configuration/#grace-period-for-archived-versions)
- Added a new `group_remote_id` setting for [controlling the user group in which registering users are created](https://doc.ibexa.co/en/latest/users/user_registration/#user-groups)

Expand Down Expand Up @@ -223,7 +223,7 @@ To learn more, see the [corresponding security advisory](https://developers.ibex

#### Features

- New REST API endpoints for [Segments](../api/rest_api/rest_api_reference/rest_api_reference.html#segments) and [Segment Groups](../api/rest_api/rest_api_reference/rest_api_reference.html#segment-groups)
- New REST API endpoints for [Segments](https://doc.ibexa.co/en/4.6/api/rest_api/rest_api_reference/rest_api_reference.html#segments) and [Segment Groups](https://doc.ibexa.co/en/4.6/api/rest_api/rest_api_reference/rest_api_reference.html#segment-groups)
- PHP API Client ([`Ibexa\Contracts\Connect\ConnectClientInterface`](https://doc.ibexa.co/en/4.6/api/php_api/php_api_reference/classes/Ibexa-Contracts-Connect-ConnectClientInterface.html)) for [Ibexa Connect]([[= connect_doc =]])
- The following Twig functions now additionally support objects implementing the [`ContentAwareInterface`](https://doc.ibexa.co/en/4.6/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Content-ContentAwareInterface.html) as arguments:
- [`ibexa_content_field_identifier_first_filled_image`](image_twig_functions.md#ibexa_content_field_identifier_first_filled_image)
Expand Down Expand Up @@ -344,8 +344,8 @@ The PHP API has been enhanced with the following new classes:

The REST API has been extended to include endpoints for:

- [Action Configurations](../api/rest_api/rest_api_reference/rest_api_reference.html#ai-actions-list-action-configurations)
- [Action Types](../api/rest_api/rest_api_reference/rest_api_reference.html#ai-actions-list-action-types)
- [Action Configurations](https://doc.ibexa.co/en/4.6/api/rest_api/rest_api_reference/rest_api_reference.html#ai-actions-list-action-configurations)
- [Action Types](https://doc.ibexa.co/en/4.6/api/rest_api/rest_api_reference/rest_api_reference.html#ai-actions-list-action-types)
[[= release_note_entry_end() =]]


Expand Down Expand Up @@ -540,7 +540,7 @@ The PHP API has been enhanced with the following new class:

The PHP API has been enhanced with the following new classes:

- [`Ibexa\Contracts\Calendar\EventAction\EventActionCollection`](https://doc.ibexa.co/en/4.6/api/php_api/php_api_reference/classes/Ibexa-Contracts-Calendar-EventAction-EventActionCollection.html)
- [`Ibexa\Contracts\Calendar\EventAction\EventActionCollection`](https://doc.ibexa.co/en/4.6/api/php_api/php_api_reference/classes/Ibexa-Contracts-Calendar-EventAction-EventActionCollection.html)
- [`Ibexa\Contracts\Calendar\EventSource\InMemoryEventSource`](https://doc.ibexa.co/en/4.6/api/php_api/php_api_reference/classes/Ibexa-Contracts-Calendar-EventSource-InMemoryEventSource.html)
- [`Ibexa\Contracts\Core\Event\Mapper\ResolveMissingFieldEvent`](https://doc.ibexa.co/en/4.6/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Event-Mapper-ResolveMissingFieldEvent.html)
- [`Ibexa\Contracts\Core\FieldType\DefaultDataFieldStorage`](https://doc.ibexa.co/en/4.6/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-FieldType-DefaultDataFieldStorage.html)
Expand Down
Loading