Changelog
1.4.3
- BUGFIX
OpenDxpVideoandOpenDxpVideoThumbnailtake the output ofAssetThumbnailTransformerasresponseMappingClass.videoParameterandformatsare 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 - ENHANCEMENT
headless_search_setupchecks 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
routeTypedata_objectinstead ofsymfony, see Routing - BUGFIXThe admin preview shows an unpublished data object by its URL slug
- BUGFIX
DataObjectRouteEntityResolveronly resolves an unpublished data object in the admin preview - CHORERequire
open-dxp/i18n-bundle1.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_textholds 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_toand the scaffold tools are gone. The skillsmate-headless-apiandmate-headless-response-entitiesand the makers take their place, seedocs/60_DevelopmentTools.md- Only if your coding agents used the MCP tools of this bundle: run
composer require --dev open-dxp/mate-extension. - Set up Mate as the installation of
open-dxp/mate-extensiondescribes.
- Only if your coding agents used the MCP tools of this bundle: run
- NEW FEATUREHIGHLIGHTMIGRATIONAn API user with the role
ROLE_ALLOWED_TO_IMPERSONATEacts as another user through the headerX-OpenDxp-Api-Impersonate. A backend user with the permissionopendxp_headless_api_user_impersonationopens the frontend as any API user, seedocs/01_CertificationAuthentication.mdSupport teams see the frontend exactly as a customer sees it, either through the API or with one click in the admin.
- NEW FEATUREHIGHLIGHT
PUT/PATCH /accountupdates the first name, the last name and the locale of the user, seedocs/01_CertificationAuthentication.mdUsers update their first name, last name and locale through
PUTorPATCH /account. - ENHANCEMENT
GET /accountreturns the locale of the user - ENHANCEMENT
ApiUserInterfacehas the methodsetLocale(). The installedUserclass already has it through its fieldlocale - ENHANCEMENTThe field
localeof the installedUserclass 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
securityof an API route applies to every action. An action without an#[ApiActionRequest]argument skipped it before. - BUGFIXThe
validation_groupsof a form request decide which constraints of the form data apply. The groupDefaultapplies only if the list contains it - ENHANCEMENT
form_data_voter_status_codeandform_data_voter_messageset the status and the message of the response when the form data voter denies a request, seedocs/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
urlof a data object whose class has no link generator isnullinstead of an error - BUGFIX
PaginationHelperpaginates a query without a pagination filter instead of failing - BUGFIX
/documents/{id},/elements/{id}/properties,/assets/{id}/metadataand/assets/{id}/thumbnailreturn 404 for an element that does not exist instead of an empty response - BUGFIX
/assets/{id}/thumbnailreturns 404 for a video and for an asset without a thumbnail, and refusesoptionsthat are not JSON - BUGFIX
/assets/{id}/metadatadescribes metadata that refers to an element withOpenDxpElementinstead of failing. The route usesOpenDxpAssetMetadataScalarandOpenDxpAssetMetadataElement, which the API documentation lists bytype - DEPRECATION
OpenDxpAssetMetadata. 2.0 removes the class, useOpenDxpAssetMetadataScalarorOpenDxpAssetMetadataElement - ENHANCEMENTThe
response_classof a project adds its types to theresponse_classof a bundle route. A project adds an asset metadata type this way, seedocs/42_ResponseEntities.md - ENHANCEMENTA type without an entry in
response_classfails with a message that names the type - DEPRECATION
WebsiteSetting. 2.0 removes the class, useAbstractWebsiteSetting - DEPRECATION
OpenDxpElementProperty. 2.0 removes the class, useAbstractOpenDxpElementProperty - BUGFIXThe order filter returns 404 for an order other than
ascordescand for an order key that is not a field name. An unknown order key returns 400 instead of 500 - BUGFIX
/navigationmarks a dynamic node of the top level as active instead of failing - BUGFIXThe API documentation allows
nullforcustomPropertiesandcustomHtmlAttributesof a navigation page - BUGFIXA bool website setting is a boolean in the response
- BUGFIX
POST /account/avatarwithout a file returns 422 instead of 500 - BUGFIX
DELETE /account/avatar/{id}removes the avatar from the user and marks its command withRemoveStamp - 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
- ENHANCEMENT
AbstractApiUserFactoryhas the statesrequestingPasswordReset()andrequestingLoginIdentifierChange() - 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
codeasinteger - DEPRECATION
ApiUser::eraseCredentials(). The API keeps no session, so 2.0 removes the method - BUGFIXA missing or invalid
X-OpenDxp-Api-LocaleorX-OpenDxp-Api-Siteheader returns 400 instead of 500 - BUGFIXThe API returns a document with the
Acceptheaders*/*andapplication/*. It also returns a document without anAcceptheader. - ENHANCEMENT
OpenDxpVideoandOpenDxpVideoThumbnaildescribe the video thatAssetThumbnailTransformeroutputs - 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
_cmsTemplatewhile the toolbox outputs camelCase (opendxp_toolbox.headless.camel_case_property_names: true) - DEPRECATION
DocumentEditableAreasTransformer::TEMPLATE_PROPERTY_SNAKE_CASE(_cms_template). 2.0 names the template_cmsTemplate - NEW FEATUREHIGHLIGHTFrontend cache, see
docs/28_ConfigurationFrontendCache.mdThe 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.
- DEPRECATION
api_flush_cache_triggeris 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 OpenDxpHeadlessBundlecreates 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 - DEPRECATION
X-Api-Pagination-Total. 2.0 removes the header, useX-Pagination-Total-Count
1.3.8
- NEW FEATUREOpenSearch vector search:
KnnQuery,NeuralQueryandHybridQueryas query builders - NEW FEATURE
PostBuildSearchEventcarries theSearchobject and takes a top level query plus a search pipeline
1.3.7
- ENHANCEMENTOpenSearch: a hit carries the raw
inner_hitsof its document underinner_hitswhen the query requested them
1.3.6
- ENHANCEMENTBodyListener: added a per-route opt-out (
_opendxp_headless_skip_body_validationroute default parameter) - ENHANCEMENTMCP scaffold tools: report the files they wrote, not only the class names
- ENHANCEMENT
OpenDxp\Bundle\HeadlessBundle\Security\TrustedBackendLoginLinkHostResolverdecorates admin-bundle'sTrustedLoginLinkHostResolverInterface(requiresopen-dxp/admin-bundle^1.4.2, which introduces that interface) and trusts a request host matching thehost_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-transformerandmake:api-filter(requiressymfony/maker-bundle) - NEW FEATUREDocumentation for response entities: how a property gets its value, how one entity references another, when an OpenAPI attribute is needed
- BUGFIX
UserLoginIdentifierChangeEventnow extends the Symfony event instead of a doctrine entity - BUGFIXFixed an error in
DocumentEditableAreasTransformerfor 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
isCollectionattribute for oneOf relations in property and response mapping
1.3.1
- ENHANCEMENTSchema Routes: Also support
POSTrequests - BUGFIXFix wrong validation groups mapping in
MapApiForm
1.3.0
- ENHANCEMENTImprove Asset Base Uri Fallback: Use site where
general domainhas been assigned - ENHANCEMENTPHP 8.5 support added
- ENHANCEMENTChanged dependency
smoench/opensearch-dsltoshyim/opensearch-php-dslto 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
- DEPRECATION
api_flush_cache_trigger.enabled: Use Site Configuration instead - DEPRECATION
api_flush_cache_trigger.uri: Use Site Configuration and configureapi_flush_cache_trigger.pathinstead - NEW FEATUREAsset (Static Host): While
assets.hostis 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
getSupportedTypesimplementation for (de)normalizers - BUGFIXFix type for id parameter in
getByIdcalls
1.1.1
- BUGFIXAdd OpenDxp context check to BodyListener
- BUGFIXAdd
selecttype to element property response class mappings
1.1.0
- BUGFIXSet router context using
RequestContextin RouteDocumentResolver - BC BREAKResponse entities changed
- Replace the response entity
src/Domain/Common/ResponseEntity/Elementwithsrc/Domain/Common/ResponseEntity/OpenDxpElement. - Replace the response entity
src/Domain/Common/ResponseEntity/ElementPropertywithsrc/Domain/Common/ResponseEntity/OpenDxpElementProperty. - Read
mimeTypeinstead ofmimetypeofsrc/Domain/Asset/OpenDxpAsset. - Read
asset.idandmimeTypeinstead ofassetIdandmimeofsrc/Domain/Asset/OpenDxpAssetThumbnail. - Read
frontendPathinstead ofurlofsrc/Domain/Asset/OpenDxpAsset,src/Domain/Document/OpenDxpDocumentandsrc/Domain/DataObject/OpenDxpDataObject. - Read
datainstead ofelementin the responses ofelements/{id}/propertiesand/website-settings.
- Replace the response entity
- 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\ModeltoNelmio\ApiDocBundle\Attribute\Model- Replace
Nelmio\ApiDocBundle\Annotation\ModelwithNelmio\ApiDocBundle\Attribute\Modelin your code.
- Replace
1.0.1
- BUGFIXUse
is_afor ResponseEntityInterface checks in ResponseEntityPropertyDescriber #22
1.0.0
- NEW FEATUREInitial Release