DTO -> Entity State Processor

Yo @TristanoMilano!

Where does that error come from exactly - what's the stack trace? It might be from this line - https://github.com/api-platform/core/blob/main/src/Symfony/EventListener/WriteListener.php#L116 - but I can't specifically find the get_class() in the code that follows.

If my guess is correct, the thing to do is, from your processor, to return an object, not an array. It seems that returning an object from the processor is required. However, this can be a thin object (it doesn't need to be an ApiResource) that holds your array. Heck, you might even be able to return an ArrayObject - but I'm no sure.

Let me know if this helps - or if I'm way off. In that case, show me the stacktrace :).

Cheers!

Heck, you might even be able to return an ArrayObject - but I'm no sure.

It was as easy as that. Instead of returning the ArrayCollection in my Processor, I just returned am ArrayObject and it worked.

Thank you very much!

Booya! Thank you for replying back that this did the trick! Keep up the good work :)

I am still having one little issue with that approach, The response is fine, but how do I tell API-Platform to show the correct Schema? I want to show the same Schema, that is auto-generated with every GetCollection() endpoint, so like this:

[image]

But what I get is an object.

I can show you the example code of my ApiResource:

#[ApiResource(operations: [
    new Post(
        uriTemplate: 'personal_agenda_sessions',
        outputFormats: ['jsonld', 'json'],
        normalizationContext: ['groups' => ['session:read', 'session:item:read']],
        output: Session::class,
        processor: PersonalAgendaDataProcessor::class,
    )
], security: 'is_granted(\'ROLE_USER\')')]
class PersonalAgenda
{
    #[Groups(['session:read', 'session:write', 'personalagenda:write'])]
    public UuidInterface $eventId;

    /**
     * @var array
     */
    #[Groups(['session:read', 'session:write', 'personalagenda:write'])]
    public array $programIds;

}

Again, the response is just fine. In the processor, I query the Sesssion entity for the $eventId (UUID) and the array of programIds (an array of UUIDs) and return an ArrayObject of sessions.
Because it can be a long list of $programIds and that are all UUIDs I can not use Get() but am forced to use Post()'s body.

Is there any way of telling API-Platform to return the Schema of a SessionCollcetion instead of the Schema of a Session-object?

Hey @TristanoMilano!

Hmm. I think this is the job of the output option. Because you have output: Session::class, I would expect that the documentation would show that your post operation returns a Session... and it sounds like that IS what you're seeing.

What I'm not sure about is... exactly what you should replace this with... it's not like we can say output: array<Session::class>...

I'm not sure if you'll be able to get it to exactly match the "GET collection" documentation. You could try creating a new class - e.g. SessionCollection that has a sessions property... and then set the output to SessionCollection::class. That would probably fix the docs, but it would also change the output (you'd now have a session key with the actual data on it.

In short, I'm not really sure how to get this to document correctly :/

Thanks for the response. My colleague came up with a solution using the OpenApiFactory to get the Schema we want:

<?php

namespace App\UI\Http\Rest\PublicApi\OpenApi;

use ApiPlatform\OpenApi\Factory\OpenApiFactoryInterface;
use ApiPlatform\OpenApi\OpenApi;

class OpenApiFactory implements OpenApiFactoryInterface
{
    public function __construct(private readonly OpenApiFactoryInterface $decorated)
    {
    }

    public function __invoke(array $context = []): OpenApi
    {
        // Get the OpenAPI definition generated by the decorated factory.
        $openApi = $this->decorated->__invoke($context);

        // Retrieve the path definition for the '/api/sessions' endpoint.
        $pathSessionCollection = $openApi->getPaths()->getPath('/api/sessions');

        // Retrieve the GET operation for the '/api/sessions' endpoint.
        $operationSessionCollectionGet = $pathSessionCollection->getGet();

        // Define the URL for the personal agenda sessions.
        $personalAgendaSessionUrl = '/api/personal_agenda_sessions';

        // Retrieve the path definition for the personal agenda sessions.
        $pathPersonalAgendaSessionCollection = $openApi->getPaths()->getPath($personalAgendaSessionUrl);

        // Retrieve the POST operation for the personal agenda sessions.
        $operationPersonalAgendaSessionCollectionPost = $pathPersonalAgendaSessionCollection->getPost();

        // Update the OpenAPI paths to include the personal agenda sessions with responses.
        $openApi->getPaths()->addPath(

        // Define the URL for the personal agenda sessions.
            $personalAgendaSessionUrl,
            // Create a path definition for personal agenda sessions with a POST operation.
            $pathPersonalAgendaSessionCollection->withPost(
            // Attach responses from the GET operation for sessions.
                $operationPersonalAgendaSessionCollectionPost->withResponses(
                    $operationSessionCollectionGet->getResponses()
                )
            )
        );
        // Return the updated OpenAPI definition.
        return $openApi;
    }
}

Boom! I love the power that decorating that gives you as a last resort!

Thanks for sharing that :)