Skip to main content
Version: Latest
FeatureAIv1.4.3open-dxp/headless-bundle

Changelog

1.4.3​

  • BUGFIXOpenDxpVideo and OpenDxpVideoThumbnail take the output of AssetThumbnailTransformer as responseMappingClass. videoParameter and formats are objects now

1.4.2​

  • SECURITYOPENDXP-SA-2026-021The search API no longer takes the OpenSearch index from the request
  • BUGFIXRequire symfony/property-info ^7.4 instead of exactly 7.4.0, so the bundle installs with the current Symfony 7.4
  • ENHANCEMENTheadless_search_setup checks that the index of every search type exists, also without Dynamic Search
  • CHORECheck dependencies, code and commits for security issues and attach an SBOM to each release

1.4.1​

  • ENHANCEMENTThe route document resolves a data object by its URL slug. A slug page has the routeType data_object instead of symfony, see Routing
  • BUGFIXThe admin preview shows an unpublished data object by its URL slug
  • BUGFIXDataObjectRouteEntityResolver only resolves an unpublished data object in the admin preview
  • CHORERequire open-dxp/i18n-bundle 1.2.1 or newer when it is installed

1.4.0​

  • ENHANCEMENTThe schema of a FormBuilder choice field holds the tooltip and the relation of each choice. See API Forms
  • ENHANCEMENTThe schema of a date field with the widget single_text holds its format
  • CHOREThe services and static hosts serve every site declaration of OpenDXP 1.5, not only robots.txt
  • CHOREOPT-INThe development tools for AI agents run on Symfony AI Mate instead of open-dxp/mcp-bundle. headless_how_to and the scaffold tools are gone. The skills mate-headless-api and mate-headless-response-entities and the makers take their place, see docs/60_DevelopmentTools.md
    1. Only if your coding agents used the MCP tools of this bundle: run composer require --dev open-dxp/mate-extension.
    2. Set up Mate as the installation of open-dxp/mate-extension describes.
  • NEW FEATUREHIGHLIGHTMIGRATIONAn API user with the role ROLE_ALLOWED_TO_IMPERSONATE acts as another user through the header X-OpenDxp-Api-Impersonate. A backend user with the permission opendxp_headless_api_user_impersonation opens the frontend as any API user, see docs/01_CertificationAuthentication.md

    Support teams see the frontend exactly as a customer sees it, either through the API or with one click in the admin.

  • NEW FEATUREHIGHLIGHTPUT/PATCH /account updates the first name, the last name and the locale of the user, see docs/01_CertificationAuthentication.md

    Users update their first name, last name and locale through PUT or PATCH /account.

  • ENHANCEMENTGET /account returns the locale of the user
  • ENHANCEMENTApiUserInterface has the method setLocale(). The installed User class already has it through its field locale
  • ENHANCEMENTThe field locale of the installed User class lists the system languages
  • NEW FEATURETest API for requests to the API. It checks every response against the API documentation and checks that the API keeps no session, see docs/61_Testing.md
  • ENHANCEMENTThe API documentation lists 401, 403, 404 and 415 for the routes that can answer them, see docs/41_ApiDocumentation.md
  • BUGFIXThe security of an API route applies to every action. An action without an #[ApiActionRequest] argument skipped it before.
  • BUGFIXThe validation_groups of a form request decide which constraints of the form data apply. The group Default applies only if the list contains it
  • ENHANCEMENTform_data_voter_status_code and form_data_voter_message set the status and the message of the response when the form data voter denies a request, see docs/25_ConfigurationApiForms.md. SecurityChecker::checkSubject() takes both as arguments
  • BUGFIXA request without the form of #[MapApiForm] returns 422 instead of 500
  • BUGFIXAn exception of a handler whose code is not a client error returns 500
  • BUGFIXA document request that does not accept JSON returns 406 instead of 200
  • BUGFIX#[SchemaRoute] registers the schema route of its form
  • BUGFIXA schema route without an OpenAPI tag no longer breaks the routing
  • BUGFIXThe url of a data object whose class has no link generator is null instead of an error
  • BUGFIXPaginationHelper paginates a query without a pagination filter instead of failing
  • BUGFIX/documents/{id}, /elements/{id}/properties, /assets/{id}/metadata and /assets/{id}/thumbnail return 404 for an element that does not exist instead of an empty response
  • BUGFIX/assets/{id}/thumbnail returns 404 for a video and for an asset without a thumbnail, and refuses options that are not JSON
  • BUGFIX/assets/{id}/metadata describes metadata that refers to an element with OpenDxpElement instead of failing. The route uses OpenDxpAssetMetadataScalar and OpenDxpAssetMetadataElement, which the API documentation lists by type
  • DEPRECATIONOpenDxpAssetMetadata. 2.0 removes the class, use OpenDxpAssetMetadataScalar or OpenDxpAssetMetadataElement
  • ENHANCEMENTThe response_class of a project adds its types to the response_class of a bundle route. A project adds an asset metadata type this way, see docs/42_ResponseEntities.md
  • ENHANCEMENTA type without an entry in response_class fails with a message that names the type
  • DEPRECATIONWebsiteSetting. 2.0 removes the class, use AbstractWebsiteSetting
  • DEPRECATIONOpenDxpElementProperty. 2.0 removes the class, use AbstractOpenDxpElementProperty
  • BUGFIXThe order filter returns 404 for an order other than asc or desc and for an order key that is not a field name. An unknown order key returns 400 instead of 500
  • BUGFIX/navigation marks a dynamic node of the top level as active instead of failing
  • BUGFIXThe API documentation allows null for customProperties and customHtmlAttributes of a navigation page
  • BUGFIXA bool website setting is a boolean in the response
  • BUGFIXPOST /account/avatar without a file returns 422 instead of 500
  • BUGFIXDELETE /account/avatar/{id} removes the avatar from the user and marks its command with RemoveStamp
  • BUGFIXThe tokens of the password reset and of the login identifier change are random
  • BUGFIXConfirming a login identifier that another user took in the meantime returns 422 instead of creating a second user with it
  • ENHANCEMENTAbstractApiUserFactory has the states requestingPasswordReset() and requestingLoginIdentifierChange()
  • ENHANCEMENTIf the user logs in with the email address, the mail to confirm a new login identifier is sent to the new address. Otherwise it is sent to the email address of the user
  • BUGFIXThe error responses of the API documentation type code as integer
  • DEPRECATIONApiUser::eraseCredentials(). The API keeps no session, so 2.0 removes the method
  • BUGFIXA missing or invalid X-OpenDxp-Api-Locale or X-OpenDxp-Api-Site header returns 400 instead of 500
  • BUGFIXThe API returns a document with the Accept headers */* and application/*. It also returns a document without an Accept header.
  • ENHANCEMENTOpenDxpVideo and OpenDxpVideoThumbnail describe the video that AssetThumbnailTransformer outputs
  • BUGFIXEmpty player parameters of a video and the formats of a video conversion in progress are objects in JSON, not arrays
  • ENHANCEMENTA headless document names its template _cmsTemplate while the toolbox outputs camelCase (opendxp_toolbox.headless.camel_case_property_names: true)
  • DEPRECATIONDocumentEditableAreasTransformer::TEMPLATE_PROPERTY_SNAKE_CASE (_cms_template). 2.0 names the template _cmsTemplate
  • NEW FEATUREHIGHLIGHTFrontend cache, see docs/28_ConfigurationFrontendCache.md

    The Headless API supports HTTP caching natively. Every response carries cache tags, and a change to an element clears only the cached responses that contain it.

  • DEPRECATIONapi_flush_cache_trigger is deprecated, use the frontend cache instead
  • NEW FEATUREDomain redirects of the SEO bundle also apply to route documents, whether a page exists under the route or not (requires open-dxp/opendxp ^1.5)
  • ENHANCEMENTA redirect that answers a route document is counted as a hit
  • ENHANCEMENTA redirect without a target, such as 410 Gone, returns its status code instead of 404
  • BUGFIXRedirects that match or forward the query string see the query of the route
  • ENHANCEMENTMIGRATIONThe bundle has an installer: bin/console opendxp:bundle:install OpenDxpHeadlessBundle creates the table of the refresh tokens from the Doctrine mapping. An existing installation is marked as installed by the migrations.
  • BUGFIXCorrect the API schema of links and thumbnails
  • CHOREReplace Codeception with Pest and open-dxp/test-foundation
  • CHORERequire open-dxp/opendxp ^1.5
  • BUGFIXEvery paginated listing sends its total count in X-Pagination-Total-Count
  • DEPRECATIONX-Api-Pagination-Total. 2.0 removes the header, use X-Pagination-Total-Count

1.3.8​

  • NEW FEATUREOpenSearch vector search: KnnQuery, NeuralQuery and HybridQuery as query builders
  • NEW FEATUREPostBuildSearchEvent carries the Search object and takes a top level query plus a search pipeline

1.3.7​

  • ENHANCEMENTOpenSearch: a hit carries the raw inner_hits of its document under inner_hits when the query requested them

1.3.6​

  • ENHANCEMENTBodyListener: added a per-route opt-out (_opendxp_headless_skip_body_validation route default parameter)
  • ENHANCEMENTMCP scaffold tools: report the files they wrote, not only the class names
  • ENHANCEMENTOpenDxp\Bundle\HeadlessBundle\Security\TrustedBackendLoginLinkHostResolver decorates admin-bundle's TrustedLoginLinkHostResolverInterface (requires open-dxp/admin-bundle ^1.4.2, which introduces that interface) and trusts a request host matching the host_patterns.backend. This lets admin login links (lost password, invitation, token login) point at the backend host instead of the frontend domain.

1.3.5​

  • NEW FEATUREOpenDXP MCP support: tools that answer from the running installation which endpoints it serves, what the merged headless configuration says, which mechanism fits a given task, and where a response entity has a hole a generated client would trip over (requires open-dxp/mcp-bundle)
  • NEW FEATUREMaker support: make:api-query, make:api-command, make:response-entity, make:api-source-resolver, make:api-transformer and make:api-filter (requires symfony/maker-bundle)
  • NEW FEATUREDocumentation for response entities: how a property gets its value, how one entity references another, when an OpenAPI attribute is needed
  • BUGFIXUserLoginIdentifierChangeEvent now extends the Symfony event instead of a doctrine entity
  • BUGFIXFixed an error in DocumentEditableAreasTransformer for non-page-snippet documents

1.3.4​

  • BUGFIXInclude scalar types bool and float in opensearch aggregation bucket value

1.3.3​

  • ENHANCEMENTAdd support for resolving locale-to-URL mapping in remote routes (requires opendxp/i18n-bundle >= 1.1.5)

1.3.2​

  • ENHANCEMENTHandle isCollection attribute for oneOf relations in property and response mapping

1.3.1​

  • ENHANCEMENTSchema Routes: Also support POST requests
  • BUGFIXFix wrong validation groups mapping in MapApiForm

1.3.0​

  • ENHANCEMENTImprove Asset Base Uri Fallback: Use site where general domain has been assigned
  • ENHANCEMENTPHP 8.5 support added
  • ENHANCEMENTChanged dependency smoench/opensearch-dsl to shyim/opensearch-php-dsl to provide better php support
  • ENHANCEMENTMake validation constraint messages configurable
  • ENHANCEMENTUse method attributes for Twig functions instead of getFunctions.
  • ENHANCEMENTEnhance Asset Base URI resolution: Add "General Domain" site fallback
  • BUGFIXAllow empty POST requests

1.2.2​

  • ENHANCEMENTImprove Setup/Auth Documentation by @solverat in #53
  • ENHANCEMENTUpdate gesdinet/jwt-refresh-token-bundle to v2.0 and adapt configuration
  • ENHANCEMENTUpdate supports method in FormTypeDescriber to check for ObjectType using TypeInfo
  • ENHANCEMENTUpdate UniqueLoginIdentifier constructor for improved parameter handling
  • BUGFIXRespect all hosts in ApiTriggerListener

1.2.1​

  • BUGFIXAdd static host fallback handling and site resolution logic

1.2.0​

  • NEW FEATURESite-based host configuration
  • NEW FEATUREAPI Flush is now available for each site
  • DEPRECATIONapi_flush_cache_trigger.enabled: Use Site Configuration instead
  • DEPRECATIONapi_flush_cache_trigger.uri: Use Site Configuration and configure api_flush_cache_trigger.path instead
  • NEW FEATUREAsset (Static Host): While assets.host is still a valid configuration (will be used as fallback), you're able to define asset base uri for each site
  • NEW FEATUREGeneral Domain definition: Define the open dxp general domain via Site Configuration
  • ENHANCEMENTMigrate nelmio property describer to type describer (symfony type info)
  • BUGFIXFix OpenAPI schema for listing extender
  • BUGFIXFix getSupportedTypes implementation for (de)normalizers
  • BUGFIXFix type for id parameter in getById calls

1.1.1​

  • BUGFIXAdd OpenDxp context check to BodyListener
  • BUGFIXAdd select type to element property response class mappings

1.1.0​

  • BUGFIXSet router context using RequestContext in RouteDocumentResolver
  • BC BREAKResponse entities changed
    1. Replace the response entity src/Domain/Common/ResponseEntity/Element with src/Domain/Common/ResponseEntity/OpenDxpElement.
    2. Replace the response entity src/Domain/Common/ResponseEntity/ElementProperty with src/Domain/Common/ResponseEntity/OpenDxpElementProperty.
    3. Read mimeType instead of mimetype of src/Domain/Asset/OpenDxpAsset.
    4. Read asset.id and mimeType instead of assetId and mime of src/Domain/Asset/OpenDxpAssetThumbnail.
    5. Read frontendPath instead of url of src/Domain/Asset/OpenDxpAsset, src/Domain/Document/OpenDxpDocument and src/Domain/DataObject/OpenDxpDataObject.
    6. Read data instead of element in the responses of elements/{id}/properties and /website-settings.
  • CHOREAdd Symfony PropertyInfo
  • ENHANCEMENTAdd OpenAPI attributes for schema and properties, update editable areas transformer
  • CHOREBump NelmioApiDocBundle to ~5.9.0
  • BC BREAKChange Nelmio\ApiDocBundle\Annotation\Model to Nelmio\ApiDocBundle\Attribute\Model
    1. Replace Nelmio\ApiDocBundle\Annotation\Model with Nelmio\ApiDocBundle\Attribute\Model in your code.

1.0.1​

  • BUGFIXUse is_a for ResponseEntityInterface checks in ResponseEntityPropertyDescriber #22

1.0.0​

  • NEW FEATUREInitial Release