Skip to content

Fix REST API Ref links #3163

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

Draft
adriendupuis wants to merge 4 commits into
base: 5.0
Choose a base branch
from
Draft

Fix REST API Ref links #3163

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e5344f1
Update AI Actions REST API Ref links
adriendupuis Apr 21, 2026
3ed6981
extend_ai_actions.md: Update llamafile link
adriendupuis Apr 21, 2026
2082adc
rest_*.md: Update link when possible, target 4.6 otherwise
adriendupuis Apr 21, 2026
1db7194
Discounts: Update link when possible, target 4.6 otherwise
adriendupuis Apr 21, 2026
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
2 changes: 1 addition & 1 deletion docs/ai_actions/ai_actions_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ Procedures are straightforward and intuitive, ensuring that users can quickly ac

AI Actions feature exposes a REST API interface that allows for programmatic execution of AI actions.
With the API, developers can automate tasks and execute actions on batches of content by integrating them into workflows.
For more information, see the [AI actions section in the REST API Reference](../api/rest_api/rest_api_reference/rest_api_reference.html#ai-actions-execute-ai-action).
For more information, see the [AI actions section in the REST API Reference](/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Connector-AI/operation/api_aiactions_actionConfigurationIdentifierexecute_post).

## Capabilities

Expand Down
4 changes: 2 additions & 2 deletions docs/ai_actions/extend_ai_actions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@

[[= product_name =]] comes with a built-in connector to OpenAI services, but you're not limited to it and can add support for additional AI services in your application.

The following example adds a new Action Handler connecting to a local AI run using [the llamafile project](https://github.com/Mozilla-Ocho/llamafile) which you can use to execute Text-To-Text Actions, such as the built-in "Refine Text" Action.
The following example adds a new Action Handler connecting to a local AI run using [the llamafile project](https://github.com/mozilla-ai/llamafile) which you can use to execute Text-To-Text Actions, such as the built-in "Refine Text" Action.

Check notice on line 105 in docs/ai_actions/extend_ai_actions.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ai_actions/extend_ai_actions.md#L105 

[Ibexa.ByUsing] Prefer 'by using' or 'with' to plain 'using'.
Raw output 
{"message": "[Ibexa.ByUsing] Prefer 'by using' or 'with' to plain 'using'.", "location": {"path": "docs/ai_actions/extend_ai_actions.md", "range": {"start": {"line": 105, "column": 74}}}, "severity": "INFO"}

When creating an Action Handler for [[= product_name_connect =]], add the new handler identifier to the [`Ibexa AI handler` custom property](configure_ai_actions.md#initiate-integration) in [[= product_name_connect =]] user interface.

Expand Down Expand Up @@ -244,7 +244,7 @@
### Integrate with the REST API

At this point the custom Action Type can already be executed by using the PHP API.
To integrate it with the [AI Actions execute endpoint](../api/rest_api/rest_api_reference/rest_api_reference.html#ai-actions-execute-ai-action) you need to create additional classes responsible for parsing the request and response data.
To integrate it with the [AI Actions execute endpoint](/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Connector-AI/operation/api_aiactions_actionConfigurationIdentifierexecute_post) you need to create additional classes responsible for parsing the request and response data.
See [adding custom media type](adding_custom_media_type.md) and [creating new REST resource](creating_new_rest_resource.md) to learn more about extending the REST API.

#### Handle input data
Expand Down
8 changes: 4 additions & 4 deletions docs/api/rest_api/rest_api_usage/rest_requests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,9 +132,9 @@

Examples of such requests are:

- [copying a Content](../rest_api_reference/rest_api_reference.html#managing-content-copy-content)
- [moving a Location and its subtree](../rest_api_reference/rest_api_reference.html#managing-content-move-subtree)
- [swapping a Location with another](../rest_api_reference/rest_api_reference.html#managing-content-swap-location)
- [copying a Content](https://doc.ibexa.co/en/4.6/api/rest_api/rest_api_reference/rest_api_reference.html#managing-content-copy-content)
- [moving a Location and its subtree](https://doc.ibexa.co/en/4.6/api/rest_api/rest_api_reference/rest_api_reference.html#managing-content-move-subtree)
- [swapping a Location with another](https://doc.ibexa.co/en/4.6/api/rest_api/rest_api_reference/rest_api_reference.html#managing-content-swap-location)

### Expected user

Expand Down Expand Up @@ -164,7 +164,7 @@
- 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`](/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).
- and, publishes (`PUBLISH`) the draft through [`/content/objects/{contentId}/versions/{versionNo}`](https://doc.ibexa.co/en/4.6/api/rest_api/rest_api_reference/rest_api_reference.html#managing-content-publish-a-content-version).

Check notice on line 167 in docs/api/rest_api/rest_api_usage/rest_requests.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/rest_api/rest_api_usage/rest_requests.md#L167 

[Ibexa.Lists] Verify list formatting: Full sentences should start with uppercase and end with a period. Sentence fragments should start with lowercase and have no period.
Raw output 
{"message": "[Ibexa.Lists] Verify list formatting: Full sentences should start with uppercase and end with a period. Sentence fragments should start with lowercase and have no period.", "location": {"path": "docs/api/rest_api/rest_api_usage/rest_requests.md", "range": {"start": {"line": 167, "column": 1}}}, "severity": "INFO"}
Copy link
Copy Markdown
Contributor Author

@adriendupuis adriendupuis Apr 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typical custom method that wasn't documented at API Platform introduction time because not existing in OpenAPI 3.1.
But OpenAPI 3.2 supports it: https://learn.openapis.org/specification/http-methods.html#additional-operations-for-custom-methods
This is something to investigate on API Platform side.


=== "XML"

Expand Down
2 changes: 1 addition & 1 deletion docs/api/rest_api/rest_api_usage/rest_responses.md
View file
Open in desktop
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](/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Objects/operation/api_contentobjects_contentIdcurrentversion_get)
Copy link
Copy Markdown
Contributor Author

@adriendupuis adriendupuis Apr 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should also be fixed on 4.6, the text is "creating content" but it target "create content type"

For example, [creating content](/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Objects/operation/api_contentobjects_post) 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/discounts/configure_discounts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@

## Rate limiting

To prevent malicious actors from trying all the possible discount code combinations using brute-force attacks, the [`/discounts_codes/{cartIdentifier}/apply` endpoint](/api/rest_api/rest_api_reference/rest_api_reference.html#discount-codes-apply-discount-to-cart) is rate limited using the [Rate Limiter Symfony component]([[= symfony_doc =]]/rate_limiter.html).
To prevent malicious actors from trying all the possible discount code combinations using brute-force attacks, the [`/discounts_codes/{cartIdentifier}/apply` endpoint](https://doc.ibexa.co/en/4.6/api/rest_api/rest_api_reference/rest_api_reference.html#discount-codes-apply-discount-to-cart) is rate limited using the [Rate Limiter Symfony component]([[= symfony_doc =]]/rate_limiter.html).

Check notice on line 64 in docs/discounts/configure_discounts.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/discounts/configure_discounts.md#L64 

[Ibexa.ByUsing] Prefer 'by using' or 'with' to plain 'using'.
Raw output 
{"message": "[Ibexa.ByUsing] Prefer 'by using' or 'with' to plain 'using'.", "location": {"path": "docs/discounts/configure_discounts.md", "range": {"start": {"line": 64, "column": 72}}}, "severity": "INFO"}
Copy link
Copy Markdown
Contributor Author

@adriendupuis adriendupuis Apr 22, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was documented only in RAML. See ibexa/discounts-codes#47 for an OpenAPI documentation.


You can adjust the default configuration by modifying the `config/packages/ibexa_discounts_codes.yaml` file created during installation process.

Expand Down
2 changes: 1 addition & 1 deletion docs/discounts/discounts_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

For example, you can automatically create a discount when a customer places their 3rd order, encouraging them to make another purchase and increase their chances of becoming a loyal customer.

You can manage discounts using [data migrations](importing_data.md#discounts), [REST API](/api/rest_api/rest_api_reference/rest_api_reference.html#discounts), or the PHP API by using the [`Ibexa\Contracts\Discounts\DiscountServiceInterface`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Discounts-DiscountServiceInterface.html) service.
You can manage discounts using [data migrations](importing_data.md#discounts), [REST API](/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Discounts), or the PHP API by using the [`Ibexa\Contracts\Discounts\DiscountServiceInterface`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Discounts-DiscountServiceInterface.html) service.

Check notice on line 16 in docs/discounts/discounts_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/discounts/discounts_api.md#L16 

[Ibexa.ByUsing] Prefer 'by using' or 'with' to plain 'using'.
Raw output 
{"message": "[Ibexa.ByUsing] Prefer 'by using' or 'with' to plain 'using'.", "location": {"path": "docs/discounts/discounts_api.md", "range": {"start": {"line": 16, "column": 16}}}, "severity": "INFO"}

The core concepts when working with discounts through the APIs are listed below.

Expand Down
Loading