IBX-10936: Implemented fetching field definitions from an expression

[barw4]

🎫 Issue	IBX-10936

Related PRs:

ibexa/core#676
https://github.com/ibexa/taxonomy/pull/382

Description:

Why?

The need is to create a possibility to fetch content type fields based on provided content type group identifiers and content type identifiers, please see the related Figma: https://www.figma.com/design/WkIyhysX3ZGSRwwxnPcFXE/-AI-Features--AI?node-id=8808-117516&t=50I4ptpZFht2TAps-0

As we don't have APIs for fetching field definitions, and we already have a service that allows fetching it using field expression: e.g. {Content}/{folder}/{name} the decision was to expose the ContentTypeFieldsByExpressionService to REST. Possible need: frontend requests vectorizable_fields configuration and provides the expression to backend, backend responds with field definition info objects.

REST

Summary

• expose a REST controller that resolves content type field definitions from an expression by delegating to ContentTypeFieldsByExpressionServiceInterface

Method	Path	Consumes	Produces
POST	/api/ibexa/v2/content-type/load-field-definitions-from-expression	application/vnd.ibexa.api.FieldDefinitionExpression+json (or +xml)	application/vnd.ibexa.api.FieldDefinitionInfoList+json (or +xml)

Request Payload

{
  "FieldDefinitionExpression": {
    "expression": "{Content}/{folder}/{name}",
    "configuration": "vectorizable_fields" // Optional
  }
}

Example JSON Response

{
  "FieldDefinitions": {
    "_media-type": "application/vnd.ibexa.api.FieldDefinitionInfoList+json",
    "FieldDefinitionInfo": [
      {
        "_media-type": "application/vnd.ibexa.api.FieldDefinitionInfo+json",
        "id": "__FIXED_ID__",
        "identifier": "name",
        "position": 1,
        "names": {
          "value": [
            {
              "_languageCode": "eng-US",
              "#text": "Name"
            }
          ]
        }
      }
    ]
  }
}

In order to use configuration one needs to have the following configuration defined https://github.com/ibexa/taxonomy/pull/382

For QA:

Documentation:

Internal, NDR

[konradoboza]

Apart from other remarks.

[Steveb-p]

I assume this is the location where LogicException happens?

This should be handled / validated properly, since in this case configuration is coming from REST query. External data should not be capable of triggering LogicExceptions. You can use any exception (like InvalidArgumentException), but definitely not this one.

[sonarqubecloud]

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[Steveb-p]

This cannot be declared for the interface. It has to be a different type of exception, if needed.

Suggested change

* @throws \LogicException