feat(state): add headers to comply with LDP specification by LaurentHuzard · Pull Request #6917 · api-platform/core

LaurentHuzard · 2025-01-14T14:50:53Z

Q	A
Branch?	main
Tickets	-
License	MIT
Doc PR	api-platform/docs/pull/2211

To ensure compliance with the LDP specification (https://www.w3.org/TR/ldp/):

Added the "Accept-Post" header containing the list of supported Post formats.
Added the "Allow" header with values based on the allowed operations on the queried resources.

dunglas · 2025-01-14T18:24:20Z

+    When I add "Content-Type" header equal to "application/ld+json"
+    And I send a "GET" request to "/dummy_get_post_delete_operations"
+    Then the header "Accept-Post" should be equal to "text/turtle, application/ld+json"
+    And the header "Allow" should be equal to "OPTIONS, HEAD, GET, POST, DELETE"


Shouldn't the value be different for item and collection URLs?

Also, Allow-Post should only be defined for URLs where POST is enabled (usually collections, but not always).

You’re right, I overlooked that. I’ll make the changes and push them soon.

dunglas · 2025-01-14T18:28:04Z

            $headers['Accept-Patch'] = $acceptPatch;
        }

+        $headers['Accept-Post'] = 'text/turtle, application/ld+json';


This value cannot be hardcoded. For instance Turtle is not supported natively by API Platform and JSON-LD may or may not depending on the config.

You should inject the enabled formats here. You can retrieve this from metadata. Listing all allowed media types (not only Turtle and JSON-LD) is probably OK (and a best practice).

It sounds much better to list all the allowed media types. I'll take care of it.

dunglas · 2025-01-14T18:29:51Z

+
+    private function getAllowedMethods(?string $resourceClass): string
+    {
+        $allowedMethods = self::DEFAULT_ALLOWED_METHOD;


You should filter here the operations with a different URI Template than the one of the current operation to fix the issue described in my 1st comment.

Ah, good point—I’ll sort this out.

LaurentHuzard · 2025-01-15T18:02:02Z

            $headers['Accept-Patch'] = $acceptPatch;
        }

+        if (!$exception) {


To avoid returning incorrect values—such as in the case of a 401 error when requesting a resource—I added this condition, although I’m not entirely sure it’s the best approach. The issue arises because, in the case of a 401 error, the allowed methods and the currentUriTemplate correspond to the error itself rather than the requested resource.

The approach looks good to me.

dunglas · 2025-01-15T21:11:46Z

+            }
+        }
+
+        return array_unique($allowedMethods);


I don't think it's necessary because it's not possible to register two different routes for the same URL and the same method.

It would remove this as we are on the hot path.

To be honest, I would inline this code and remove this method. This will also allow you to set a variable (instead of running an O(n) operation) to check if POST is defined or not for Accept-Post, and this would remove a function call.

(Yes, these are mostly a micro optimization, but this also simplify the code IMHO).

dunglas · 2025-01-15T21:15:18Z

