Skip to content

07: Reduce the API section to REST #3386

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
mnocon merged 1 commit into from
Sep 7, 2026
Merged

07: Reduce the API section to REST #3386

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
6 changes: 3 additions & 3 deletions docs/administration/back_office/back_office_tabs/back_office_tabs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ You can extend existing tab groups with new tabs, or create your own tab groups.

A custom tab can extend one of the following classes:

- [`AbstractTab`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-AdminUi-Tab-AbstractTab.html) - base tab
- [`AbstractControllerBasedTab`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-AdminUi-Tab-AbstractControllerBasedTab.html) - embeds the results of a controller action in the tab
- [`AbstractRouteBasedTab`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-AdminUi-Tab-AbstractRouteBasedTab.html) - embeds the results of the selected route, passing applicable parameters
- `AbstractTab` - base tab
- `AbstractControllerBasedTab` - embeds the results of a controller action in the tab
- `AbstractRouteBasedTab` - embeds the results of the selected route, passing applicable parameters

``` php
//...
Expand Down
2 changes: 1 addition & 1 deletion docs/administration/back_office/back_office_tabs/create_dashboard_tab.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

This tab searches for content with content type "Article" (lines 50-53) and uses the built-in `all_content.html.twig` template to render the results, which ensures that the tab looks the same as the existing tabs (lines 64-66).

The tab also implements [`OrderedTabInterface`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-AdminUi-Tab-OrderedTabInterface.html) (line 17), which enables you to define the order in which the tab is displayed on the dashboard page.
The tab also implements `OrderedTabInterface` (line 17), which enables you to define the order in which the tab is displayed on the dashboard page.

Check notice on line 16 in docs/administration/back_office/back_office_tabs/create_dashboard_tab.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/administration/back_office/back_office_tabs/create_dashboard_tab.md#L16 <Ibexa.Passive> 

Try to avoid passive tense, when possible.
Raw output 
{"message":"Try to avoid passive tense, when possible.","location":{"path":"docs/administration/back_office/back_office_tabs/create_dashboard_tab.md","range":{"start":{"line":16,"column":113},"end":{"line":16,"column":125}}},"severity":"INFO","code":{"value":"Ibexa.Passive"}}
It's done with the `getOrder()` method (line 38).

Register this tab as a service:
Expand Down
2 changes: 1 addition & 1 deletion docs/administration/back_office/customize_product_tour.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ month_change: false

# Customize scenarios with PHP code

You can customize the product tour scenarios with the [`RenderProductTourScenarioEvent`](integrated_help_events.md) event.
You can customize the product tour scenarios with the `RenderProductTourScenarioEvent` event.
This event is dispatched before a product tour scenario is rendered.
You can use it to:

Expand Down
2 changes: 1 addition & 1 deletion docs/administration/back_office/notifications.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ You can send notifications to users which are displayed in the user menu.

### Create a custom user notification

To create a new notification you can use the [`NotificationService::createNotification(CreateStruct $createStruct)` method](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-NotificationService.html#method_createNotification)
To create a new notification you can use the `NotificationService::createNotification(CreateStruct $createStruct)` method
like in the example below:

``` php
Expand Down
2 changes: 1 addition & 1 deletion docs/administration/configuration/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ These files contain additional settings and point to the general (not environmen

!!! note

Configuration is tightly related to the [service container](php_api.md#service-container).
Configuration is tightly related to the [service container]([[= symfony_doc =]]/service_container.html).
To fully understand it, you must be familiar with the service container and [its configuration]([[= symfony_doc =]]/service_container.html#service-container-parameters).

Basic configuration handling in [[= product_name =]] is similar to what is commonly possible with Symfony.
Expand Down
6 changes: 3 additions & 3 deletions docs/administration/configuration/dynamic_configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## ConfigResolver

Dynamic configuration is handled by the [`ConfigResolverInterface`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-SiteAccess-ConfigResolverInterface.html).
Dynamic configuration is handled by the `ConfigResolverInterface`.

Check notice on line 9 in docs/administration/configuration/dynamic_configuration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/administration/configuration/dynamic_configuration.md#L9 <Ibexa.Passive> 

Try to avoid passive tense, when possible.
Raw output 
{"message":"Try to avoid passive tense, when possible.","location":{"path":"docs/administration/configuration/dynamic_configuration.md","range":{"start":{"line":9,"column":23},"end":{"line":9,"column":33}}},"severity":"INFO","code":{"value":"Ibexa.Passive"}}

It exposes the `hasParameter()` and `getParameter()` methods.
You can use them to check the different *scopes* available for a given *namespace* to find the appropriate parameter.
Expand Down Expand Up @@ -68,9 +68,9 @@
arguments: ['@ibexa.config.resolver']
```

You can also use the [autowire feature]([[= symfony_doc =]]/service_container/autowiring.html), by type hinting against [`ConfigResolverInterface`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-SiteAccess-ConfigResolverInterface.html).
You can also use the [autowire feature]([[= symfony_doc =]]/service_container/autowiring.html), by type hinting against `ConfigResolverInterface`.

Check failure on line 71 in docs/administration/configuration/dynamic_configuration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/administration/configuration/dynamic_configuration.md#L71 <Ibexa.Spellcheck> 

Did you really mean 'autowire'?
Raw output 
{"message":"Did you really mean 'autowire'?","location":{"path":"docs/administration/configuration/dynamic_configuration.md","range":{"start":{"line":71,"column":23},"end":{"line":71,"column":31}}},"severity":"ERROR","code":{"value":"Ibexa.Spellcheck"}}

For more information about dependency injection, see [Service container](php_api.md#service-container).
For more information about dependency injection, see [Service container]([[= symfony_doc =]]/service_container.html).

!!! note

Expand Down
35 changes: 0 additions & 35 deletions docs/administration/dashboard/php_api_dashboard_service.md
View file
Open in desktop

This file was deleted.

8 changes: 4 additions & 4 deletions docs/administration/recent_activity/recent_activity.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,16 +291,16 @@

You can disable logging the activities with PHP API, for example, when loading large amounts of data in cases where you don't want logging to slow down the process or the actions to be included in the log.

Call [`ActivityLogService::disable()`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ActivityLog-ActivityLogServiceInterface.html#method_disable)
before running the relevant code, then [`ActivityLogService::enable()`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ActivityLog-ActivityLogServiceInterface.html#method_enable) to restore the logging process:
Call `ActivityLogService::disable()`
before running the relevant code, then `ActivityLogService::enable()` to restore the logging process:

``` php
[[= include_code('code_samples/recent_activity/src/recent_activity_disable.php') =]]
```

When disabled, any call to [`ActivityLogService::save()`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ActivityLog-ActivityLogServiceInterface.html#method_save) has no effect and no entries are written to the database.
When disabled, any call to `ActivityLogService::save()` has no effect and no entries are written to the database.

Check notice on line 301 in docs/administration/recent_activity/recent_activity.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/administration/recent_activity/recent_activity.md#L301 <Ibexa.Passive> 

Try to avoid passive tense, when possible.
Raw output 
{"message":"Try to avoid passive tense, when possible.","location":{"path":"docs/administration/recent_activity/recent_activity.md","range":{"start":{"line":301,"column":86},"end":{"line":301,"column":97}}},"severity":"INFO","code":{"value":"Ibexa.Passive"}}

You can check the current state with [`ActivityLogService::isEnabled()`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ActivityLog-ActivityLogServiceInterface.html#method_isEnabled) and [`ActivityLogService::isDisabled()`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ActivityLog-ActivityLogServiceInterface.html#method_isDisabled).
You can check the current state with `ActivityLogService::isEnabled()` and `ActivityLogService::isDisabled()`.

## REST API

Expand Down
3 changes: 1 addition & 2 deletions docs/ai/ai.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ AI solutions are extensible. You can create [custom AI actions](extend_ai_action

AI integration goes even further:

- Some AI agents can learn how to use the [REST](rest_api_usage.md) or [GraphQL](graphql.md) APIs.
- Other, like those integrated into IDEs, can learn how to use the [PHP API](php_api.md) and assist you in code development.
- Some AI agents can learn how to use the [REST](rest_api_usage.md) API.

[[= cards([
"ai/ai_actions/ai_actions",
Expand Down
1 change: 0 additions & 1 deletion docs/ai/ai_actions/ai_actions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ You can also extend it to perform other tasks or support additional AI services.

[[= cards([
"ai/ai_actions/extend_ai_actions",
"api/event_reference/ai_action_events",
("https://doc.ibexa.co/en/6.0/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Connector-AI", "REST API Reference", "See the available endpoints for AI Actions"),
"search/ai_actions_search_reference/action_configuration_criteria",
"search/ai_actions_search_reference/action_configuration_sort_clauses",
Expand Down
Loading
Loading