Item Operations "Not Found" error

[abengtson]

I am having issues with my item operations for my endpoints. I am assuming it's not picking up the {id} in the path.

resources.yaml

App\Entity\Agent:
    collectionOperations:
        post:
            method: 'POST'
            path: '/agent'
            validation_groups: ['Default','postValidation']
            controller: 'App\Controller\CreateAgent'
    itemOperations:
        put:
            method: 'PUT'
            path: '/agent/{id}/update'
            validation_groups: ['Default']
            controller: 'App\Controller\UpdateAgent'
        get:
            method: 'GET'
            path: '/agent/{id}/client-information'
            controller: 'App\Controller\GetClientInformation'
            normalization_context:
                groups: ['clientInformationResults']

controller for one of the endpoints:

namespace App\Controller;


use App\Entity\Agent;

class GetClientInformation
{
    /**
     * @param Agent $data
     * @return Agent
     */
    public function __invoke(Agent $data): Agent
    {
        return $data;
    }
}

Error

@context": "/contexts/Error",
    "@type": "hydra:Error",
    "hydra:title": "An error occurred",
    "hydra:description": "Not Found",
    "trace": [
        {
            "namespace": "",
            "short_class": "",
            "class": "",
            "type": "",
            "function": "",
            "file": "/app/vendor/api-platform/core/src/EventListener/ReadListener.php",
            "line": 107,
            "args": []
        },
        ...........

I am assuming I am missing something in my configs but I can't find any examples of this.

[teohhanhui]

There's not enough information provided, so I can't tell what's going on.

It'd be great if you could give us an example project? 😄

[abengtson]

@teohhanhui Thanks for responding. There isn't much more to it, then the entity itself.

namespace App\Entity;

use ApiPlatform\Core\Annotation\ApiProperty;
use App\Entity\Constants\Status;
use App\Validator\Constraints as AgentAssert;
use Symfony\Component\Serializer\Annotation\Groups;
use Symfony\Component\Validator\Constraints as Assert;

/**
 * This is the ArcSync Agent Endpoint
 */
class Agent
{
    /**
     * @var string The Agent NAA Number/ID
     * @ApiProperty(identifier=true)
     *
     * @Assert\NotBlank(groups={"postValidation"})
     * @AgentAssert\IsAgentId
     */
    public $agent_id;

    /**
     * @var ClientPolicy[]
     *
     * @Groups("clientInformationResults")
     */
    public $clientInformation;
}

Should this work automatically giving the controller the Agent object just like it does for the post? I am not entirely sure what "Not Found" actually means as well

[abengtson]

I had this working when I was using a custom data provider and persister but I figured this should work by default.

[teohhanhui]

Uhh... $agent_id might be the problem here. I'm not sure if the identifier handling is top-notch. @soyuka? (Also, using snake_case property names might be causing a problem with the Symfony PropertyInfo and/or PropertyAccess components.)

Perhaps you could check the API Platform tab in the Symfony profiler to see what's going on with the metadata. 😄

[abengtson]

I tried with camel-case just to see but not luck. Unfortunately snake case was used when the project was created I believe for more obvious mapping to the for the 3rd parties posting to the api.

[teohhanhui]

@abengtson Did you take a look in the Symfony profiler? 😄

[abengtson]

@teohhanhui sorry, I am still newer to symfony forgot about the profiler. Here are some screen shots, I think it all looks good until it check the $data being null. I am not sure when or where the data gets lost or doesn't get created.

[teohhanhui]

Please check the API Platform tab. ;)

[abengtson]

[abengtson]

@teohhanhui The one thing I noticed when tracing through the code, the identifier get passed through the whole way down but it fails to get the ManagerRegistry for my Agent Entity when it calls the supports method. Is there something more I need to set up on my Agent Entity that I am missing?

namespace ApiPlatform\Core\Bridge\Doctrine\Orm;

use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryItemExtensionInterface;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryResultItemExtensionInterface;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\IdentifierManagerTrait;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGenerator;
use ApiPlatform\Core\DataProvider\DenormalizedIdentifiersAwareItemDataProviderInterface;
use ApiPlatform\Core\DataProvider\RestrictedDataProviderInterface;
use ApiPlatform\Core\Exception\RuntimeException;
use ApiPlatform\Core\Identifier\IdentifierConverterInterface;
use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
use Doctrine\Common\Persistence\ManagerRegistry;
use Doctrine\Common\Persistence\Mapping\ClassMetadata;
use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\QueryBuilder;

/**
 * Item data provider for the Doctrine ORM.
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 * @author Samuel ROZE <samuel.roze@gmail.com>
 * @final
 */
class ItemDataProvider implements DenormalizedIdentifiersAwareItemDataProviderInterface, RestrictedDataProviderInterface
{
    use IdentifierManagerTrait;

    private $managerRegistry;
    private $itemExtensions;

    /**
     * @param QueryItemExtensionInterface[] $itemExtensions
     */
    public function __construct(ManagerRegistry $managerRegistry, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, /* iterable */ $itemExtensions = [])
    {
        $this->managerRegistry = $managerRegistry;
        $this->propertyNameCollectionFactory = $propertyNameCollectionFactory;
        $this->propertyMetadataFactory = $propertyMetadataFactory;
        $this->itemExtensions = $itemExtensions;
    }

    public function supports(string $resourceClass, string $operationName = null, array $context = []): bool
    {
        return null !== $this->managerRegistry->getManagerForClass($resourceClass);
    }

[teohhanhui]

Could you show your Doctrine ORM mapping? Since I don't see it as annotations, I'm guessing you're using XML or YAML.

[abengtson]

I dont have any mappings, I am running Sql queries. This api needs to hit quite a few different places so no one entity maps to a single DB.

[teohhanhui]

Then indeed you need custom data persister and data provider. There's no magic! 😝

[abengtson]

I am really just using the Entity for validation and the api endpoints. Okay cool