+    private function getAllowedMethods(?string $resourceClass, ?string $currentUriTemplate): array
+    {
+        $allowedMethods = self::DEFAULT_ALLOWED_METHOD;
+        if (null !== $currentUriTemplate && null !== $resourceClass && $this->resourceClassResolver->isResourceClass($resourceClass)) {


Suggested change

if (null !== $currentUriTemplate && null !== $resourceClass && $this->resourceClassResolver->isResourceClass($resourceClass)) {

if (null !== $currentUriTemplate && null !== $resourceClass && $this->resourceClassResolver?->isResourceClass($resourceClass)) {

dunglas · 2025-01-15T21:16:39Z

+    {
+        $allowedMethods = self::DEFAULT_ALLOWED_METHOD;
+        if (null !== $currentUriTemplate && null !== $resourceClass && $this->resourceClassResolver->isResourceClass($resourceClass)) {
+            $resourceMetadataCollection = $this->resourceCollectionMetadataFactory ? $this->resourceCollectionMetadataFactory->create($resourceClass) : new ResourceMetadataCollection($resourceClass);


Suggested change

$resourceMetadataCollection = $this->resourceCollectionMetadataFactory ? $this->resourceCollectionMetadataFactory->create($resourceClass) : new ResourceMetadataCollection($resourceClass);

$resourceMetadataCollection = $this->resourceCollectionMetadataFactory ? $this->resourceCollectionMetadataFactory->create($resourceClass) : new ResourceMetadataCollection($resourceClass);

Better not set the extra headers at all if the factory is missing.

It's an optional feature after all.

dunglas · 2025-01-16T08:03:26Z

+            }
+            $headers['Allow'] = implode(', ', $allowedMethods);
+
+            if ($isPostAllowed && \is_array($outputFormats = ($outputFormats = $operation->getOutputFormats())) && [] !== $outputFormats) {


Suggested change

if ($isPostAllowed && \is_array($outputFormats = ($outputFormats = $operation->getOutputFormats())) && [] !== $outputFormats) {

if ($isPostAllowed && \is_array($outputFormats = $operation->getOutputFormats()) && [] !== $outputFormats) {

soyuka · 2025-01-16T08:20:51Z

        private ?IriConverterInterface $iriConverter = null,
        private readonly ?ResourceClassResolverInterface $resourceClassResolver = null,
        private readonly ?OperationMetadataFactoryInterface $operationMetadataFactory = null,
+        private readonly ?ResourceMetadataCollectionFactoryInterface $resourceCollectionMetadataFactory = null,


We could probably create an LinkedDataPlatformProcessor?

Thanks for the suggestion! A LinkedDataPlatformProcessor sounds like a good idea, I'll consider implementing it.

soyuka · 2025-01-16T08:21:57Z

            $headers['Accept-Patch'] = $acceptPatch;
        }

+        if (!$exception) {


if ($operation instanceof ApiPlatform\Metadata\Error)

soyuka · 2025-01-16T08:24:14Z

+                    foreach ($resource->getOperations() as $resourceOperation) {
+                        if ($resourceOperation->getUriTemplate() === $currentUriTemplate) {
+                            $allowedMethods[] = $operationMethod = $resourceOperation->getMethod();
+                            $isPostAllowed = $isPostAllowed || ('POST' === $operationMethod);


you could collect outputFormats here directly? The operation below may not be the one where the formats are defined.

Good catch. Thanks.

soyuka · 2025-01-16T08:24:38Z

+            }
+            $headers['Allow'] = implode(', ', $allowedMethods);
+
+            if ($isPostAllowed && \is_array($outputFormats = ($outputFormats = $operation->getOutputFormats())) && [] !== $outputFormats) {


Suggested change

if ($isPostAllowed && \is_array($outputFormats = ($outputFormats = $operation->getOutputFormats())) && [] !== $outputFormats) {

if ($isPostAllowed && ($outputFormats = $operation->getOutputFormats())) {

soyuka · 2025-01-16T08:26:25Z

+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+
+class RespondProcessorTest extends TestCase


I think a RespondProcessorTest already exists it must be in tests forgot to move it

OK, i will merge them.

The existing RespondProcessorTest use the old way of doing test with prophecy instead of PHPunit mock system, should i refactor it ?

as you wish ^^

soyuka · 2025-01-16T08:26:40Z

            <argument type="service" id="api_platform.iri_converter" />
            <argument type="service" id="api_platform.resource_class_resolver" />
            <argument type="service" id="api_platform.metadata.operation.metadata_factory" />
+            <argument type="service" id="api_platform.metadata.resource.metadata_collection_factory" />


on-invalid=ignore

soyuka

nice a few small changes, also you should consider rebasing to be sure that the base ci is green

stale · 2025-08-17T02:12:09Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

Copilot

Pull request overview

This PR adds HTTP headers to comply with the Linked Data Platform (LDP) specification. The implementation introduces the LinkedDataPlatformProcessor which adds Accept-Post and Allow headers to API responses based on the available operations for each resource.

Changes:

Added LinkedDataPlatformProcessor to set Accept-Post header (listing supported POST formats) and Allow header (listing permitted HTTP methods) based on resource operations
Integrated the processor into both Symfony and Laravel service configurations
Created comprehensive test coverage for the new functionality

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
src/State/Processor/LinkedDataPlatformProcessor.php	Core processor implementation that inspects resource operations and sets LDP-compliant headers
src/Symfony/Bundle/Resources/config/symfony/events.php	Symfony service configuration for the LinkedDataPlatformProcessor
src/Symfony/Bundle/Resources/config/state/processor.php	Additional Symfony processor service definition with different decoration priority
src/Laravel/ApiPlatformProvider.php	Laravel service provider integration for LinkedDataPlatformProcessor
tests/Functional/LinkDataPlatformTest.php	Functional tests verifying headers in real HTTP responses
src/State/Tests/Processor/LinkedDataPlatformProcessorTest.php	Unit tests for the processor logic
tests/Fixtures/TestBundle/ApiResource/DummyGetPostDeleteOperation.php	Test fixture resource with specific operations for testing
src/State/Tests/Fixtures/ApiResource/Dummy.php	Minimal test fixture for unit testing

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

dunglas

LGTM.

I just wonder if adding new class is it worth it. Maybe this can be added to an existing base processor?

To ensure compliance with the LDP specification (https://www.w3.org/TR/ldp/): Added the "Accept-Post" header containing the list of supported Post formats. Added the "Allow" header with values based on the allowed operations on the queried resources.

soyuka · 2026-01-17T20:16:23Z

thanks!

LaurentHuzard marked this pull request as draft January 14, 2025 15:41

dunglas requested changes Jan 14, 2025

View reviewed changes

LaurentHuzard commented Jan 15, 2025

View reviewed changes

dunglas requested changes Jan 15, 2025

View reviewed changes

dunglas reviewed Jan 16, 2025

View reviewed changes

soyuka requested changes Jan 16, 2025

View reviewed changes

LaurentHuzard force-pushed the feat/header-for-ldp-spec branch from 6619485 to d072fd5 Compare March 17, 2025 04:39

LaurentHuzard force-pushed the feat/header-for-ldp-spec branch from d072fd5 to b6403aa Compare June 5, 2025 19:03

soyuka requested changes Jun 13, 2025

View reviewed changes

stale Bot added the stale label Aug 17, 2025

stale Bot closed this Aug 24, 2025

soyuka reopened this Aug 24, 2025

soyuka added enhancement and removed stale labels Aug 24, 2025

LaurentHuzard force-pushed the feat/header-for-ldp-spec branch 2 times, most recently from f5fd9bf to 64a0bfe Compare September 22, 2025 08:10

LaurentHuzard force-pushed the feat/header-for-ldp-spec branch 2 times, most recently from ef08582 to 55fb914 Compare January 13, 2026 20:43

LaurentHuzard marked this pull request as ready for review January 15, 2026 06:25

soyuka requested a review from Copilot January 16, 2026 15:59

Copilot AI reviewed Jan 16, 2026

View reviewed changes

Comment thread src/Symfony/Bundle/Resources/config/symfony/events.php Outdated

Comment thread tests/Functional/LinkDataPlatformTest.php Outdated

Comment thread src/State/Tests/Processor/LinkedDataPlatformProcessorTest.php Outdated

soyuka approved these changes Jan 16, 2026

View reviewed changes

soyuka requested a review from dunglas January 16, 2026 21:12

dunglas approved these changes Jan 17, 2026

View reviewed changes

soyuka force-pushed the feat/header-for-ldp-spec branch 3 times, most recently from 07bd710 to abdce50 Compare January 17, 2026 13:23

LaurentHuzard and others added 2 commits January 17, 2026 20:35

fix AddLinkHeaderProcessor initialization for Laravel

f4a12c5

Review

5eca1f9

soyuka force-pushed the feat/header-for-ldp-spec branch from abdce50 to 5eca1f9 Compare January 17, 2026 19:35

soyuka merged commit 350390b into api-platform:main Jan 17, 2026
149 checks passed

	if (null !== $currentUriTemplate && null !== $resourceClass && $this->resourceClassResolver->isResourceClass($resourceClass)) {
	if (null !== $currentUriTemplate && null !== $resourceClass && $this->resourceClassResolver?->isResourceClass($resourceClass)) {

	$resourceMetadataCollection = $this->resourceCollectionMetadataFactory ? $this->resourceCollectionMetadataFactory->create($resourceClass) : new ResourceMetadataCollection($resourceClass);
	$resourceMetadataCollection = $this->resourceCollectionMetadataFactory ? $this->resourceCollectionMetadataFactory->create($resourceClass) : new ResourceMetadataCollection($resourceClass);

	if ($isPostAllowed && \is_array($outputFormats = ($outputFormats = $operation->getOutputFormats())) && [] !== $outputFormats) {
	if ($isPostAllowed && \is_array($outputFormats = $operation->getOutputFormats()) && [] !== $outputFormats) {

	if ($isPostAllowed && \is_array($outputFormats = ($outputFormats = $operation->getOutputFormats())) && [] !== $outputFormats) {
	if ($isPostAllowed && ($outputFormats = $operation->getOutputFormats())) {

Uh oh!

Conversation

LaurentHuzard commented Jan 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dunglas Jan 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

soyuka left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stale Bot commented Aug 17, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dunglas left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

soyuka commented Jan 17, 2026

Uh oh!

Reviewers

LaurentHuzard commented Jan 14, 2025 •

edited

Loading

dunglas Jan 14, 2025 •

edited

Loading